This page's content:

EBANX sends settlement reports whenever the merchant requests a settlement. This report contains data about the settlement itself including payments, refunds, chargebacks, fees, and whatelse compose the settlement net amount.

The report is sent via email, S3 or SFTP protocol, EBANX Integration Team can help you choose the best one that fits your needs.

Available formarts are: XML, XLSX, JSON, and CSV.

Report contents

Section 1 – Summary (header)

This section gathers all generic information regarding the settlement.

settlement_code

Unique identification given by EBANX to this settlement.

settlement_currency

The settlement’s currency, currently ‘USD’ is the only valid currency.

merchant_id

The merchant’s unique identification given by EBANX.

merchant_name

The merchant’s name.

generate_date

The datetime when this settlement was generated.

settlement_date

The date when this settlement was created.

transfer_date

The start date of the period – all payments, refunds and chargebacks inside this settlement were processed during this period.

receive_period_to

The end date of the period.

nr_payments

Number of payments.

nr_refunds

Number of refunds.

nr_chargebacks

Number of chargebacks.

gross_total

Total amount collected.

net_total

Total net amount received by the merchant.

chargeback_cost

Total amount of chargebacks.

refund_cost

Total amount of refunds.

refund_fee

Total amount of refunds fees.

anticipation_fee

Total amount of anticipations fees.

boleto_fixed_fee

Boleto fixed fee.

boleto_variable_fee

Boleto variable fee.

cc_fixed_fee

Credit card fixed fee.

cc_variable_fee

Credit card variable fee.

eft_fixed_fee

Electronic funds transfer fixed fee.

eft_variable_fee

Electronic funds transfer variable fee.

dd_fixed_fee

Direct debit fixed fee.

dd_variable_fee

Direct debit variable fee.

return_mdr

Returned MDR amount.

amount_others
  • Any other debits or credits.
  • Negative amounts are debits, and positive amounts are credits.
  • This includes the settlement’s fee and any other manual entry done by EBANX (usually to charge or reimburse any kind of amount).

Section 2 – Payments list (payments)

This section lists all payments received that were settled in the current batch

hash

Unique identification given by EBANX to this payment.

merchant_payment_code

Unique identification given by the merchant to this payment.

order_number

Optional field given by the Merchant.

open_date

Payment’s creation datetime.

confirm_date

The datetime when the payment was confirmed.

receive_date

The datetime when the payment’s amount was received (can be different from ‘confirm_date’ in credit card operations for example).

payment_type

Payment type (boleto, creditcard, etc).

customer

Customer’s name.

original_currency

Currency of the ‘original_payment_amount’.

original_amount

Original requested amount.

settlement_currency

The currency of this settlement (see ‘Section 1’ -> ‘settlement_currency’) – The following fields (amount_gross, amount_net and all fees) are in this currency.

fx_rate

The rate using to convert from original currency to settlement currency.

amount_gross

Payment gross amount.

amount_net

Payment net amount.

fee_percentual

Total amount of fees from the percentual rule.

fee_fixed

Total amount of fees from the fixed rule.

anticipation_fee

Total amount of anticipations fees.

fee_anticipation

Total amount of fees from anticipations.

instalments

Only valid to credit card, will be 1 to non-credit card payments.

Section 3 – Refunds list (refunds)

This section lists all refunds done that were settled in the current batch

refund_id

Unique identification given by EBANX to this refund.

request_date

The datetime when this refund was received in our system.

confirm_date

The datetime when this refund was approved.

open_date

Payment’s creation datetime.

confirm_date

The datetime when the payment was confirmed.

description

Description given by the Merchant.

payment_hash

Information about the payment related to this refund (see ‘Section 2’ -> ‘hash’).

payment_merchant_payment_code

See ‘Section 2’ -> ‘merchant_payment_code’.

payment_order_number

See ‘Section 2’ -> ‘payment_order_number’.

payment_type

See ‘Section 2’ -> ‘payment_type’.

payment_customer

See ‘Section 2’ -> ‘payment_customer’.

payment_open_date

See ‘Section 2’ -> ‘open_date’.

payment_confirm_date

See ‘Section 2’ -> ‘confirm_date’.

original_currency

Currency of the ‘original_refund_amount’.

original_amount

Original requested amount.

settlement_currency

The currency of this settlement (see ‘Section 1’ -> ‘settlement_currency’) – The following fields (amount_gross, amount_net, fee and return_mdr) are in this currency.

fx_rate

The rate using to convert from original currency to settlement currency.

amount_gross

The gross amount.

amount_net

The net amount (minus fees, plus return_mdr) to charge from the Merchant.

fee

Total amount of fees.

return_mdr

Return of MDR amount.

Section 4 – Chargebacks list (chargebacks)

This section lists all chargebacks received that were settled in the current batch

chargeback_id

Unique identification given by EBANX to this chargeback.

chargeback_date

The date when the chargeback was done.

description

Description or reason of the chargeback.

reason_code

Reason code.

acquirer

Which acquirer was used to process this transaction.

nsu_doc

NSU identification.

payment_hash

Information about the payment related to this chargeback (see ‘Section 2’ -> ‘hash’).

payment_merchant_payment_code

See ‘Section 2’ -> ‘merchant_payment_code’.

payment_order_number

See ‘Section 2’ -> ‘payment_order_number’.

payment_type

See ‘Section 2’ -> ‘payment_type’.

payment_customer

See ‘Section 2’ -> ‘payment_customer’.

payment_open_date

See ‘Section 2’ -> ‘open_date’.

payment_confirm_date

See ‘Section 2’ -> ‘confirm_date’.

payment_receive_date

See ‘Section 2’ -> ‘receive_date’.

original_currency

Currency of the ‘original_payment_amount’.

original_amount

Original payment amount.

settlement_currency

The currency of this settlement (see ‘Section 1’ -> ‘settlement_currency’) – The following fields (amount_gross, amount_net) are in this currency.

fx_rate

The rate used to convert from original currency to settlement currency.

amount_gross

The gross amount.

amount_net

The net amount (currently is the same as ‘amount_gross’ because we don’t have any fees associated to chargebacks).