Version: current

Consult a Payout

About this guide

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

How it works

You have the option of consulting a single payout or multiple. Check the steps below for more details.

Consulting a Single Payout

  1. Consult a payout using the /ws/payout/retrieve end-point

    To consult a single Payout, you will use the /ws/payout/retrieve endpoint.

    There are two options you can use to consult single a Payout, the EBANX unique identifier (uid), which is generated during the creation of the payout (see Create a Payout), or the unique identifier provided by the Merchant (external_reference).

    Here are a couple of examples using each parameter:

    curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/retrieve' \
    -d 'integration_key=your_test_integration_key' \
    -d 'uid=0f28f5b2bf60536d78b2dbf003c13886dd452d926'

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

    {
    "type": "success",
    "payout": {
    "uid": "0f28f5b2bf60536d78b2dbf003c13886dd452d926",
    "external_reference": "PAYOUT_EBANX_01",
    "status": "PA",
    "request_date": "2017-02-07 17:01:59",
    "status_date": "2017-02-07 17:03:15",
    "paid_date": "2017-02-07 17:03:15",
    "cancel_date": null,
    "payee": {
    "name": "Han Solo",
    "email": "chew@bac.ca",
    "phone": " 554112345678",
    "document": "08271284959",
    "document_type": "CPF",
    "birthdate": "1977-05-25",
    "bank_info": null
    },
    "request_amount": "10.00",
    "request_currency": "USD",
    "request_exchange_rate": "1.0000",
    "debit_amount": "10.00",
    "debit_fee": "0.15",
    "debit_amount_total": "10.15",
    "debit_currency": "USD",
    "target": "ebanx_wallet"
    }
    }

Consulting Multiple Payouts

  1. Consult multiple payouts using the /ws/payout/search end-point

    You can also consult multiple Payouts by using the /ws/payout/search endpoint.

    Searching for multiple Payouts will require a date range for the search. You can filter your search by the status of the Payout. 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:

    curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/search' \
    -d 'integration_key=your_test_integration_key' \
    -d 'date_from=2017-02-07' \
    -d 'date_to=2017-02-08'
    {
    "type": "success",
    "records": "5",
    "total_pages": 1,
    "per_page": 50,
    "page": 1,
    "payouts": [
    {
    "uid": "0f28f5b2bf60536d78b2dbf003c13886dd452d926",
    "external_reference": "PAYOUT_EBANX_01",
    "status": "PA",
    "request_date": "2017-02-07 17:01:59",
    "status_date": "2017-02-07 17:03:15",
    "paid_date": "2017-02-07 17:03:15",
    "cancel_date": null,
    "payee": {
    "name": "Han Solo",
    "email": "chew@bac.ca",
    "phone": " 554112345678",
    "document": "85351346893",
    "document_type": "CPF",
    "birthdate": "1977-05-25",
    "bank_info": null
    },
    "request_amount": "10.00",
    "request_currency": "USD",
    "request_exchange_rate": "1.0000",
    "debit_amount": "10.00",
    "debit_fee": "0.15",
    "debit_amount_total": "10.15",
    "debit_currency": "USD",
    "target": "ebanx_wallet"
    },
    {
    "uid": "07af7cd0fd2f64a4953cc707bf09811ddf83ec090",
    "external_reference": "PAYOUT_EBANX_02",
    "status": "PE",
    "request_date": "2017-02-07 17:11:43",
    "status_date": "2017-02-07 17:12:46",
    "paid_date": null,
    "cancel_date": null,
    "payee": {
    "name": "Han Solo",
    "email": "chew@bac.ca",
    "phone": " 554112345678",
    "document": "85351346893",
    "document_type": "CPF",
    "birthdate": "1977-05-25",
    "bank_info": null
    },
    "request_amount": "10.00",
    "request_currency": "USD",
    "request_exchange_rate": "1.0000",
    "debit_amount": "10.00",
    "debit_fee": "0.15",
    "debit_amount_total": "10.15",
    "debit_currency": "USD",
    "target": "bank_account"
    },
    {
    "uid": "0bf887fdadeef424a857c2bff69b94db0fb77f071",
    "external_reference": "PAYOUT_EBANX_03",
    "status": "PE",
    "request_date": "2017-02-07 19:45:38",
    "status_date": "2017-02-07 19:46:38",
    "paid_date": null,
    "cancel_date": null,
    "payee": {
    "name": "Han Solo",
    "email": "chew@bac.ca",
    "phone": " 554112345678",
    "document": "85351346893",
    "document_type": "CPF",
    "birthdate": "1977-05-25",
    "bank_info": {
    "bank_name": "341 Itaú",
    "bank_branch": "3707",
    "bank_account": "01854-9",
    "account_type": "C",
    "bank_details": null
    }
    },
    "request_amount": "10.00",
    "request_currency": "USD",
    "request_exchange_rate": "1.0000",
    "debit_amount": "10.00",
    "debit_fee": "0.15",
    "debit_amount_total": "10.15",
    "debit_currency": "USD",
    "target": "bank_account"
    },
    {
    "uid": "0e495f7a4409c032d54376084b10b9c771e9b39f0",
    "external_reference": "PAYOUT_EBANX_04",
    "status": "PE",
    "request_date": "2017-02-07 20:00:15",
    "status_date": "2017-02-07 20:01:15",
    "paid_date": null,
    "cancel_date": null,
    "payee": {
    "name": "Han Solo",
    "email": "chew@bac.ca",
    "phone": " 554112345678",
    "document": "85351346893",
    "document_type": "CPF",
    "birthdate": "1977-05-25",
    "bank_info": {
    "bank_name": "104 Caixa Econômica",
    "bank_branch": "3708",
    "bank_account": "08251777-6",
    "account_type": "C",
    "bank_details": "001"
    }
    },
    "request_amount": "10.00",
    "request_currency": "USD",
    "request_exchange_rate": "1.0000",
    "debit_amount": "10.00",
    "debit_fee": "0.15",
    "debit_amount_total": "10.15",
    "debit_currency": "USD",
    "target": "bank_account"
    },
    {
    "uid": "088d8930148d84205a82efddb53f9a6c003a122c1",
    "external_reference": "PAYOUT_EBANX_05",
    "status": "PA",
    "request_date": "2017-02-07 20:31:44",
    "status_date": "2017-02-07 20:32:52",
    "paid_date": "2017-02-07 20:32:52",
    "cancel_date": null,
    "payee": {
    "name": "Han Solo",
    "email": "chew@bac.ca",
    "phone": " 554112345678",
    "document": null,
    "document_type": null,
    "birthdate": "1977-05-25",
    "bank_info": null
    },
    "request_amount": "10.00",
    "request_currency": "USD",
    "request_exchange_rate": "1.0000",
    "debit_amount": "10.00",
    "debit_fee": "0.30",
    "debit_amount_total": "10.30",
    "debit_currency": "USD",
    "target": "ebanx_wallet"
    }
    ]
    }

Consulting a Payout via Dashboard

You can also consult your payouts through your Dashboard in the Payouts section of the Payout tab.

Getting help

We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:

  • If you’re not our partner yet and would like to know more about our prices and conditions please fill ou this form and our comercial team will get in touch with you.
  • In case you’re already our partner please get in touch with our support team at integration@ebanx.com.
Last updated on by Fernando Pankiewicz Gomes