Payments Report
Payments
The Transactional Payment Report provides a detailed record of individual payment transactions processed through the EBANX platform. This report is used for transaction-level reconciliation, customer support queries, and operational monitoring. Unlike the Settlement Report which aggregates transactions, this report shows each payment as a separate line item with its complete lifecycle information.
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| REQUESTED_DATE | DateTime string (YYYY-MM-DD HH:MM:SS) | Timestamp when the payment transaction was initially created in the EBANX system. | 2023-10-24 10:30:15 | Never null; always populated at payment creation; timezone may vary based on merchant configuration |
| STATUS | String enumeration (PA, NP, RE, PE) | Dashboard-friendly payment status code mapped from internal API status for merchant visibility. Mapped from API status: CO→PA (Paid), CA→NP (Not Paid), OP→RE (Requested), PE→PE (Pending). | PA, NP, RE, PE | Throws InvalidArgumentException if status doesn't match known values; status transitions follow strict state machine rules |
| API_STATUS | String (CO, CA, OP, PE) | Raw internal payment status code used by EBANX API and backend systems. | CO (Confirmed), CA (Cancelled), OP (Open), PE (Pending) | Always populated; reflects current payment state; may differ from STATUS field representation |
| PAID | DateTime string (YYYY-MM-DD HH:MM:SS) or null | Timestamp when payment was confirmed and funds were successfully captured. | 2023-10-24 14:22:30 or null | Null for non-confirmed payments (OP, PE, CA statuses); timezone considerations apply; may be backdated for manual confirmations |
| PAYMENT_CODE | String (merchant-defined, typically alphanumeric) | Merchant-provided unique identifier for tracking payments in their internal systems. | INV-2023-001, ORDER-12345 | Can be null if merchant doesn't provide it; not enforced as unique by EBANX; duplicates possible across different merchants |
| ORDER_NUMBER | String (optional, non-unique) | Optional order reference number from merchant's e-commerce or order management system. | ORD-789456, CART-2023-10-24-001 | Can be null; multiple payments can share same order_number for split payments; not validated for format |
| AMOUNT | Decimal 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 |
| PAYMENT_TYPE | String (payment type code from system registry) | Payment method code identifying the specific payment instrument used. | creditcard, pix, boleto, oxxo | Can be null if payment type not assigned; new payment types added regularly; country-specific methods |
| CUSTOMER_NAME | String (UTF-8 encoded, variable length) | Full name of the customer who initiated the payment | John Doe, Maria Silva Santos | May be masked with asterisks if merchant has data masking enabled; special characters may require encoding |
| String (email format, not strictly validated) | Customer's email address for communication and identification | customer@example.com | Can be null; no strict format validation; may contain invalid emails; duplicates across different customers | |
| PAYERS_ID | String (document format varies by country) | Customer's government-issued document number (CPF, CNPJ, DNI, RUT, etc.) | 05444444927 (BR CPF) | May be masked if data masking enabled; format varies by country; validation rules differ per jurisdiction; can be null |
| HASH | Hexadecimal string (48 characters) | Unique EBANX-generated payment hash identifier serving as primary reference | 54154bb...44a4ac | Always populated and unique; never null; immutable after creation |
| INSTALMENT | Integer (positive, typically 1-24) | Number of instalments for the payment (1 for single payment) | 1, 3, 6, 12 | Always at least 1; maximum varies by country and payment method; instalment fees calculated separately |
| COUNTRY | 2-letter ISO 3166-1 alpha-2 country code | Country abbreviation where the payment was processed | BR, MX, AR, CO, CL, PE | Always populated; determines available payment methods and regulatory requirements |
| CURRENCY_LOCAL | 3-letter ISO 4217 currency code | Local currency code of the payment's processing country | BRL, MXN, ARS, COP, CLP | Can be null for some payment types; matches country's primary currency |
| CURRENCY | 3-letter ISO 4217 currency code | External/original currency code of the payment amount | USD, EUR, BRL, GBP | May differ from CURRENCY_LOCAL for cross-border transactions; determines AMOUNT field currency |
| EXCHANGE_RATE | Decimal number (typically 4-6 decimal places) | Currency conversion rate applied to convert AMOUNT to AMOUNT_LOCAL | 5.4310, 1.0000 | Missing FX rates for domestic payments (1.0); extreme rate fluctuations; rate provider outages |
| AMOUNT_LOCAL | Decimal number with 2 decimal places | Payment amount expressed in the local currency of the processing country: AMOUNT × EXCHANGE_RATE | 543.10 | Equals AMOUNT for local (domestic) payments; rounding differences on conversion; zero-decimal currencies show no decimals |
| DUE_DATE | Date string (YYYY-MM-DD) or empty | Deadline for the customer to complete the payment, applicable to voucher and bank-slip style methods | 2024-10-27 | Empty for instant methods (credit card, Pix); payments past the due date are canceled by expiration |
| CANCELED | DateTime string (YYYY-MM-DD HH:MM:SS) or empty | Timestamp when the payment was canceled, either by request or by expiration | 2024-10-28 03:00:00 | Empty for payments that were never canceled; mutually exclusive with PAID |
| PMT_GROUP | String (group code) | Group the payment method belongs to, used to classify methods with similar behavior | creditcard, debitcard, boleto, pix, cash, ewallet, banktransfer | Empty when the payment type has no group assigned; new groups are added as methods are launched |
| SETTLEMENT_CODE | String (settlement identifier) | Code of the settlement that includes this payment, used to reconcile the payment with the settlement report | 54A9-SET-BR-240915-001 | Empty while the payment is not settled; when a payment is split across settlements, the first settlement is reported |
| AVAILABLE_FOR_SETTLEMENT | String (Yes or No) | Indicates whether the payment is already eligible to be included in the next settlement | Yes, No | No for payments that are not confirmed yet, already settled, or retained by risk analysis |
| ACQUIRER_STATUS | String in format "code - message" | Response code and message returned by the acquirer for the authorization attempt | 0 - Accepted, 83 - Not accepted | Empty for non-card payments; codes and messages are acquirer-specific and may change over time |
| CARDHOLDER | String (UTF-8 encoded) | Name of the cardholder as sent in the authorization request | MARIA S SANTOS | Empty for non-card payments; may be masked if merchant has data masking enabled |
| CARD_NUMBER | Masked string (BIN + ****** + last 4 digits) | Masked card number of the card used in the transaction. The full card number is never exposed in reports | 411111******1111 | Empty for non-card payments; tokenized cards report the masked value stored with the token |
| AUTHORIZED | String (Yes or No) | Indicates whether the card transaction was authorized (pre-approved) by the acquirer | Yes, No | No for denied or still pending authorizations; empty for non-card payments |
| CAPTURED | String (Yes or No) | Indicates whether an authorized card transaction was captured (funds effectively charged) | Yes, No | Yes with AUTHORIZED as No is not expected; pre-authorizations awaiting capture report No |
| CARD_TYPE | String (CREDIT, DEBIT or wallet funding source) | Funding type of the card used in the transaction, derived from the payment method or the card BIN | CREDIT, DEBIT | Empty when the BIN is unknown or the payment is not card-based; wallet payments may report NOT_AVAILABLE |
| CARD_BANK | String (issuer name) | Issuer bank of the card, resolved from the card BIN registry | BANCO DO BRASIL | Empty when the BIN is not present in the registry or for non-card payments |
| INVOICE_HASH | Hexadecimal string (48 characters) | Hash of the EBANX Checkout invoice that groups the payment, used when several payments belong to the same checkout | 54154bb...44a4ac | Empty for payments not created through EBANX Checkout; shared by all payments of the same invoice |
Example Payment Calculation
Scenario: Brazilian cross-border merchant processing credit card payment with comprehensive fee structure
Base Transaction Data
Payment Date: October 24, 2024
Merchant: EBANX Demo Merchant
Payment Method: Credit Card (Visa)
Customer: Maria Silva Santos
Country: Brazil (BR)
Payment Hash: 54154bb33b47474eb64ef36193644cce4e4c44c4e444a4ac
Transaction Amounts
Original Amount (amount_ext): USD 100.00
Original Currency: USD
Local Currency: BRL
Exchange Rate: 5.4310
Amount Local (amount_local): BRL 543.10 (100.00 × 5.4310)
Fee Calculations
Gross Amount: BRL 543.10
Fee Breakdown:
Percentual Fee: BRL 543.10 × 3.2% = BRL 17.38
Fixed Fee: BRL 1.50
Risk Free Fee: BRL 0.00 (not applicable)
Anticipation Fee: BRL 2.72 (0.5% for anticipated payment)
Exchange Fee: BRL 2.17 (0.4% spread)
Total Fees: BRL 23.77
Net Amount: BRL 519.33 (543.10 - 23.77)
Additional Taxes (Brazil-specific)
IOF (Withholding Tax): BRL 5.43 (1% of gross)
Final Net After WHT: BRL 513.90 (519.33 - 5.43)
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.
