Skip to main content

Payout Status

GET https://api-sandbox.epag.io/payoutTransaction/TX_ID

After receiving a payout update callback, use this GET request to retrieve the most current status of the payout. Identify the payout using the txId.

Authorization​

HeaderValue
X-Auth-TokenMY_ACCESS_TOKEN

Request​

  • Path parameter:
    • txId (string): The unique identifier of the payout transaction.

Response​

  • tx_id (string): The unique identifier of the payout transaction.
  • reference_id (string): External code created by the merchant to reference this payout.
  • payout_date (string/date/YYYY-MM-DDTHH:mm:ss.SSSSSS): Payout creation date in UTC.
  • amount: (number): Amount in the payment currency.
  • beneficiary: (string): The beneficiary data.
  • status: (string): Payout status. Possible values: CREATED, PROCESSING, COMPLETED, ERROR.
  • asset: (string): The payment currency.
  • error_code: (string): The error code when status is ERROR.
  • error_details: (string): The error description when status is ERROR.

Beneficiary Format​

  • PIX: CPF, CNPJ, email, phone, or a UUID-based key.
  • SPEI: BANK_CODE:CLABE.
  • BANK_TRANSFER: BANK_CODE:ACCOUNT_TYPE:ACCOUNT_NUMBER.

Example Response​

{
    "tx_id": "a1abaf0c-3e79-443b-b5d0-c6e8ecab1958",
    "reference_id": "MY_REFERENCE_ID",
    "payout_date": "2025-05-14T16:59:33.131425",
    "amount": 200,
    "beneficiary": "40002:646180179900004269",
    "status": "PROCESSING",
    "asset": "MXN",
    "error_code": null,
    "error_details": null,
    "refresh_token": "MY_ACCESS_TOKEN"
}