Simulate a Payout

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.

Instructions

Follow the steps below:

1. Define your parameters

   To simulate a payout, 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

2. Sample Request

   Below is an example of a payout simulation request for a Brazilian payee in U.S. Dollars:

   Shell

   curl -X POST \
     --location 'https://sandbox.ebanxpay.com/ws/payout/simulate' \
     --header 'Content-Type: application/json' \
     --data '{
       "integration_key": "your_ebanx_integration_key",
       "country": "br",
       "amount": 10,
       "currency_code": "USD",
       "external_reference": "YOUR_EXTERNAL_REFERENCE"
   }'

3. Sample Response

   If the simulation is successful, the response will contain a JSON object with type "success" and a payout object containing calculated payout details:

   JSON

   {
     "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.

Still need help?

We hope this article was helpful. If you still have questions, you can explore the following options:

• Merchant support: Contact our support team at sales.engineering@ebanx.com for assistance.
• Not a partner yet? Please complete the Merchant Signup Form, and our commercial team will reach out to you.