AxeptaBNP Settlement File |
---|
Integration Guide |
Version 1.0 |
As of 01.09.2019 |
Contents
Table of Contents |
---|
Document history
Date | Name | Change |
---|---|---|
01.09.2019 | Peter Posse | Original version |
Payment platform interface
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
General Notes
Purpose
The BNP Settlement File aggregates settlement data from various payment schemes as comma separated file 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 and matched with the transaction records on file at BNP.
Please note that BNP Settelement 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).
Supported Payment Schemes, Payment Methods and Acquires
Category | Scheme | Processor / Acquirer / Gateway |
---|---|---|
Credit cards | CB, Visa, Mastercard | BNP Paribas |
Alternatives | Amazon Pay | Amazon |
PayPal | PayPal | |
Alipay Union Pay International (UPI) Paysafecard SEPA Direct Debit (SDD) MyBank Giropay Sofort TrustPay Bancontact iDeal EPS Przelewy24 (P24) Multibanco Finnish ebanking Zimpler FPX MyClear RHB Bank eNets POLi Payments AstroPay direct Boleto Bancario Klarna | PPRO |
Retrieval
Merchants may collect BNP Settlement Files at their own discretion from a BNP SFTP account. For configuration and account credentials please contact the BNP helpdesk.
File strcuture
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.
Notation of data types
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.
Field name | Description |
---|---|
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 Computop 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 | 20141014 |
3 | COUNTER | N3 | 001 |
File name example: ACME01#20141014#001.ctsf
Records
Header record
No | Field name | Format | Example |
---|---|---|---|
1 | RECORD_TYPE | N3 | 100 |
2 | MERCHANT_ID | An..30 | ACME01 |
3 | DATE | N8 | 20140424 |
4 | VERSION | An..4 | 1.0 |
Detail record
Version 1.0
No | Element | Format | Example |
---|---|---|---|
1 | RECORD_TYPE | N3 | 510 |
2 | TRANSACTION_ID | An..64 | 890_XUoqyBWuGw |
3 | TRANSACTION_CURRENCY | A3 | EUR |
4 | AUTHORIZATION_AMOUNT | N..12 | 789 |
5 | TRANSACTION_AMOUNT | N..12 | 700 |
6 | PAYMENT_CREATION_DATE | Tstp | 20.04.2014 14:18:23 |
7 | STATUS | An.. | OK |
8 | REFERENCE | An..30 | qArxtOE4w3FsSX5 |
9 | CUSTOMER_INFO | Ans..160 | 4111xxxxxxxx9996#VISA |
10 | CAPTURE_DATE | Tstp | 24.04.2014 00:00:00 |
11 | ORDER_DESCRIPTION | Ans..384 | Monthly subscription fee to ACME TV |
12 | EXTENDED_INFO | Ans.. | 1.875#EUR |
Version 1.1 [1]
No | Element | Format | Example |
---|---|---|---|
1 | RECORD_TYPE | N3 | 510 |
2 | TRANSACTION_ID | An..64 | 890_XUoqyBWuGw |
3 | TRANSACTION_CURRENCY | A3 | EUR |
4 | AUTHORIZATION_AMOUNT | N..12 | 789 |
5 | TRANSACTION_AMOUNT | N..12 | 700 |
6 | PAYMENT_CREATION_DATE | Tstp | 20.04.2014 14:18:23 |
7 | STATUS | An.. | OK |
8 | REFERENCE | An..30 | qArxtOE4w3FsSX5 |
9 | CUSTOMER_INFO | Ans..160 | 4111xxxxxxxx9996#VISA |
10 | CAPTURE_DATE | Tstp | 24.04.2014 00:00:00 |
11 | ORDER_DESCRIPTION | Ans..384 | Monthly subscription fee to ACME TV |
12 | EXTENDED_INFO | Ans..20 | 1.875#EUR |
13 | INTERCHANGE_FEE | Ans..20 | 1.875#13#EUR |
14 | SCHEME_FEE | Ans..20 | 1.875#13#EUR |
15 | ACQUIRER_FEE | Ans..20 | 1.875#13#EUR |
16 | PROCESSING_FEE | Ans..20 | 1.875#13#EUR |
Version 1.2 [1]
N° | Élément | Format | Exemple |
---|---|---|---|
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.2014 14:18:23 |
8 | STATUS | An.. | OK |
9 | REFERENCE | An..30 | qArxtOE4w3FsSX5 |
10 | CUSTOMER_INFO | Ans..160 | 4111xxxxxxxx9996#VISA |
11 | CAPTURE_DATE | Tstp | 24.04.2014 00:00:00 |
12 | ORDER_DESCRIPTION | Ans..384 | Monthly subscription fee to ACME TV |
13 | EXTENDED_INFO | Ans..20 | 1.875#EUR |
14 | INTERCHANGE_FEE | Ans..20 | 1.875#13#EUR |
15 | SCHEME_FEE | Ans..20 | 1.875#13#EUR |
16 | ACQUIRER_FEE | Ans..20 | 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 | Example |
---|---|---|---|
1 | RECORD_TYPE | N3 | 900 |
2 | RECORD_COUNT | N..5 | 36 |
3 | TOTAL_AMOUNT | N..12 | 798960 |
Additional informations
Field "Customer_Info"
Payment method | Structure / Comment | Example |
---|---|---|
CREDIT CARD | Masked card number or card token and card brand: | 4111xxxxxxxx9996# |
PAYPAL | [Payer_ID]# | A59XV256BZ# |
PPRO | Credit [Acc_Holder]# [Bank_Name]# Chargeback [Acc_Holder]# [BIC]# [IBAN] | John Doe# # John Doe# RABONL2U# |
Field "Extended_Info"
Payment method | Structure / Comment | Example |
---|---|---|
CREDIT CARD[1] | [Merchant_Discount_Rate]# CHARGEBACK [ARN]# RETRIEVAL REQUEST [ARN]# TC40/SAFE [ARN]# | 1.875# 74527646319021051645048# 74527646319021051645048# 74627546887030655470117# |
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# |
[1] CB, RR and TC40/SAFE elements are only available if provided by acquiring bank.
Field "Record_Type"
Record | Payment method | Transaction type |
---|---|---|
500 | Direct Debit | Debit |
501 | Credit | |
502 | Chargeback | |
510 | CREDIT CARD[1] | Debit |
511 | Credit | |
512 | Chargeback | |
513 | Costs | |
514 | Retrieval Request | |
517 | 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 | |
710 | PPRO | Debit |
711 | Credit | |
712 | Chargeback | |
720 | Amazon Pay | Debit |
721 | Credit | |
722 | Chargeback | |
723 | Authorisation |
[1] CB, RR and TC40/SAFE records are only available if provided by acquiring bank.