Payouts Report
Payouts
The Transactional Payout Report provides a detailed record of individual payout transactions processed through the EBANX platform. This report is used for payout reconciliation, payee support queries, and operational monitoring. Each payout is shown as a separate line item with complete information about the payout transaction, fees, taxes, and payee details.
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| COUNTRY | 2-letter ISO country code (uppercase) | Two-letter country code where the payout was processed | BR, MX, AR, CO | Always populated; determines available payout methods and regulations |
| EXTERNAL_REFERENCE | String (alphanumeric, up to 40 characters) | Merchant-provided unique identifier for the payout transaction | PAYOUT_EBANX_01 | Can be null; not enforced as unique across merchants |
| AMOUNT | Decimal number with 2 decimal places | Payout amount in requested currency (gross amount before fees) | 100.00, 50000 (for COP) | No decimal places for zero-decimal currencies; represents debit amount |
| CURRENCY_LOCAL | 3-letter ISO 4217 currency code | Local currency code of the payout's processing country | BRL, MXN, ARS, COP | Always populated; matches country's primary currency |
| CURRENCY_EXCHANGE_RATE | Decimal number (typically 4 decimal places) | Currency conversion rate applied to convert amount to local currency | 5.0700, 1.0000 | Always 1.0 for domestic payouts; may vary based on spread configuration |
| AMOUNT_LOCAL | Decimal number with 2 decimal places | Payout amount converted to local currency | 1009.00, 50000.0 | No decimal places for zero-decimal currencies; excludes tax amount |
| FEE | Decimal number with 2 decimal places | Processing fee charged for the payout transaction | 0.31, 5.00 | May be 0.00 for reverted payouts based on settings; includes tax |
| TAX | Decimal number with 2 decimal places | Tax amount applied to the payout (e.g., IOF in Brazil) | 0.38, 5.00 | May be 0.00 for countries without payout taxes; can be paid by merchant or payee |
| PAID_IN | String (payment method code) | Payment method or target used for the payout | pix_key, Bank Account | Can be empty string; format varies by country and payout method |
| STATUS | String enumeration (PA, RE, CA) | Current status of the payout transaction | PA (Paid), RE (Reverted) | Status reflects balance operation type; reverted payouts show as RE |
| String (email format) | Payee's email address | chew@bac.ca | Can be null; no strict format validation | |
| NAME | String (UTF-8 encoded, variable length) | Full name of the payee receiving the payout | Han Solo, Stanley Kubrick | Special characters may require encoding; format varies by country |
| CPF | String (document format varies by country) | Payee's government-issued document number (CPF, CNPJ, etc.) | 01234567890 (BR CPF) | Can be empty string; format and validation rules vary by country |
| CREATED | DateTime (ISO 8601, UTC) | Date and time when the payout request was created in the EBANX system. | 2024-10-27T10:00:00Z | Always populated; represents initial payout request timestamp. |
| PAID | DateTime (ISO 8601, UTC) | Date and time when the payout was successfully completed | 2024-09-15T16:45:30Z | Paid date without validation, delayed payments |
| CANCEL DETAIL | String | Reason or description explaining why the payout was canceled. Populated when payout status is CANCELED. | Invalid bank account, Insufficient funds, Account closed, Beneficiary data mismatch | Null when payout is successful or pending; contains error description when canceled |
| IDEMPOTENCY KEY | String (alphanumeric) | Unique identifier provided by the merchant to prevent duplicate payout requests. Provided by merchant in the API request. | IDEM-001-2026, payout_12345_retry, unique-key-abc123 | Required field; used for deduplication and reconciliation with merchant systems |
Example Payout Calculation
Scenario: Brazilian merchant processing payout to supplier with comprehensive fee and tax structure
Base Transaction Data
Payout Date: October 27, 2024
Merchant (Payer): EBANX Demo Merchant
Payee: Han Solo
Country: Brazil (BR)
Payout UID: 980a8ed3f6aa6c6182d1c37b8c82bf27274e94e7
External Reference: PAYOUT_EBANX_01
Payout Request Details
Request Amount: BRL 100.00
Request Currency: BRL
Request Exchange Rate: 3.2320 (BRL to USD conversion)
Target Method: PIX Key
Target Account: your@email.com
Amount Calculations
Debit Amount (USD): USD 30.94 (100.00 ÷ 3.2320)
This represents the amount debited from the merchant's USD balance.
Fee Calculations
EBANX Fee: USD 0.31
This is the processing fee charged by EBANX for the payout transaction.
Total Debit from Balance: USD 31.25 (30.94 + 0.31)
Tax Calculations (Brazil-specific)
IOF Tax (Local): BRL 0.38 (0.38% of local amount for international transfers)
Local Amount After Tax: BRL 99.62 (100.00 - 0.38)
Exchange Rate Application
Local Currency: BRL
Local Exchange Rate: 1.0000 (no conversion needed for local payout)
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.