transfer search operation
This page's content:
Endpoints
https://api.ebanxpay.com/ws/transfer/search
https://sandbox.ebanxpay.com/ws/transfer/search
HTTP Method
POST
Response
JSON
This method allows you to retrieve multiple transfers information.
Request parameters
Your unique and secret integration key.
Initial date in the format yyyy-mm-dd. E.g., 1977-05-25
End date in the format yyyy-mm-dd. E.g., 1977-05-26
The page number of the current search.
The transfer status. The following conditions are available:
- OP: the transfer is waiting for payment.
- CO: the transfer is confirmed.
- CA: the transfer is canceled.
Max number of transfers per page (API Max: 50)
This method call will return a JSON object with a transfer collection.
Response parameters
The type of the response (success, api_error, authentication_error, invalid_request_error, or request_error).
Total number of records.
Total number of pages.
Number of register per page.
Number of the currenct page.
A JSON object with a transfer collection.
The transfer uid (EBANX unique identifier).
The external transfer reference.
The transfer status. The following conditions 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.
The date and hour of when the transfer was requested.
The date and hour of when the transfer was confirmed.
The date and hour of when the transfer was cancelled.
The transfer amount.
The unique identifier to be used during the bank transfer. Only for Wire transfers
The settlement when the transfer was debited. Only for transfers using Payment Balance
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.
