Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Multiexcerpt include
SpaceWithExcerptDOCBNP
MultiExcerptNameLogo BNP
PageWithExcerptEnglish documentation

Contents

Table of Contents


Document history 

Date

Name

Change

20.04.2020

Peter Posse

Original version

 


Description

The Settlement File aggregates all the data provided from the different payment methods used by the merchant in order to accommodate their reconciliation and reporting needs. Clearing and Settlement information are collected from the respective payment schemes, processors or acquirers.

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 by the relevant payment scheme(s), processor(s) or acquirer(s).


Available payment Methods

Category

Scheme

Processor / Acquirer / Gateway

Cards

CB, Visa, Mastercard, AMEX

BNP Paribas

AMEXAMEX

Alternative solutions

Amazon Pay**

Amazon

PayPal*

PayPal

Alipay

Wechat

Union Pay International (UPI)

Paysafecard

SEPA Direct Debit (SDD)

MyBank

Giropay

Klarna Sofort (Pay now)

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 Pay Later)**Klarna
iDEAL**BNP Paribas

Cetelem 3x4x**

Cetelem Presto**

BNP Paribas

*Currently under developpement**Not available currently


File structure

The file is provided in a CSV format (comma separated file).

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

FormatDescription

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>

 

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

NoField nameFormatDescriptionExample

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

Merchant's identification (MID)

BNP_MERCHANT_ECOM_FR_EUR

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.

Please find below the exiting populated 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

Merchant's identification (MID)

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..768

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’

24.04.2020 00:00:00

29

PAYOUT_IDAns..32Settlement file ID280700149

30

PAYOUT_DATEN8Clearing date20200528

31

PAYOUT_REFERENCEN6Settlement file reference number799843

32

PAYOUT_CURRENCYA3Currency of accountEU

33

INTERCHANGE_FEE

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



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.

Total record

Identifies the respective entry as totals record, value ‘900’.

900

2

RECORD_COUNT

N..5

Total number of rows in detailed records section.

36

3

TOTAL_AMOUNT

N..12

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

500Direct Debit**Debit
501Credit
502Chargeback

510

CARD

Debit

511

Credit

512

Chargeback (currently not available)

513Costs

514

Retrieval Request

517

Fraud elements (TC40/SAFE)

520

PAYPAL*

Debit

521

Credit

522

Chargeback

524Litigation in process
525Closure of the dispute (resolved)
526General withdrawal from PayPal account

580

iDEAL**

Debit

581Credit

630

KLARNA**

Debit

631Credit

710

PPRO



Debit

711

Credit

712

Chargeback

720Amazon Pay**Debit
721Credit
722Chargeback
723

Authorisation

*Currently under developpement

**Currenctly not available.


Note : Please ignore "record_type" which are not mentioned in the table.


Details of the fields with multiple information

Field "Customer_Info"

Payment method

Structure / Comment

Example

AMAZON PAY

[Customer_Name]#
[Customer_E-Mail]

John Doe#
john.doe@gmail.com

CARD

Masked card number or card token and card brand:
[0000xxxxxxxx0000]#
[Brand]

4111xxxxxxxx9996#
Visa

DIRECT DEBIT

[Account_Holder]#
[Account_Number]#
[Bank_ Code]#
[Bank]

or

[Account_Holder]#
[IBAN]#
[BIC]#
[Bank]

or

[IBAN]# '
[BIC]

John Doe#
10602437#
205950#
Barclays

or

John Doe#
GB58BARC20595010602437#
BARCGB22#
Barclays

or

GB58BARC20595010602437#
BARCGB22

iDEAL

[Account_Holder]#
[IBAN]#
[BIC]#
[Bank]

John Doe#
NL12RABO0388375809#
RABONL2U#
Rabobank

KLARNA PAYMENTS

[OCR_No]#
[Invoice_No]

1834143680436#
519072450221831988

KLARNA SOFORTsee DIRECT DEBITsee DIRECT DEBIT

PAYPAL

[Payer_ID]#
[Payer]

A59XV256BZ#
john.doe@gmx.de

PPRO

Credit

[Acc_Holder]#
[Acc_Number]#
[Bank_Code]#

[Bank_Name]#
[BIC]#
[IBAN]


Chargeback

[Acc_Holder]#

[BIC]#

[IBAN]


John Doe#

#
RABONL2U#
Rabobank#
RABONL2U#
NL30RABO0205970948



John Doe#

RABONL2U#
NL30RABO0205970948



Field "Extended_Info"

Payment method

Structure / Comment

Example

AMAZON PAY*

[SellerOrderId]#
[SellerReferenceId]#
[AmazonOrderReferenceId]#
[AmazonTransactionId]#
[TotalTransactionFee]


CARD

[Merchant_Discount_Rate]#
[Merchant_Discount]
[Currency]


CHARGEBACK (currently not available)

[ARN]#
[Reason_Code]#
[Status]

RETRIEVAL REQUEST

[ARN]#
[Reason_Code]#
[Status]

TC40/SAFE

[ARN]#
[Code]#

1.875#
1.95#
EUR


74527646319021051645048#
0350#
MI1


74527646319021051645048#
0350#
MI1


74627546887030655470117#
6

DIRECT DEBIT*

[PmtInfId]

or

[Mandate_ID]#[IP address]

Chargeback [6]

[reasonCode]#[trigger]#[token]

reasonCode -

  • 4 digit SEPA reason code

trigger -

  • “CHB” = Chargeback
  • “B1”..”B3” = CB after 1st, 2nd or 3rd retry

token -

  • ACT - CB was initiated by the customer
  • RFND - CB was initiated by the merchant
  • FRM - format error
  • NSF - no sufficient

5e736c2d718843149b71e3439b292dfe




reasonCode=MD17#trigger=CHB#token=NSF

iDEAL*

NL#
[IP address]

NL#
82.151.44.149

KLARNA PAYMENTS*[Merchant_Discount]3.97
KLARNA SOFORT*

[Customer_ID]#
[Country]#
[Mandate_ID]#
[IP address]

9139795844#
DE#
9135762874-203185592#
78.49.133.9

PAYPAL

[Merchant_Discount]#
[Currency]#
[Transaction_Type (credit / debit)]

203#
EUR#
CR

PPRO

Credit

[Channel]#
[TAG]#
[Country]#
[Selling_Point]#
fixed_fee=[FIXED_FEE_AMOUNT]#
fixed_fee_currency=[FIXED_FEE_CURRENCY]#
external_fee=[EXTERNAL_FEE_AMOUNT]#
external_fee_currency=[EXTERNAL_FEE_CURRENCY]#
minimum_discount_fee=[MINIMUM_DISCOUNT_FEE_AMOUNT]#
discount_rate=[DISCOUNT_RATE]

  • Channel : From payment scheme or provided by merchant.
    This is individually handled but usually we use the value "testchannel" for test accounts and "livechannel" for live accounts.
  • TAG : Depends on payment scheme provided by paygate (has to be arranged with PPRO).
    This is individually handled. The most current list will get distributed during the integration process.
  • Country : Parameter AddrCountryCode provided in merchant request.
    ·   GiropayPP
    ·   iDEALPP
    ·   SEPAPP
    ·   SofortPP
  • SellingPoint : Provided by merchant.


Chargeback

[Chargeback_ID]#
[Chargeback_Reason_Code]#
[Chargeback_RefNu


livechannel#
iDEALPP#
NL#
T63542
fixed_fee=0.45#
fixed_fee_currency=EUR#
external_fee=0.00#
external_fee_currency=EUR#
minimum_discount_fee=0.00#
discount_rate=0










1055329#
MD06#
15072617000095/OCMT/EUR26,49/CHGS/EUR4,20



Example

Code Block
100,BNP_MERCHANT_ECOM_FR_EUR,20200918,1.5
510,,BNP_MERCHANT_ECOM_FR_EUR,,,,,,,24.05.2020 02:00:30,OK,81654048,22bcbe3b5e6244c981c14e4210493988,6298,,6198,EUR,561258xxxxxx0934#Cartes Bancaires,,,,,,,,,0.16,27.05.2020 00:00:00,0000280700149,20200528,000280,EUR,0.12000,0.00235,0.03765,,,,,,,,,,,,,,,
510,,BNP_MERCHANT_ECOM_FR_EUR,,,,,,,24.05.2020 02:00:30,OK,81654048,22bcbe3b5e6244c981c14e4210493988,176000,,176000,EUR,5312XXXXXXXX0162#Cartes Bancaires,,,,,,,,,4.75,01.11.2017 00:00:00,0799843707306,20171103,799843,EUR,5.28000,2.43442,-2.96442,,,,,,,,,,,,,,,
511,,BNP_MERCHANT_ECOM_FR_EUR,,,,,,,20.07.2020 22:09:42,OK,73854588,dce173aee58a40eb8a34baee469603d4,6617,,599,EUR,4972xxxxxxxx4724#Cartes Bancaires,,,,,,,,,0.00,12.09.2020 00:00:00,0000622700257,20200914,000622,EUR,0.01000,0.00235,0.00000,,,,,,,,,,,,,,,
900,3,182797