Endpoints

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

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

HTTP Method

POST

Response

JSON

This method allows you to retrieve a transfer information.

Request parameters

integration_key

string, length 100, required

Your unique and secret integration key.

external_reference

string, length 6-40, optional*

The transfer external reference.

transfer_code

string, length 6-40, optional*

The transfer unique reference code.

settlement_code

string, length 6-40, optional*

The transfer settlement code.

uid

string, 50 length, optional*

The transfer uid (EBANX unique identifier).

* You have to send either the transfer_code, uid, settlement_code or external_reference.

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

Response parameters

type

string

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

transfer

JSON

A JSON object that represents the transfer.

transfer.uid

string, 50 length, unique

The transfer uid (EBANX unique identifier).

transfer.external_reference

string, unique

The transfers unique ID provided by you.

transfer.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.

transfer.request_date

string, length 19, UTC Date

The date and hour of when the transfer was requested.

transfer.confirm_date

string, length 19, UTC Date

The date and hour of when the transfer was confirmed.

transfer.cancel_date

string, length 19, UTC Date

The date and hour of when the transfer was canceled.

transfer.amount

float

The transfer amount.

transfer.transfer_code

string

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

transfer.settlement_code

string

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

transfer.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.