Pay Out - Query Transactions

Developing

Develop Env

https://merchant-api.stg.paypaga.com

GET

/query/payouts

Use this endpoint to query payout transactions data for custom reports or reconciliation purposes.

When using date criteria, the maximum allowable duration is 2 months.

Error codes for Query Pay Out Transactions

Error code	Description
300	Dates are out of range (more than 60 days)
301	One or both dates are in incorrect format
302	Input parameter combination is invalid
303	Status is invalid
500	Unexpected error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://merchant-api.stg.paypaga.com/query/payouts?merchant_id=06afffd4-8334-4f09-99e3-99046e28737d&start_date=2023-01-01&end_date=2023-02-28&transaction_id=20231213-1528-26e0-bcf4-7ff28236d3b7&merchant_transaction_reference=XXXXXX&status=ALL' \
--header 'Authorization;'

Response Example

200 - Success

{
  "rows": [
    {
      "transaction_id": "20240719-2102-4179-8f20-25fce854cc85",
      "transaction_timestamp": "2024-07-19 21:02:56",
      "merchant_id": "06afffd4-8334-4f09-99e3-99046e28737d",
      "merchant_name": "Demo Merchant",
      "payment_method_code": "BNKTR",
      "beneficiary_name": "Juan Doe",
      "transaction_total": 2.52,
      "currency": "MXN",
      "status": "Approved",
      "fee": 2.51,
      "calculated_taxes": 1,
      "merchant_transaction_reference": "abc4561691646778370",
      "lifecycle": [
        {
          "status": "Initiated",
          "timestamp": "2024-07-19 21:02:56.000"
        },
        {
          "status": "Approved",
          "timestamp": "2024-07-19 21:05:05.000"
        }
      ]
    }
  ],
  "version": "0.1"
}

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🔴500Server Error

Pay Out - Direct API Integration

Pay Out - Payment Processing