Endpoints

https://api.ebanx.com/ws/payout/search

https://sandbox.ebanx.com/ws/payout/search

HTTP Method

POST

Response

JSON

This method allows you to retrieve multiple payouts information.

Request parameters

integration_key

string, length 100, required

Your unique and secret integration key.

date_from

string, length 10, required

Initial date in the format yyyy-mm-dd. E.g. 1977-05-25

date_to

string, length 10, required

End date in the format yyyy-mm-dd. E.g. 1977-05-26

page

integer, optional

The page number of the current search

status

string, length 2, optional

The payout status. The following statuses are available:

  • OP: the payout is waiting to start the payment process.
  • PE: the payout is in payment process.
  • PA: the payout is paid.
  • CA: the payout is cancelled.

per_page

integer, optional

Max number of payouts per page (API Max: 50)

This method call will return a JSON object with a payout collection.

Response parameters

type

string

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

records

integer

Total number of records

total_pages

integer

Total number of pages

per_page

integer

Number of register per page

page

integer

Number of the currenct page

payouts

JSON

A JSON object with a payout collection.

payouts.[].uid

string, length 50, unique

The payout uid (EBANX unique identifier).

payouts.[].external_reference

string, length 6-40

The payout unique ID provided by you.

payouts.[].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.

payouts.[].request_date

string, length 19, UTC Date

The date and hour of when the payout was requested.

payouts.[].status_date

string, length 19, UTC Date

The date and hour of the last status change.

payouts.[].paid_date

string, length 19, UTC Date

The date and hour of when the payout was paid.

payouts.[].cancel_date

string, length 19, UTC Date

The date and hour of when the payout was canceled.

payouts.[].payee

JSON

JSON with Payee information.

payouts.[].payee.name

string, length 3-100

Payee full name.

payouts.[].payee.email

string, length 10-100

Payee email address.

payouts.[].payee.phone

string, length 10-15

Payee phone number.

payouts.[].payee.birthdate

string, length 10

Payee birthdate in the format yyyy-mm-dd.

payouts.[].payee.document

string, length 32

Payee national identification number.

payouts.[].payee.document_type

string, length 5

Payee national identification number type.

payouts.[].payee.bank_info

JSON

JSON with Payee bank account information.

payouts.[].payee.bank_info.bank_name

string

Bank name.

payouts.[].payee.bank_info.bank_branch

string

Bank branch number.

payouts.[].payee.bank_info.bank_account

string

Bank account number.

payouts.[].payee.bank_info.account_type

chat, length 1

Bank account type.

payouts.[].payee.bank_info.bank_details

string

Additional information of bank account.

payouts.[].request_amount

float

The amount in the original request currency.

payouts.[].request_currency

string, length 3, ISO 4217 three letter code

Three-letter code of the original request currency.

payouts.[].request_exchange_rate

float

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

payouts.[].debit_amount

float

The amount debited in your account referring this payout.

payouts.[].debit_fee

float

The fee amount of the payout.

payouts.[].debit_amount_total

float

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

payouts.[].debit_currency

string, length 3, ISO 4217 three letter code

Three-letter code of the debit amount currency.

payouts.[].target

string

Payout target. E.g. bank_account or ebanx_account