Create a Payout

About this guide

This guide quickly demonstrates how to create 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

To create a payout through EBANX Direct API, please follow the steps below.

1. Make sure you have all the mandatory fields in your request

   There are a few key parameters you need to provide to create a payout. Check the table below for more details.

   Field	Description
   integration_key	Your unique and secret integration key.
   external_reference	The unique payout ID provided by you.
   country	The two-letter country code for the customer country. In this case, we'll show the method to eg (Egypt)
   amount	The amount in the specified currency (currency_code).
   currency_code	Three-letter code of the payout currency. In this case, we'll use EGP (Egypt)
   payee	A JSON object containing the details of the payee of your request (bank_name and bank_account is mandatory on bank_info).

   Payee Details

   Note that you can either provide all the information of the payee directly on you payout creation request or create the payee record in advance, using the /ws/payee/create endpoint, and simply provide the payee's document number in the payout request.

   Document Types Allowed:

   These types of documents are used by the payees or shareholders.

   Document type	Description
   TIN	For B2C, the Egyptian Tax Registration Number is 9 digits in length, formatted into three groups of three digits.
   VAT	For B2B transaction, you need to send this document type. VAT number is 9 digits in length, formatted into three groups of three digits.

2. Send your payout request to EBANX

   To create a new Payout, you will use the /ws/payout/create endpoint.

   There are two ways to create a payout for Egypt.

   1 - Bank Account

   The target key is bank_account by default so, for bank account payouts, it can be ommitted.
   
   For bank account payouts, you need to send the bank_info tag with only the bank_details key filled up with the CBU/CVU number.
   
   The bank_name and bank_account key is mandatory. For the bank_name the API expects the bank abbreviation. You can check the banks available using this endpoint: /ws/payout/banks
   
   

   curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/create' \

   -d 'integration_key=your_test_integration_key' \

   -d 'external_reference=PAYOUT_EBANX_01' \

   -d 'country=eg' \

   -d 'amount=10' \

   -d 'currency_code=EGP' \

   -d 'payee[name]=Han Solo' \

   -d 'payee[email]=chew@bac.ca' \

   -d 'payee[phone]=+554112345678' \

   -d 'payee[document]=123-111-234' \

   -d 'payee[document_type]=TIN' \

   -d 'payee[bank_info][bank_name]=ADCB' \

   -d 'payee[bank_info][bank_account]=12345676543' \

   And a successful creation will return a JSON Object with type "success" and a payout object with all the details of the newly created Payout.

   {

   "type": "success",

   "payout": {

   "uid": "a1352f5341c3c8c1e40ea9c06715f05778ff35ee",

   "external_reference": "PAYOUT_EBANX_01",

   "status": "OP",

   "request_date": "2020-09-18 13:26:53",

   "status_date": null,

   "paid_date": null,

   "cancel_date": null,

   "payee": {

   "name": "Han Solo",

   "email": "chew@bac.ca",

   "phone": "554112345678",

   "document": "123111234",

   "document_type": "TIN",

   "bank_info": {

   "bank_name": "ADCB",

   "bank_branch": null,

   "bank_account": "12345676543",

   "account_type": null,

   "bank_details": null,

   "bank_document": null,

   }

   },

   "request_amount": "10.00",

   "request_currency": "EGP",

   "request_exchange_rate": "4.2000",

   "debit_amount": "2.38",

   "debit_fee": "0.02",

   "debit_amount_total": "2.40",

   "debit_currency": "USD",

   "local_tax_amount": "0.00",

   "local_amount_total": "10.00",

   "local_currency": "EGP",

   "local_exchange_rate": "1.0000",

   "target": "bank_account"

   }

   }

3. Send a commit request to EBANX

   Once the new Payout record is created it'll be committed automatically after 6 hours. Or you can use the /ws/payout/commit endpoint to start the payment process.

   Here's an example of a commit operation using the payout we've just created:

   curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/commit' \

   -d 'integration_key=your_test_integration_key' \

   -d 'uid=0e495f7a4409c032d54376084b10b9c771e9b39f0'

   Once the new Payout is commited, a JSON Object with type "success" will be returned.

   {

   "type": "success",

   "message": "Payout has already been committed"

   }

Creating a Payout using Dashboard

You can also create a payout through your Dashboard in the Overview section of the Payout tab. Click on Create Payout, fill in the payee information, payout amount and click Create. Additionally, you can create a Mass Payout for up to 600 payouts.

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 our this form and our commercial 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.