Skip to main content

Refund Report

Refunds​

The Transactional Refund Report provides a detailed record of individual refund transactions processed through the EBANX platform. This report is used for refund reconciliation, customer support queries, and operational monitoring. Each refund is shown as a separate line item with complete information about both the refund itself and its associated payment transaction.

Refund Report Sample

FieldFormatDescriptionExampleEdge Cases
REFUND_IDInteger (numeric string without formatting)Unique numeric identifier for the refund transaction7412563211, 3001Always populated and unique; never null; used as primary identifier
CODEString (merchant-defined, optional)Merchant-provided unique identifier for the refund transactionREF-2023-001, REF-002Can be null if merchant doesn't provide it; not enforced as unique
REQUESTED_DATEDateTime string (YYYY-MM-DD HH:MM:SS)Date and time when the refund was initially requested2023-10-24 10:30:15Never null; always populated at refund creation; timezone may vary
CONFIRMED_DATEDateTime string (YYYY-MM-DD HH:MM:SS)Date and time when the refund was confirmed and processed2023-10-24 14:22:30Empty for non-confirmed refunds; may be backdated for manual confirmations
CANCELEDDateTime string (YYYY-MM-DD HH:MM:SS) or emptyDate and time when the refund was canceled2023-10-25 11:00:00Empty for non-canceled refunds; mutually exclusive with CONFIRMED_DATE
STATUSString enumeration (CO, CA, PE, OP)Current status of the refund transactionCO (Confirmed), CA (Canceled)Always populated; reflects current refund state; follows strict state machine rules
DESCRIPTIONString (line breaks and special characters cleaned for CSV)Text description or reason for the refundCustomer requested refundCan be empty; special characters removed for CSV compatibility
REFUND_CURRENCY3-letter ISO 4217 currency codeCurrency code for the refund amountUSD, BRL, EURAlways populated; matches original payment currency in most cases
REFUND_AMOUNTDecimal number with 2 decimal placesThe monetary amount being refunded in external currency150.75, 50.00No decimal places for zero-decimal currencies (COP); may be partial refund
PAYMENT_CODEString (merchant-defined)Merchant-provided unique identifier for the original paymentINV-2023-001Can be null if merchant didn't provide it for the payment
ORDER_NUMBERString (optional, non-unique)Order reference number for the original paymentORDER-12345Can be null; multiple refunds can share same order_number
HASHHexadecimal string (48 characters)Unique EBANX payment hash identifier for the original payment54154bb...44a4acAlways populated; multiple refunds can share same hash for partial refunds
CUSTOMER_NAMEString (UTF-8 encoded, variable length)Full name of the customer who made the original paymentMaria Silva Santos, **********May be masked with asterisks if data masking is enabled
CUSTOMER_DOCUMENTString (document format varies by country)Customer's government-issued document number (CPF, CNPJ, etc.)***.444.***-** (BR CPF, masked)Format varies by country (CPF, CNPJ, DNI, RUT, etc.); may be masked for privacy
PMT CONFIRM DATEDateTime string (YYYY-MM-DD HH:MM:SS)Confirmation date of the original payment2024-09-15 14:45:30Refunding unconfirmed payments, date changes, processing rule violations
PMT TYPEString (enum, 20 chars)Payment method used in the original transactioncreditcardPayment type changes, deprecated types, refund method restrictions
PMT CURRENCY3-letter ISO 4217 currency codeExternal/original currency code of the payment amountUSD, EUR, BRL, GBPMay differ from CURRENCY_LOCAL for cross-border transactions; determines AMOUNT field currency
AMOUNT ORDERDecimal number with 2 decimal places (or 0 for zero-decimal currencies)Payment amount in external/original currency (gross amount before fees)12.34, 150.75, 1000 (for COP)For zero-decimal currencies (CLP, COP, JPY), no decimal places; rounding may occur during currency conversion
PMT LOCAL CURRENCY3-letter ISO 4217 currency codeLocal currency code of the payment's processing countryBRL, MXN, ARS, COP, CLPCan be null for some payment types; matches country's primary currency
AMOUNT LOCALDecimal (12,4)Amount of the original payment in its local currency (PMT LOCAL CURRENCY)250.0000Zero amounts, negative amounts, extremely large amounts, precision loss in conversions
PAID DATEDateTime string (YYYY-MM-DD HH:MM:SS) or emptyDate and time when the refunded amount was effectively paid back to the customer, which happens after the refund is confirmed2023-10-26 09:15:00Empty for refunds that are still pending, canceled, or awaiting the return remittance; always later than or equal to CONFIRMED_DATE

Example Refund Calculation​

Scenario: Brazilian cross-border merchant processing partial refund with full fee structure

Base Transaction Data​

Refund Date: October 25, 2024
Merchant: EBANX Demo Merchant
Original Payment: Credit Card (Visa) - USD 100.00
Refund Amount: USD 50.00 (partial refund)
Customer: Maria Silva Santos
Country: Brazil (BR)
Refund ID: 7412563211

Original Payment Context​

Payment Hash: 54154bb33b47474eb64ef36193644cce4e4c44c4e444a4ac
Payment Code: INV-2024-001
Payment Confirmed: October 24, 2024 14:22:30
Payment Amount: USD 100.00
Payment Amount Local: BRL 543.10

Refund Transaction Amounts​

Refund Amount (amount_ext): USD 50.00
Refund Currency: USD
Local Currency: BRL
Exchange Rate: 5.4310
Refund Amount Local: BRL 271.55 (50.00 × 5.4310)

Refund Cost Calculation​

Set Cost (amount to be deducted from merchant): BRL 271.55

This represents the gross amount being refunded to the customer

Refund Fee Calculations​

Fee Breakdown:
Base Refund Fee: BRL 2.00 (fixed fee per refund)

Fee Application Logic:
Only applied to first refund per payment
If this is the second refund for the same payment, fee = BRL 0.00
Credit Card Deposit Fee (if applicable):
Applied when refund occurs after cancellation window (90 days)
In this case: Not applicable (refund within 90 days)
Total Refund Fee: BRL 2.00

Additional Fees (Colombia-specific, if applicable)​

For Colombian merchants, additional fees may apply:

Retefuente Merchant Fee: BRL 2.00 × 2.5% = BRL 0.05 (if applicable)
ReteICA Fee: BRL 2.00 × 0.966% = BRL 0.02 (if applicable)
IVA Fee: BRL 2.00 × 19% = BRL 0.38 (if applicable)
ReteIVA Fee: BRL 0.38 × 15% = BRL 0.06 (if applicable)
Note: For Brazilian merchants in this example, these fees do not apply.

Return MDR (Merchant Discount Rate)​

Return MDR: BRL 0.50 (calculated based on merchant configuration)

Need help?

Help Image