Skip to main content

Transfer Report

Transfer

This feature allows merchants to track all settlements that have been transferred to their bank account through the merchant area interface. Each settlement entry includes a link to download the invoice and access detailed settlement reports, ensuring merchants can verify that all settled amounts have been properly transferred to their bank accounts according to the configured transfer dates.

Transfer Report Sample

FieldFormatDescriptionExampleEdge Cases
merchant_nameString (UTF-8 encoded)Name of the merchant receiving the settlement transfer.EBANX Demo MerchantSpecial characters may be HTML encoded; a group name may be used.
settlement_codeString (alphanumeric, e.g., SET-{country}-{YYMMDD}-{seq})Human-readable unique identifier for the settlement invoice.SET-BR-240915-001Format varies by merchant configuration; some use numeric codes.
settlement_countryString (full country name)Country name where the settlement was processed.Brasil, Mexico, ArgentinaThe name may be displayed in different languages depending on locale.
settlement_currency3-letter ISO 4217 currency codeCurrency code for the settlement transfer amount.USD, EUR, BRL, MXNMay differ from local currency for cross-border settlements.
settlement_net_amountDecimal number with 2 decimal placesFinal net amount transferred to merchant's bank account.118,750.50, 1000.00Can be negative if the merchant owes EBANX.
transfer_dateDate string (DD/MM/YYYY format)Date when the settlement was transferred to the merchant's bank account.15/09/2024Can differ from settlement date; used for bank reconciliation.

Example Transfer Report Entries

Scenario: Brazilian merchant with multiple settlements transferred to bank account across different periods

Transfer 1 (Domestic BRL Settlement)

Merchant Name: EBANX Demo Merchant
Settlement Code: SET-BR-240915-001
Settlement Country: Brasil
Settlement Currency: BRL
Settlement Net Amount: 118,750.50
Transfer Date: 15/09/2024

Transfer 2 (Cross-border EUR Settlement)

Merchant Name: EBANX Demo Merchant
Settlement Code: SET-BR-240920-001
Settlement Country: Brasil
Settlement Currency: EUR
Settlement Net Amount: 1,000.00
Transfer Date: 20/09/2024

Transfer 3 (Mexican MXN Settlement)

Merchant Name: EBANX Demo Merchant
Settlement Code: SET-MX-241001-001
Settlement Country: Mexico
Settlement Currency: MXN
Settlement Net Amount: 45,320.00
Transfer Date: 01/10/2024

note

Transfer 2 shows a cross-border settlement where the settlement currency (EUR) differs from the local currency (BRL). This occurs when the merchant has configured cross-border settlement in a foreign currency.

Still need help?

Help Image

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