Endpoints

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

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

HTTP Method

POST

Response

JSON

This method allows you to retrieve multiple transfers 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 transfer status. The following statuses are available:

  • OP: the transfer is waiting for payment.
  • CO: the transfer is confirmed.
  • CA: the transfer is canceled.

per_page

integer, optional

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

This method call will return a JSON object with a transfer 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

transfers

JSON

A JSON object with a transfer collection.

transfers.[].uid

string, 50 length, unique

The transfer uid (EBANX unique identifier).

transfers.[].external_reference

string, unique

The transfer external reference.

transfers.[].status

string, length 2

The transfer status. The following statuses are available:

  • OP: the transfer is waiting for payment. It can change either to CA or to CO.
  • CO: the transfer is confirmed.
  • CA: the transfer is canceled.

transfers.[].request_date

string, length 19, UTC Date

The date and hour of when the transfer was requested.

transfers.[].confirm_date

string, length 19, UTC Date

The date and hour of when the transfer was confirmed.

transfers.[].cancel_date

string, length 19, UTC Date

The date and hour of when the transfer was canceled.

transfers.[].amount

float

The transfer amount.

transfers.[].transfer_code

string

The unique identifier to be used during the bank transfer. Only for Wire transfers

transfers.[].settlement_code

string

The settlement were the transfer was debited. Only for transfers using Payment Balance

transfers.[].source

string

The transfer source. The following sources are available:

  • payment_balance: transfer using your payment balance.
  • wire_transfer: transfer with wire transfer to EBANX bank account.