Simulate a Payout

About this guide

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

1. Simulate a payout using the /ws/payout/simulate end-point

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

   The following fields are required:

   Field	Description
   country	Target country of the payout
   amount	Amount you wish to simulate
   currency_code	Currency code of the payout you wish to simulate
   external_reference	The unique payout ID provided by you.

   The following example is a payout simulation to a brazilian Payee in US Dollars:

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

   -d 'integration_key=your_test_integration_key' \

   -d 'country=br' \

   -d 'amount=10' \

   -d 'currency_code=USD' \

   -d 'external_reference=YOUR_EXTERNAL_REFERENCE'

   And a successful simulation will return a JSON Object with type "success" and a payout object with the details of the simulated Payout.

   {

   "type": "success",

   "payout": {

   "request_amount": 10,

   "request_currency": "USD",

   "request_exchange_rate": 1,

   "local_tax_amount": 0.12,

   "local_amount_total": 32.88,

   "local_currency": "BRL",

   "local_exchange_rate": 3.2997,

   "debit_amount": 10,

   "debit_fee": 0.15,

   "debit_amount_total": 10.15,

   "debit_currency": "USD",

   "fixed_fee_amount": 0,

   "percentual_fee_amount": 0.15

   }

   }

Simulate a Payout via Dashboard

When you are creating a Payout via Dashboard, you can view the total amount and fees, prior to the creation of the payout, at the bottom of the Create Payout screen.

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.