Skip to main content

Settlements & Chargebacks

Settlement and chargeback reports use the same format.

info

Fields prefixed with CHARGE_BACK are only valued in chargeback report.

info

Some fields could be empty and not provided depending on the Payment Mean or Payment Solution.

Settlement Dates

There are two dates for a settlement:

  • Settlement remittance date: the date on which the transaction was captured
  • Settlement value date: the date on which the funds move from an account to another

Sample files

You can download file examples in json or in csv format.

Data structure

info

All date are in ISO UTC format

Field in JSON fileField in CSV fileTypeDescriptionExample
idIDstringUnique identifier of the settlement/chargeback line provided by the partner88cf7c8f-17e5-4ee2-91d7-fe5090b7e0c9
partnerPARTNERenumPartner identifierBRAINTREE
entity_idENTITY_IDstringPurse merchant id21d8373b-987f-e9e6-6294-983deab36e9a
typeTYPEenum (SETTLEMENT, CHARGEBACK)Type (Settlement or chargeback)CHARGEBACK
amountAMOUNTnumberAmount settled10000
gross_amountGROSS_AMOUNTnumberGross amount100.0
settlement_statusSETTLEMENT_STATUSenumSettlement status.MATCH_SUCCESS
settle_value_dateSETTLE_VALUE_DATEdateSettlement value date (if reconciled by the partner). See Dates section2021-10-18T00:00:00.000Z
settle_remittance_dateSETTLE_REMITTANCE_DATEdateSettlement remittance date (if reconciled by the partner). See Dates section2021-10-17T00:00:00.000Z
transaction_detail.idTRANSACTION_IDstringPurse unique transaction identifier74ed2728-ec12-45b3-8e59-2da09affd66e
transaction_detail.session_idSESSION_IDstringPurse unique session identifier53d24bd2-a781-44f8-8cb4-1927424b90bb
transaction_detail.partner_idPARTNER_TRANSACTION_IDstringPartner unique transaction identifier. Uniqueness cannot be guaranteed by Pursetr1245b532
transaction_detail.partner_original_idPARTNER_ORIGINAL_TRANSACTION_IDstringPartner unique identifier of the original transaction in case of a refund or a duplicationxgt9528r41
transaction_detail.partner_technical_idPARTNER_TRANSACTION_TECHNICAL_IDstringTransaction identifier provided by the partner for debug / tracking purposeLNVFDH8766
transaction_detail.typeTRANSACTION_TYPEenumTransaction type. See Settlement Transaction TypeWITHDRAWALS_AND_DEBITS_CATEGORY
transaction_detail.amountTRANSACTION_AMOUNTnumberInitial transaction amount10000
transaction_detail.partner_statusTRANSACTION_PARTNER_STATUSstringTransaction status returned by the partnerWAITING_AUTHORISATION
transaction_detail.status_codeTRANSACTION_STATUS_CODEenumTransaction status code (only for chargeback). See Transaction Status CodeSUCCEEDED
order.referenceORDER_REFERENCEstringOrder identifier.FRA_123
customer.referenceCUSTOMER_REFERENCEstringCustomer identifiery15txj98
customer.company_nameCUSTOMER_COMPANY_NAMEstringCompany identifier (B2B).Purse
operation.typeOPERATION_TYPEenum (CREDIT, DEBIT)Operation subtype (if provided by the PSP)CREDIT
operation.currencyOPERATION_CURRENCYstringSettlement currency (ISO 247)EUR
remittance_idREMITTANCE_IDstringIdentifier of the remittance of the settlement035580665100001
interchange_feeINTERCHANGE_FEEnumberInterchange fees20.63
merchant.partner_idMERCHANT_PARTNER_IDstringMerchant identifier set by the partnero9ksbh10
merchant.countryMERCHANT_COUNTRYstringMerchant country in ISO codeFR
contract_vadCONTRACT_VADstringContract identifier0535530
clearing_instituteCLEARING_INSTITUTEstringName of clearing houseFIRSTDATACOMPASS
exchange_rateEXCHANGE_RATEnumberCurrency rate1.08
bank.accountBANK_ACCOUNTstringBank account number provided by acquirer098651222
bank.codeBANK_CODEstringBank code provided by acquirer10765
card.networkCARD_NETWORKstringCard network (mastercard, visa ...)VISA
card.countryCARD_COUNTRYstringBank card country (ISO)FR
card.categoryCARD_CATEGORYstringCategory of the cardCREDIT
card.type_complementary_infoCARD_TYPE_COMPLEMENTARY_INFOstringComplementary information about the card. Blank if the partner doesn't return the information in a single fieldCARD_COUNTRY=DEU | Maestro=NO
card.binCARD_BINstringBank identification number123456XXXXXX1234
fee.amountFEE_AMOUNTnumberPartner fee amount1.76
fee.bank_amountBANK_FEE_AMOUNTnumberBank fees0.24
fee.network_amountNETWORK_FEE_AMOUNTnumberCard network (visa, mastercard ...) fixed only fees2.00
fee.currencyFEE_CURRENCYstringPartner fee currencyEUR
payment.methodPAYMENT_METHODstringPayment methodSDD
payment.geo_zonePAYMENT_GEO_ZONEstringGeographic zone of paymentUE
chargeback.exchange_unpaid_amountCHARGE_BACK_EXCHANGE_UNPAID_AMOUNTnumberAmount in counter currency provided by acquirer8.46
chargeback.pba_remise_idPBA_REMISE_IDstringIdentifier of transfer if the settlement is related to automatic bank transfer
chargeback.non_payment_settle_dateCHARGE_BACK_NON_PAYMENT_SETTLE_DATEdateNon-payment settlement date provided by acquirer2021-10-18T00:00:00.000Z
chargeback.unpaid_amountCHARGE_BACK_UNPAID_AMOUNTnumberChargeback amount8.46
chargeback.reasonCHARGE_BACK_REASONenumReason for chargeback. See Chargeback ReasonFRAUDULENT_TRANSACTION
chargeback.partner_reason_codeCHARGE_BACK_PARTNER_REASON_CODEstringReason code sent by the partner100001
chargeback.manager_bank_accountCHARGE_BACK_MANAGER_BANK_ACCOUNTstringAdministrator account provided by acquirer1007