Consult a Transfer

This guide quickly demonstrates how to consult your transfers in EBANX. We will walk you through the basic steps to achieve this goal using your already existing Direct API integration.

Instructions

Follow the steps below:

Consulting a Single Transfer

Consult a payout using the /ws/transfer/retrieve end-point

To consult a single Transfer, you will use the /ws/transfer/retrieve endpoint.

There are 4 options you can use to consult single a PaTransferyout, the EBANX unique identifier (uid), which is generated during the creation of the payout, the unique identifier provided by the Merchant (external_reference), the transfer code from the Wire Transfer method (transfer_code) or the Settlement Code from Payment Balance method (settlement_code).

Here are a few of examples using each parameter:

uid
external_reference
transfer_code
settlement_code

curl -X POST 'https://sandbox.ebanxpay.com/ws/transfer/retrieve' \
    -d 'integration_key=your_test_integration_key' \
    -d 'uid=11ce3097af9ccf601b11038767962d3feded348ed'

curl -X POST 'https://sandbox.ebanxpay.com/ws/transfer/retrieve' \
    -d 'integration_key=your_test_integration_key' \
    -d 'external_reference=PAYOUT_TRANSFER_02'

curl -X POST 'https://sandbox.ebanxpay.com/ws/transfer/retrieve' \
    -d 'integration_key=your_test_integration_key' \
    -d 'transfer_code=14-2000'

curl -X POST 'https://sandbox.ebanxpay.com/ws/transfer/retrieve' \
    -d 'integration_key=your_test_integration_key' \
    -d 'settlement_code=14-2001'

And a successful retrieve will return a JSON Object with type "success" and a transfer object with all the details of the Transfer you are consulting.

{
  "type": "success",
  "transfer": {
    "uid": "11ce3097af9ccf601b11038123962d3feded348ed",
    "external_reference": "PAYOUT_TRANSFER_02",
    "status": "OP",
    "request_date": "2017-02-08 17:33:56",
    "confirm_date": null,
    "cancel_date": null,
    "amount": "150.00",
    "settlement_code": "14-2001",
    "source": "payment_balance"
  }
}

Consulting Multiple Transfers

Consult multiple payouts using the /ws/transfer/search end-point

You can also consult multiple Transfers by using the /ws/transfer/search endpoint.

Searching for multiple transfers will require a date range for the search. You can filter your search by the status of the Transfers. You can also control how many Payouts you want per page (up to 50 records), and which page the API should return.

Here are a few examples:

Setting the Date Range
Filtering by Status
Setting Page Preferences

curl -X POST 'https://sandbox.ebanxpay.com/ws/transfer/search' \
    -d 'integration_key=your_test_integration_key' \
    -d 'date_from=2017-02-07' \
    -d 'date_to=2017-02-08'

curl -X POST 'https://sandbox.ebanxpay.com/ws/transfer/search' \
    -d 'integration_key=your_test_integration_key' \
    -d 'date_from=2017-02-07' \
    -d 'date_to=2017-02-08' \
    -d 'status=CO'

curl -X POST 'https://sandbox.ebanxpay.com/ws/transfer/search' \
    -d 'integration_key=your_test_integration_key' \
    -d 'date_from=2017-02-07' \
    -d 'date_to=2017-02-08' \
    -d 'per_page=1' \
    -d 'page=2'

Setting the Date Range
Filtering by Status
Setting Page Preferences

{
  "type": "success",
  "records": "2",
  "total_pages": 1,
  "per_page": 50,
  "page": 1,
  "transfers": [
    {
      "uid": "11ce3097af9ccf601b11038767962d3feded348ed",
      "external_reference": "PAYOUT_TRANSFER_01",
      "status": "OP",
      "request_date": "2017-02-08 17:33:56",
      "confirm_date": null,
      "cancel_date": null,
      "amount": "100.00",
      "transfer_code": "14-2000",
      "source": "wire_transfer"
    },
    {
      "uid": "11ce3097af9ccf601b11038123962d3feded348ed",
      "external_reference": "PAYOUT_TRANSFER_02",
      "status": "OP",
      "request_date": "2017-02-08 17:33:56",
      "confirm_date": null,
      "cancel_date": null,
      "amount": "150.00",
      "settlement_code": null,
      "source": "payment_balance"
    }
  ]
}

{
  "type": "success",
  "records": "1",
  "total_pages": 1,
  "per_page": 50,
  "page": 1,
  "transfers": [
    {
      "uid": "11ce3097af9ccf601b11038767962d3feded348ed",
      "external_reference": "PAYOUT_TRANSFER_03",
      "status": "CO",
      "request_date": "2017-02-08 17:33:56",
      "confirm_date": "2017-02-08 17:55:56",
      "cancel_date": null,
      "amount": "150.00",
      "transfer_code": "14-2000",
      "source": "wire_transfer"
    }
  ]
}

{
  "type": "success",
  "records": "2",
  "total_pages": 2,
  "per_page": "1",
  "page": "2",
  "transfers": [
    {
      "uid": "1474d4f6c946df3449224ea6b61ae00ae6a56928a",
      "external_reference": "PAYOUT_TRANSFER_04",
      "status": "OP",
      "request_date": "2017-02-08 19:34:20",
      "confirm_date": null,
      "cancel_date": null,
      "amount": "250.00",
      "transfer_code": "14-2001",
      "source": "wire_transfer"
    }
  ]
}