Contents
Table of Contents |
---|
Document history
Date | Name | Change |
---|---|---|
20.04.2020 | Peter Posse | Original version |
Definitions and abbreviations
Definitions
Data formats:
a | alphabetical |
as | alphabetical with special characters |
n | numeric |
an | alphanumeric |
ans | alphanumeric with special characters |
ns | numeric with special characters |
bool | boolean expression (true or false) |
3 | fixed length with 3 digits/characters |
..3 | variable length with maximum 3 digits/characters |
enum | enumeration of allowed values |
dttm | ISODateTime (YYYY-MM-DDThh:mm:ss) |
Abbreviations:
CND | condition |
M | mandatory |
O | optional |
C | conditional |
Notice: Please note that the names of parameters can be returned in upper or lower case.
Description
The Settlement File aggregates all the data provided from the different payment schemesused by the merchants in order to accommodate the reconciliation and reporting needs of our clients. Clearing and Settlement information are collected from the respective payment schemes, processors or acquiring organizations
The file is provided in a CSV format (comma separated file).
It is available :
- From the AXEPTA BNP Paribas backoffice(the file is available until 60 days in the backoffice)
- via an SFTP connection (for configuration and account credentials information, please contact the BNP Paribas technical assistance)
- via email (not recommended because the size is limited when there are large volumes of transactions)
Please note that the Settlement Files are generated in accordance with the frequency of clearing and settlement information made available with the relevant payment scheme(s), processor(s) or acquirer(s).
Available payment Methods
Category | Scheme | Processor / Acquirer / Gateway |
---|---|---|
Cards | CB, Visa, Mastercard, AMEX CAPN | BNP Paribas |
Alternative solutions | Amazon Pay | Amazon |
PayPal | PayPal | |
Alipay Union Pay International (UPI) Paysafecard SEPA Direct Debit (SDD) MyBank Giropay Klarna Sofort TrustPay Bancontact iDeal EPS Przelewy24 (P24) Multibanco Finnish ebanking Zimpler FPX MyClear RHB Bank eNets POLi Payments AstroPay direct Boleto Bancario | PPRO Notice: In case of Bancontact via PPRO also failed payments will be reported in the Settlement file, so that the merchant can account for the transaction fee = 0.22€. With following characteristics the merchant can recognize a failed payment: Faulty transactions are returned always with Transaction Date = 01.01.1970 01:00:00 and additional "Amount Capture" mit the value „0“. In this case the merchant only can account for the transaction fee (fixed_fee=0,22). | |
Klarna Payments | Klarna | |
iDEAL | BNP Paribas | |
Cetelem 3x4x Cetelem Presto | BNP Paribas |
File structure
Each Settlement File is structured into :
- a header record,
- one or multiple detail records
- and a total record.
The encoding for the line breaks is configurable at merchant level. Some fields may contain values of variable length. Where sizes are not given, a field size limitation does not apply.
Data format
Format | Description |
---|---|
a | Alphabetic characters A-Z, a-z |
n | Numeric digits, 0-9 |
an | Alphanumeric characters A-Z, a-z, 0-9 |
ans | Alphanumeric and special characters |
ns | Numeric and special characters |
3 | Fixed length data element of 3 characters |
..17 | Variable length data element up to a maximum of 3 characters. The minimum length is defined by the specific requirements of the data element itself, but shall be at least 1 character. |
tstp | Timestamp, format: <DD.MM.YYYY hh:mm:ss> |
Data element directory
All data elements of the BNP Settlement File are listed in alphabetical order in the table below. Some of the elements may contain sub-fields that provide data which are specific to an individual payment method, payment scheme or processor. For further details on these data please refer to the original documentation of the acquirer / processor.
File name (.ctsf)
Naming convention: <MERCHANT_ID>#<FILE_CREATION_DATE>#<COUNTER>.ctsf
No. | Element | Format | Example |
---|---|---|---|
1 | MERCHANT_ID | an..20 | ACME01 |
2 | FILE_CREATION_DATE | N8 | 20201014 |
3 | COUNTER | N3 | 001 |
File name example: ACME01#20201014#001.ctsf
Settlement file's table (version 1.5)
Header record
No | Field name | Format | Description | Example |
---|---|---|---|---|
1 | RECORD_TYPE | N3 | Header record Identifies the respective entry as header record, value ‘100’. Detail record Identifier that specifies the payment method and type of account ledger entry (e.g. debit and credit). Charges to customers are indicated as debits and payments to customers as credits. Totals record Identifies the respective entry as totals record, value ‘900’. | 100 |
2 | MERCHANT_ID | An..30 | BNP merchant identification | ACME01 |
3 | DATE | N8 | Date the Settlement File was created, <DDMMYYYY>. | 20200424 |
4 | VERSION | An..4 | Version (current version is 1.5) | 1.5 |
Detail record
Empty fields (fields 2,4,5,6,7,8,9,15,19,20,21,22,23,24,25,37,38,39,40,41,42,43,44,45,46,47,48,49,50) will be enriched with new data during the first semester of 2021.
Empty fields must be ignored.
Below, you can find the current fields :
No | Element | Format | Description | Example |
---|---|---|---|---|
1 | RECORD_TYPE | N3 | Header record Identifies the respective entry as header record, value ‘100’. Detail record Identifier that specifies the payment method and type of account ledger entry (e.g. debit and credit). Charges to customers are indicated as debits and payments to customers as credits. Totals record Identifies the respective entry as totals record, value ‘900’. | 510 |
3 | MERCHANT_ID | An..30 | BNP merchant identification | BNP_MERCHANT_ECOM_FR_EUR |
10 | PAYMENT_CREATION_DATE | Tstp | Date and time the payment has been created, <DD.MM.YYYY hh:mm:ss>. | 20.04.2020 14:18:23 |
11 | STATUS | An.. | The status of the payment, currently always ‘OK’. | OK |
12 | REFERENCE | An12 | The Reference Number is a unique string submitted by the merchant in order to identify a payment (e.g. invoice number, ticket number etc.). It usually gets forwarded to the payment scheme and is echoed in the clearing records / reports so that it can be matched with submitted transactions. | qArxtOE4w3Fs |
13 | TRANSACTION_ID | An..64 | Unique reference submitted by the merchant in order to recognize a payment for an order. It might be shared across a sequence of related transactions (requests) that constitute a payment (e.g. authorization, capture, credit, etc). | 890_XUoqyBWuGw |
14 | AUTHORIZATION_AMOUNT | N..12 | Authorized amount in smallest unit of transaction currency. | 789 |
16 | TRANSACTION_AMOUNT | N..12 | The amount that has been processed by the payment scheme in smallest unit of the transaction currency. | 700 |
17 | TRANSACTION_CURRENCY | A3 | Refers to the three-letter ISO 4217 currency code of the currency in which the transaction was processed. | EUR |
18 | CUSTOMER_INFO | Ans..160 | Constructed field encompassing specific customer related information depending on the payment method. Sub-fields are divided by ‘#’ (U+0023) (Number Sign). | 4111xxxxxxxx9996#VISA |
26 | ORDER_DESCRIPTION | Ans..384 | A description of the order the payment relates to. | Monthly subscription fee to ACME TV |
27 | EXTENDED_INFO | Ans..20 | Constructed field encompassing additional information that is available depending on the payment method. Sub-fields are divided by ‘#’ (U+0023) (Number Sign). | 1.875#EUR |
28 | CAPTURE_DATE | Tstp | The date and time a transaction has been accepted by the acquirer / payment scheme for settlement, <DD.MM.YYYY hh:mm:ss>. If the time is not given it will be set to ‘00:00:00’ |
ACQUIRER_FEE
Charges for the services of Acquirer.
AUTHORIZATION_AMOUNT
Authorized amount in smallest unit of transaction currency.
CAPTURE_DATE
The date and time a transaction has been accepted by the acquirer / payment scheme for settlement, <DD.MM.YYYY hh:mm:ss>. If the time is not given it will be set to ‘00:00:00’
COUNTER
Enumerator to ensure unique file names (left justified zero filled).
CUSTOMER_INFO
Constructed field encompassing specific customer related information depending on the payment method. Sub-fields are divided by ‘#’ (U+0023) (Number Sign).
EXTENDED_INFO
Constructed field encompassing additional information that is available depending on the payment method. Sub-fields are divided by ‘#’ (U+0023) (Number Sign).
FILE_CREATION_DATE
Date the Settlement File was created, <DDMMYYYY>.
INTERCHANGE_FEE
Fees charged by the card issuer.
MERCHANT_ID
BNP merchant identification
ORDER_DESCRIPTION
A description of the order the payment relates to.
PAYMENT_CREATION_DATE
Date and time the payment has been created, <DD.MM.YYYY hh:mm:ss>.
PROCESSING_FEE
Charges for the services of Processors (PSP, Gateway, Network Operator).
RECORD_COUNT
Total number of rows in detailed records section.
RECORD_TYPE
Header record
Identifies the respective entry as header record, value ‘100’.
Detail record
Identifier that specifies the payment method and type of account ledger entry (e.g. debit and credit). Charges to customers are indicated as debits and payments to customers as credits.
Totals record
Identifies the respective entry as totals record, value ‘900’.
REFERENCE_NUMBER
The Reference Number is a unique string submitted by the merchant in order to identify a payment (e.g. invoice number, ticket number etc.). It usually gets forwarded to the payment scheme and is echoed in the clearing records / reports so that it can be matched with submitted transactions.
SCHEME_FEE
Fee charged by the card organization.
STATUS
The status of the payment, currently always ‘OK’.
TOTAL_AMOUNT
Sum of all transaction amounts (credits are also summed up to the total amount) in the detailed record section in the smallest unit of transaction currency.
TRANSACTION_AMOUNT
The amount that has been processed by the payment scheme in smallest unit of the transaction currency.
TRANSACTION_CURRENCY
Refers to the three-letter ISO 4217 currency code of the currency in which the transaction was processed.
TRANSACTION_ID
Unique reference submitted by the merchant in order to recognize a payment for an order. It might be shared across a sequence of related transactions (requests) that constitute a payment (e.g. authorization, capture, credit, etc).
File names
Naming vonvention: <MERCHANT_ID>#<FILE_CREATION_DATE>#<COUNTER>.ctsf
No.
Element
Format
Example
1
MERCHANT_ID
an..20
ACME01
2
FILE_CREATION_DATE
N8
20201014
3
COUNTER
N3
001
File name example: ACME01#20201014#001.ctsf
Records
Header record
1
RECORD_TYPE
N3
100
2
MERCHANT_ID
An..30
ACME01
3
DATE
N8
20200424
4
VERSION
An..4
1.0
Detail record
Version 1.2 [1]
No
Element
Format
Example
1
RECORD_TYPE
N3
510
2
MERCHANT_ID
An..20
ACME01
3
TRANSACTION_ID
An..64
890_XUoqyBWuGw
4
TRANSACTION_CURRENCY
A3
EUR
5
AUTHORIZATION_AMOUNT
N..12
789
6
TRANSACTION_AMOUNT
N..12
700
7
PAYMENT_CREATION_DATE
Tstp
20.04.2020 14:18:23
8
STATUS
An..
OK
9
REFERENCE
An..30
qArxtOE4w3FsSX5
10
CUSTOMER_INFO
Ans..160
4111xxxxxxxx9996#VISA
11
CAPTURE_DATE
24.04.2020 00:00:00 |
29 |
PAYOUT_ |
ID | Ans.. |
Monthly subscription fee to ACME TV
32 | Settlement file ID | 280700149 | ||
30 | PAYOUT_DATE | N8 | Clearing date | 20200528 |
31 | PAYOUT_REFERENCE | N6 | Settlement file reference | 799843 |
32 | PAYOUT_CURRENCY | A3 | Currency of account | EU |
33 | INTERCHANGE_FEE |
13
Ans..20 | Fees charged by the card issuer. | 1. |
875#13#EUR |
34 |
SCHEME_FEE | Ans..20 | Fee charged by the card organization. | 1.875#13#EUR |
35 |
ACQUIRER_FEE | Ans..20 | Charges for the services of Acquirer. | 1.875#13#EUR |
36 |
PROCESSING_FEE | Ans.. |
20 | Charges for the services of Processors (PSP, Gateway, Network Operator). | 1.875#13#EUR |
17
PROCESSING_FEE
Ans..20
1.875#13#EUR
[1] IC++ elements are only available if provided by acquiring bank.
Total record
No | Element | Format | Description | Example |
---|---|---|---|---|
1 | RECORD_TYPE | N3 | Header record Identifies the respective entry as header record, value ‘100’. Detail record Identifier that specifies the payment method and type of account ledger entry (e.g. debit and credit). Charges to customers are indicated as debits and payments to customers as credits. Totals record Identifies the respective entry as totals record, value ‘900’. |
Total record
No | Element | Format | Example | ||
---|---|---|---|---|---|
1 | RECORD_TYPE | N3900 | |||
2 | RECORD_COUNTN..5 | N..5 | Total number of rows in detailed records section. | 36 | |
3 | TOTAL_AMOUNT | N..12 | 798960 | Sum of all transaction amounts (credits are also summed up to the total amount) in the detailed record section in the smallest unit of transaction currency. | 798960 |
Values of the field "Record_Type"
Record | Payment method | Transaction type |
---|---|---|
500 | Direct Debit | Debit |
501 | Credit | |
502 | Chargeback | |
510 | CARD[1] | Debit |
511 | Credit | |
512 | Chargeback | |
513 | Costs | |
514 | Retrieval Request | |
517 | Fraud elements (TC40/SAFE) | |
520 | PAYPAL | Debit |
521 | Credit | |
522 | Chargeback | |
524 | Litigation in process | |
525 | Closure of the dispute (resolved) | |
526 | General withdrawal from PayPal account | |
580 | iDEAL | Debit |
581 | Credit | |
630 | KLARNA PAYMENTS | Debit |
631 | Credit | |
710 | PPRO | Debit |
711 | Credit | |
712 | Chargeback | |
720 | Amazon Pay | Debit |
721 | Credit | |
722 | Chargeback | |
723 | Authorisation |
Details of the fields with multiple information
Field "Customer_Info"
Payment method | Structure / Comment | Example |
---|---|---|
AMAZON PAY | [Customer_Name]# | John Doe# john.doe@gmail.com |
CARD | Masked card number or card token and card brand: | 4111xxxxxxxx9996# |
DIRECT DEBIT | [Account_Holder]# |
Additional informations
Field "Customer_Info"
Payment method | Structure / Comment | Example | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
AMAZON PAY | [Customer_Name]# | John Doe# john.doe@gmail.com | ||||||||||
CARD | Masked card number or card token and card brand: | 4111xxxxxxxx9996# | ||||||||||
DIRECT DEBIT | [Account_Holder]# or [Account_Holder]# or [IBAN]# ' | John Doe# or John Doe# or GB58BARC20595010602437# | ||||||||||
iDEAL | [Account_Holder]# | John Doe# | ||||||||||
KLARNA PAYMENTS | [OCR_No]# | 1834143680436# | ||||||||||
KLARNA SOFORT | see DIRECT DEBIT | see DIRECT DEBIT | ||||||||||
PAYPAL | [Payer_ID]# | A59XV256BZ# | ||||||||||
PPRO | _Number]# | _Name] or [Account_Holder]# | IBANBank] | Chargebackor [ | Acc_HolderIBAN]# ' | #[IBAN]John Doe# | #10602437# | RABONL2U#205950# | Rabobank#Barclays | RABONL2U#or John Doe# | RABONL2U#GB58BARC20595010602437# | NL30RABO0205970948
Field "Extended_Info"
BARCGB22# or GB58BARC20595010602437# | ||||
iDEAL | [Account_Holder | |||
Payment method | Structure / Comment | Example | ||
---|---|---|---|---|
AMAZON PAY | [SellerOrderId]# | CARD[1] | BIC]# | John Doe# |
KLARNA PAYMENTS | [OCR_No | [Merchant_Discount_Rate]# | MerchantInvoice_No] | 1834143680436# |
KLARNA SOFORT | see DIRECT DEBIT | see DIRECT DEBIT | ||
PAYPAL | [Payer_ID Discount][Currency] CHARGEBACK [ARN]# RETRIEVAL REQUEST Payer] | A59XV256BZ# | ||
PPRO | Credit [Acc_Holder[ARN]# TC40/SAFE [ARN]Acc_Number]# 74527646319021051645048# 74527646319021051645048# 74627546887030655470117# | DIRECT DEBIT | [PmtInfId] or [Mandate_ID]#[IP address] Chargeback [6] [reasonCode]#[trigger]#[token] reasonCode -
trigger -
token -
| |
iDEAL | NL# | NL# | ||
KLARNA PAYMENTS | [Merchant_Discount] | 3.97 | ||
KLARNA SOFORT | [Customer_ID]# | 9139795844# | ||
PAYPAL | [Merchant_Discount]# | 203# | PPRO |
[1] Chargebacks and Fraud elements are only available if provided by acquiring bank.
[Bank_Name]# Chargeback [Acc_Holder]# [BIC]# [IBAN] | John Doe# # John Doe# RABONL2U# |
Field "Extended_Info"
Payment method | Structure / Comment | Example |
---|---|---|
AMAZON PAY | [SellerOrderId]# | |
CARD[1] | [Merchant_Discount_Rate]# CHARGEBACK [ARN]# RETRIEVAL REQUEST [ARN]# TC40/SAFE [ARN]# | 1.875# 74527646319021051645048# 74527646319021051645048# 74627546887030655470117# |
DIRECT DEBIT | [PmtInfId] or [Mandate_ID]#[IP address] Chargeback [6] [reasonCode]#[trigger]#[token] reasonCode -
trigger -
token -
| 5e736c2d718843149b71e3439b292dfe reasonCode=MD17#trigger=CHB#token=NSF |
iDEAL | NL# | NL# |
KLARNA PAYMENTS | [Merchant_Discount] | 3.97 |
KLARNA SOFORT | [Customer_ID]# | 9139795844# |
PAYPAL | [Merchant_Discount]# | 203# |
PPRO | Credit [Channel]# Channel : From payment scheme or provided by merchant. TAG : Depends on payment scheme provided by paygate (has to be arranged with PPRO). Country : Parameter AddrCountryCode provided in merchant request. SellingPoint : Provided by merchant. Chargeback [Chargeback_ID]# | livechannel# 1055329# |
Field "Record_Type"
Record
Payment method
Transaction type
510
CARD[1]
Debit
511
Credit
512
Chargeback
514
Retrieval Request
517
Fraud elements (TC40/SAFE)
520
PAYPAL
Debit
521
Credit
522
Chargeback
580
iDEAL
Debit
630
KLARNA PAYMENTS
Debit
710
PPRO
Debit
711
Credit
712
Chargeback
Example
Code Block | ||
---|---|---|
| ||
100,MID,20140911,1.0 510,9dc67059361dbe07,EUR,7595,7595,02.09.2020 00:16:44,OK,90459a6a15b281664263,531001xxxxxx3570#MasterCard,02.09.2020 00:19:01,Order Description,1.875#EUR 511,9dc67059361dbe07,EUR,7595,2000,02.09.2020 00:16:44,OK,90459a6a15b281664263,531001xxxxxx3570#MasterCard,02.09.2020 02:02:36,Order Description,1.875#EUR 512,n/a,EUR,,100,10.09.2020 15:20,OK,,,10.09.2020 15:20,, 520,333246c1b46eafeb3,EUR,1490,1490,02.09.2020 11:37:03,OK,b0b4dcd7a263fc4a0327,BXV7N2GVX3TEY#john_doe@web.de,02.09.2020 11:37:33,PAYPAL . . .,53#EUR#DR 521,333246c1b46eafeb3,EUR,1490,620,02.09.2020 11:37:03,OK,b0b4dcd7a263fc4a0327,BXV7N2GVX3TEY#john_doe@web.de,02.09.2020 11:40:50,PAYPAL . . .,22#EUR#CR 522,n/a,EUR,,7090,06.09.2020 13:33,OK,593-151-678,NJW7HRTXBU3P4,06.09.2020 13:33,, 610,P6437554,PLN,18598,18598,19.01.2020 18:06:43,OK,,PayU Customer#payucust@interia.eu,09.02.2020 08:28:37,Transaction placed,P6437554#660545423#1.40 611,P6337819,PLN,4087,11999,24.01.2020 12:46:26,OK,,PayU Customer#payucust@wp.pl,09.02.2020 23:54:44,Refund P6337819,P6337819#649697804#0.00 700,20200130-105459-867,BRL,100,100,02.09.2020 10:55:33,OK,11ID68VS84EFP8NZ,John Doe#john.doe@bol.com.br,02.09.2020 00:00:00,Order Desc,Credit Card#1.0#0.33#09/03/2020 701,20200206-133103-673,BRL,100,100,02.09.2020 13:31:27,OK,XHVHGE6N71KA2BQ3,John Doe#john.doe@bol.com.br,02.09.2020 00:00:00,Order Desc,Banricompras#1.0#09/04/14#09/02/2020 701,20200127-152555-373,BRL,100,100,02.09.2020 15:27:41,OK,SBC55VKFI482ZUR7,John Doe#john.doe@bol.com.br,02.09.2020 00:00:00,Order Desc,Credit Card#1.0#0.68#09/03/2020 700,20200206-104248-837,BRL,100,100,02.09.2020 11:44:21,OK,WNADUW08HRWM4MG8,John Doe#john.doe@bol.com.br,02.09.2020 00:00:00,Order Desc,Banco do Brasil Comércio Eletrônico#1.0#0.32#09/03/2020 702,20200228-162237-848,BRL,100,100,02.09.2020 16:24:28,OK,,,02.09.2020 00:00:00,,Credit Card#0#16/05/14#03/09/2020 700,20200228-162237-849,BRL,100,100,02.09.2020 00:00:00,OK,SHVTLZVTC43KLQET,John Doe#john.doe@bol.com.br,02.09.2020 00:00:00,Order Desc,Debit Card#1.0#0.68#09/03/2020 700,20200130-105459-867,BRL,100,100,04.09.2020 10:55:33,OK,NYLUB2TNYMPDU0WL,John Doe#john.doe@bol.com.br,04.09.2020 00:00:00,Order Desc,Credit Card#1.0#0.33#09/03/2020 700,20200128-170102-000,BRL,100,100,02.09.2020 17:05:20,OK,U8OCHXW2SEQZJRJR,John Doe#john.doe@bol.com.br,02.09.2020 00:00:00,Order Desc,Boleto Bancário#1.0#0.18#09/03/2020 700,20200228-162237-848,BRL,100,100,02.09.2020 16:37:25,OK,PM805LIHFDVOU0MV,John Doe#john.doe@bol.com.br,02.09.2020 00:00:00,Order Desc,Debit Card#1.0#0.68#09/03/2020 701,20200127-152746-365,BRL,100,100,01.09.2020 15:32:36,OK,CDQVHYQHECI7NUGX,John Doe#john.doe@bol.com.br,01.09.2020 00:00:00,Order Desc,Credit Card#1.0#0.5#09/02/2020 700,20200130-135801-194,BRL,100,100,05.09.2020 08:27:00,OK,06H9UGSIC8TTALLG,John Doe#john.doe@bol.com.br,05.09.2020 00:00:00,Order Desc,Boleto Bancário#1.0#0.22#09/07/2020 700,20200205-163338-333,BRL,100,100,02.09.2020 13:07:12,OK,7I62X0RXHDCN8D0N,John Doe#john.doe@bol.com.br,20.08.2020 00:00:00,Order Desc,Bradesco Comércio Eletrônico#1.0#03/09/14#20/08/2020 900,20,50692 |