This page's content:

Endpoints

https://api.ebanxpay.com/ws/payout/retrieve

https://sandbox.ebanxpay.com/ws/payout/retrieve

HTTP Method

POST

Response

JSON

This method allows you to retrieve a payout information.

Request parameters

integration_key string, length 100, required

Your unique and secret integration key.

external_reference string, length 6-40, optional*

The unique payout ID provided by you.

uid string, 50 length, optional*

The payout uid (EBANX unique identifier).

* You have to send either the external_reference or the uid

This method call will return a JSON object with the payout data.

Response parameters

type string

The type of the response (success, api_error, authentication_error, invalid_request_error, or request_error).

payout JSON

A JSON object that represents the payout.

payout.uid string, 50 length, unique

The payout uid (EBANX unique identifier).

payout.external_reference string, length 6-40

The unique payout ID provided by you.

payout.status string, length 2

The payout status. The following statuses are available:

  • OP: the payout is waiting to start the payment process. It can change either to CA or to PE.
  • PE: the payout is in payment process.
  • PA: the payout is paid.
  • CA: the payout is canceled.
payout.request_date string, length 19, UTC Date

The date and hour of when the payout was requested.

payout.status_date string, length 19, UTC Date

The date and hour of the last status change.

payout.paid_date string, length 19, UTC Date

The date and hour of when the payout was paid.

payout.cancel_date string, length 19, UTC Date

The date and hour of when the payout was cancelled.

payout.payee JSON

JSON with Payee information.

payout.payee.name string, length 3-100

Payee full name.

payout.payee.email string, length 10-100

Payee email address.

payout.payee.phone string, length 10-15

Payee phone number.

payout.payee.birthdate string, length 10

Payee birthdate in the format yyyy-mm-dd.

payout.payee.document string, length 32

Payee national identification number.

payout.payee.document_type string, length 5

Payee national identification number type.

payout.payee.bank_info JSON

JSON with Payee bank account information.

payout.payee.bank_info.bank_name string

Bank name.

payout.payee.bank_info.bank_branch string

Bank branch number.

payout.payee.bank_info.bank_account string

Bank account number.

payout.payee.bank_info.account_type chat, length 1

Bank account type.

payout.payee.bank_info.bank_details string

Additional information of bank account.

payout.request_amount float

The amount in the original request currency.

payout.request_currency string, length 3, ISO 4217 three letter code

Three-letter code of the original request currency.

payout.request_exchange_rate float

The exchange rate used in the payout to calculate the debited amount.

payout.debit_amount float

The amount debited to your account referring this payout.

payout.debit_fee float

The fee amount of the payout.

payout.debit_amount_total float

The total amount debited to your account referring this payout and fee.

payout.debit_currency string, length 3, ISO 4217 three letter code

Three-letter code for the debit amount currency.

payout.target string

Payout target. E.g., bank_account or ebanx_wallet