Contents
About Cofidis
General information about Cofidis
The 4-star card was launched by Cofidis as soon as it was created in 1982, initially exclusively for customers of the 3 Suisses brand. It is a private card that combines payment facilities and loyalty benefits. The design of tailor-made products and services, adapted to customers' expectations and needs, has enabled Cofidis, over the years, to extend the 4-star card to other brands (in stores and on the Internet) such as Feu Vert, Maty, Blancheporte, Helline, Bon prix, etc.
From now on, we are talking about the 4-star network. Pay for your purchases in several instalments.
The 4-star card is a revolving credit card that offers you the possibility, depending on the amount of your purchases and the brand, to pay in several instalments.
| The 4-star card is a private card that combines payment facilities and loyalty benefits. The design of tailor-made products and services has been adapted to customers, expectations and needs. Pay for your purchases in several instalments. The 4-star card is a revolving credit card that offers you the possibility, depending on the amount of your purchases and the brand, to pay in several instalments. |
Process flow chart
Cofidis process flow
Payment platform interface
Data formats: Format Description 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: Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Special characters
Cofidis accepts only a limited range of special characters according the table below:
Character | Name |
|---|---|
| : | Colon |
| . | Full stop/period |
| Space | |
| @ | At sign |
| + | Plus sign |
| % | Percent sign |
| * | Asterisk |
| / | Forward slash |
| _ | Underscore |
| - | Dash (hyphen/minus sign) |
Credit card brands
Credit card brand, correct spelling for CCBrand |
Carte 4Etoiles (Carte Helline4etoiles – branded) |
Credit card payment with Cofidis via Cofidis form interface
In order to execute an TLS credit card payment via Cofidis form, please use the following URL:
Notice: For security reasons, Payment platform rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally, this parameter has to be passed in plain language too. |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
RefNr | an12 | M | Merchant’s unique reference number |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
URLSuccess | ans..256 | M | Complete URL which calls up the payment platform if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the payment platform and shop, please use the parameter UserData. |
URLFailure | ans..256 | M | Complete URL which calls up the payment platform if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the payment platform and shop, please use the parameter UserData. |
Response | a7 | O | Status response sent by the payment platform to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
URLNotify | ans..256 | M | Complete URL which the payment platform calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead. |
| UserData | ans..1024 | O | If specified at request, the payment platform forwards the parameter with the payment result to the shop |
| OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
Capture | an..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
| CCBrand | an14 | M | "Carte 4Etoiles" |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 |
Parameters for credit card payments via Cofidis form interface
The following table describes the result parameters that the payment platform transmits to your URLNotify, URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..30 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
RefNr | an12 | M | Merchant’s unique reference number |
UserData | ans..1024 | O | If specified at request, the payment platform forwards the parameter with the payment result to the shop |
| addata1 | n..3 | M | According to the modality chosen by the client :
|
| EID | an8 | C | ID assigned by Payment platform |
PCNr | n..16 | O | Pseudo Card Number: Random number generated by the payment platform which represents a genuine card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits. |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 |
Return parameters for URLSuccess, URLFailure and URLNotify via Cofidis form interface
Credit card payment with Cofidis via standard Payment platform form interface
In order to execute an TLS credit card payment with Cofidis via standard Payment platform form, please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally, this parameter has to be passed in plain language too. |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
URLSuccess | ans..256 | M | Complete URL which calls up the payment platform if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the payment platform and shop, please use the parameter UserData. |
URLFailure | ans..256 | M | Complete URL which calls up the payment platform if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the payment platform and shop, please use the parameter UserData. |
Response | a7 | O | Status response sent by the payment platform to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
URLNotify | ans..256 | M | Complete URL which the payment platform calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead. |
UserData | ans..1024 | O | If specified at request, the payment platform forwards the parameter with the payment result to the shop |
Capture | ans..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 |
expirationTime | ans..19 | O | timestamp for the end time of the transaction processing, specified in UTC. Format: YYYY-MM-ddTHH:mm:ss |
| DateOfBirth | n8 | M | Date of birth in "ddmmyyyy" format |
RefNr | an12 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Axepta settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..60 | O | Name of the card holder |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
addata1 | ans..28 | O | Transaction code [AN3]/Number of instalments [AN2]/Invoice number [AN15]/Invoice date [N8] To be transferred without separators. The invoice number and invoice date may not yet be available for the initial reservation. In this case spaces are to be entered in these fields. The transaction code was implemented according to the Cofidis specification; see the following table for transaction codes. Please observe the separate note regarding this parameter. |
Textfeld1 | ans..30 | O | further reference number of transaction |
Parameters for credit card payments with Cofidis via Payment platform form
Note regarding Cofidis parameter Addata1: Cofidis expects all reservations to be made with the transaction code 590 and replaced by the correct transaction code during the capture. Since the invoice number and date may not yet be known at the time of the reservation, transfer spaces in their place during the reservation. If the transaction code is no longer available when invoicing, the reservation can already be carried out with the correct code. Axepta then replaces the capture transaction code by 590 and changes it back when invoicing to the one transferred during the reservation. The invoice number and date are adopted at the same time and transferred to Cofidis.
Type of financing | PGI request | Transaction code | Number of instalments |
|---|---|---|---|
Small instalment | Capture, tel. Authorisation | 460 | 0 (irrelevant) |
Small instalment | Credit | 470 | 0 (irrelevant) |
Down payment | Capture | 423 | 1 |
Down payment | Credit | 523 | 1 |
Monthly instalment | Capture | 423 | x |
Monthly instalment | Credit | 523 | x |
Payment suspension | Capture | 974 | 0 (irrelevant) |
Payment suspension | Credit | 975 | 0 (irrelevant) |
Cofidis transaction codes
Parameter | Format | CND | Description |
|---|---|---|---|
Template | ans..20 | M | Name of XSLT-file with your own layout for the pay form. If you want to use the redesigned and downwards compatible Axepta template, please transfer the template name “bnp_compatible”. If you want to use the responsive Axepta template for mobile devices, please transfer the template name “bnp_responsive”. |
Background | ans..256 | M | Background ambiance of form: URL for a background image - HTML-colour value for background colour as HEX value or - HTML-colour name |
BGColor | ans..7 | M | Form background colour: - HTML-colour value for background colour as HEX value or - HTML-colour name |
BGImage | ans..256 | M | Form background image: URL for a background image Please note that this value supersedes “BGColor”. |
FColor | ans..6 | M | Text colour: - HTML-colour value as HEX value or - HTML-colour name |
FFace | a..10 | M | HTML-name for the font |
FSize | n2 | M | Number for font size |
Language | a2 (enum) | M | Language code: <de> German, <al> Albanian, <at> Austrian, <cz/cs> Czech, <dk> Danish, <en> English, <fi> Finish, <fr> French, <gr> Greek, <hu> Hungarian, <it> Italian, <jp> Japanese, <nl> Dutch, <no> Norwegian, <pl> Polish, No details means the language is German. |
CCSelect | a..10 | M | Determines preselected card type in the form: VISA, MasterCard, AMEX, DINERS, JCB, CBN, Hipercard, Elo, Aura, Dankort, Airplus, ComfortCard, CUP |
URLBack | ans..256 | M | URL for "Cancel" button |
Center | n1 | M | By default the form is centered vertically and horizontally. The value <1> centres the form at the top. |
tWidth | ans..4 | M | Width of table for input of the credit card data as percent- (50%) or pixel values (320). |
tHeight | ans..4 | M | Height of table for input of the credit card data as percent- (70%) or pixel values (480). |
The following table describes the result parameters that Payment platform transmits to your URLNotify, URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description | |
|---|---|---|---|---|
MID | ans..30 | M | ID of merchant, assigned by BNP | |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files | |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform | |
TransID | ans..15 | M | TransactionID which should be unique for each payment | |
Status | a..50 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) | |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm | |
UserData | ans..1024 | O | If specified at request, the payment platform forwards the parameter with the payment result to the shop | |
| RefNr | an12 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Axepta settlement file (CTSF) we cannot add the additional payment data. | |
| TID | n..15 | M | The value will be returned as provider TransactionID | |
| addata1 | ans..28 | O | Return as with call up | |
PCNr | n16 | O | Pseudo Card Number: Random number generated by the payment platform which represents a genuine card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits. | |
CCBrand | a..22 | OC | In combination with PCNr: Designation of credit card brand Please note the spelling! According to table of credit card brands! | |
CCExpiry | n6 | OC | In combination with PCNr: Expiry date of the credit card in the format YYYYMM (201706). | |
MaskedPan | an..19 | OC | Masked card number 6X4. If you want to receive the parameter MaskedPan, please contact our support, which can activate the return. | |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID | |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 | |
CustomField[n] | ans..50 | O | Field that can be used individually by the merchant. Presently 14 fields from CustomField1 to CustomField14 are supported. | |
Return parameters for URLNotify, URLSuccess and URLFailure with Cofidis via Payment platform form
Credit card payment via Server-to-Server connection
In order to execute a TLS credit card payment with Cofidis via a server-to-server connection, please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally, this parameter has to be passed in plain language too. |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
CCNr | n..19 | M | Credit card number at least 12-digit, numerical without spaces. You can optionally transmit also a pseudo card number (PCN). |
CCCVC | n..4 | O | Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express. |
CCExpiry | n6 | M | Expiry date of the credit card in the format YYYYMM, e.g. 201707. |
CCBrand | a..22 | M | Credit card brand. Please note the spelling according to table of credit card brands! |
Capture | ans..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
| DateOfBirth | n8 | M | Date of birth in "ddmmyyyy" format |
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Axepta settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..60 | O | Name of the card holder |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
addata1 | ans..28 | M | Transaction code [AN3]/Number of instalments [AN2]/Invoice number [AN15]/Invoice date [N8] To be transferred without separators. The invoice number and invoice date may not yet be available for the initial reservation. In this case spaces are to be entered in these fields. |
Textfeld1 | ans..30 | O | further reference number of transaction |
Parameters for credit card payments with Cofidis via socket connection
The following table gives the parameters with which Payment platform responds:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | Merchant ID, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, refund note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..50 | M | OK or AUTHORIZED as well as FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes |
PCNr | n16 | O | TOKEN (Pseudo Card Number): Random number generated by the payment platform which represents a genuine card number. The TOKEN (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and refunds. |
CCExpiry | n6 | OC | Optional in combination with PCNr: Expiry date of the credit card in the format YYYYMM (201706). |
CCBrand | a..22 | OC | Optional in combination with PCNr: Designation of credit card brand. Please note the spelling! According to table of credit card brands! |
MaskedPan | an..19 | OC | Masked card number 6X4. If you want to receive the parameter MaskedPan, please contact our support, which can activate the return. |
RefNr | an12 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Axepta settlement file (CTSF) we cannot add the additional payment data. |
addata1 | ans..28 | O | Return as with call up |
Results parameters for socket connection for Cofidis
Capture of a credit card payment with Cofidis
Captures are possible via a Server-to-Server connection. To perform a capture via a Server-to-Server connection please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by the payment platform for the payment to be captured |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
| RefNr | an12 | M | Merchant’s unique reference number |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for captures of Cofidis via socket connections
The following table describes the payment platform response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..30 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes |
| RefNr | an12 | M | Merchant’s unique reference number |
Response parameters for captures of Cofidis via socket connections
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture.
To carry out a credit with a reference transaction, please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally, this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by the payment platform for the payment to be credited |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
| RefNr | an12 | M | Merchant’s unique reference number |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for credit of credit card payments with Cofidis via socket connection
The following table describes the Payment platform response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | ID of merchant, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..30 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file |
| RefNr | an12 | M | Merchant’s unique reference number |
Response parameters for credits of credit card payments with Cofidis via socket connections
Reversal
Reversals are possible via a Server-to-Server connection. A credit card authorisation lowers the customer's credit line. The Payment platform can reverse an authorisation so that it no longer block the limit any more.
To carry out a reversal with a reference transaction, please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
Notice: Reverse.aspx does not only reverse authorisations, but any LAST TRANSACTION STAGE!! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use is at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by the payment platform for the payment to be reverted |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
| RefNr | an12 | M | Merchant’s unique reference number |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for reversals of credit card payments with Cofidis via socket connection
The following table describes the Payment platform response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..30 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file |
| RefNr | an12 | M | Merchant’s unique reference number |
Response parameters for reversals of credit card payments with Cofidis via socket connections
Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing payments / credits with Cofidis and which information can be found within the response file about the payment status.
For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.
Following table gives an overview of all batch versions that are possible for a specific action and their specialities:
Action | Version | Description |
|---|---|---|
Capture | 1.x / 2.x | Standard version |
Credit | 1.x / 2.x | Standard version |
Reverse | 1.x / 2.x | Standard version |
Description of the possible batch versions
The structure for a Cofidis payment within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount> |
Example for Master MID function:
HEAD, [Master] MerchantID,Date,2.x [Slave] MID,Amount,Currency,TransID,Data (depends on Action) |
The following table describes the individual fields and values used within the data set (record) in the batch file:
Parameter | Format | CND | Description |
|---|---|---|---|
Type | a..11 | M | HEAD for Header, FOOT for Footer, CC for Cofidis |
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
RefNr | an12 | M | Unique reference number |
PayID | an32 | M | ID for this transaction given by the payment platform |
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks as follows:
HEAD,<MerchantID>,<Date>,<Version> CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
Parameter | Format | CND | Description |
|---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
PayID | an32 | M | ID for this transaction given by the payment platform |
Status | a..50 | M | OK or FAILED |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file |
Description of result parameters within the record for Batch files
Cofidis |
Version 6.9 |
As of 19.11.2020 |
Contents
Document history
Date | Name | Change |
|---|---|---|
19.11.2020 | Peter Posse | Original version |
About Cofidis
General information about Cofidis
The 4-star card was launched by Cofidis as soon as it was created in 1982, initially exclusively for customers of the 3 Suisses brand. It is a private card that combines payment facilities and loyalty benefits. The design of tailor-made products and services, adapted to customers' expectations and needs, has enabled Cofidis, over the years, to extend the 4-star card to other brands (in stores and on the Internet) such as Feu Vert, Maty, Blancheporte, Helline, Bon prix, etc.
From now on, we are talking about the 4-star network. Pay for your purchases in several instalments.
The 4-star card is a revolving credit card that offers you the possibility, depending on the amount of your purchases and the brand, to pay in several instalments.
| The 4-star card is a private card that combines payment facilities and loyalty benefits. The design of tailor-made products and services has been adapted to customers, expectations and needs. Pay for your purchases in several instalments. The 4-star card is a revolving credit card that offers you the possibility, depending on the amount of your purchases and the brand, to pay in several instalments. |
Process flow chart
Cofidis process flow
Payment platform interface
Data formats: Format Description 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: Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Special characters
Cofidis accepts only a limited range of special characters according the table below:
Character | Name |
|---|---|
| : | Colon |
| . | Full stop/period |
| Space | |
| @ | At sign |
| + | Plus sign |
| % | Percent sign |
| * | Asterisk |
| / | Forward slash |
| _ | Underscore |
| - | Dash (hyphen/minus sign) |
Credit card brands
Credit card brand, correct spelling for CCBrand |
Carte 4Etoiles (Carte Helline4etoiles – branded) |
Credit card payment with Cofidis via Cofidis form interface
In order to execute an TLS credit card payment via Cofidis form, please use the following URL:
Notice: For security reasons, Payment platform rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally, this parameter has to be passed in plain language too. |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
RefNr | ans..15 | O | Merchant’s unique reference number |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
URLSuccess | ans..256 | M | Complete URL which calls up the payment platform if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the payment platform and shop, please use the parameter UserData. |
URLFailure | ans..256 | M | Complete URL which calls up the payment platform if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the payment platform and shop, please use the parameter UserData. |
Response | a7 | O | Status response sent by the payment platform to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
URLNotify | ans..256 | M | Complete URL which the payment platform calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead. |
| UserData | ans..1024 | O | If specified at request, the payment platform forwards the parameter with the payment result to the shop |
| OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
Capture | an..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
| CCBrand | an14 | M | "Carte 4Etoiles" |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 |
Parameters for credit card payments via Cofidis form interface
The following table describes the result parameters that the payment platform transmits to your URLNotify, URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..30 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
RefNr | ans..15 | O | Merchant’s unique reference number |
UserData | ans..1024 | O | If specified at request, the payment platform forwards the parameter with the payment result to the shop |
| addata1 | n..3 | M | According to the modality chosen by the client :
|
| EID | an8 | C | ID assigned by Payment platform |
PCNr | n..16 | O | Pseudo Card Number: Random number generated by the payment platform which represents a genuine card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits. |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 |
Return parameters for URLSuccess, URLFailure and URLNotify via Cofidis form interface
Credit card payment with Cofidis via standard Payment platform form interface
In order to execute an TLS credit card payment with Cofidis via standard Payment platform form, please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally, this parameter has to be passed in plain language too. |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
URLSuccess | ans..256 | M | Complete URL which calls up the payment platform if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the payment platform and shop, please use the parameter UserData. |
URLFailure | ans..256 | M | Complete URL which calls up the payment platform if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the payment platform and shop, please use the parameter UserData. |
Response | a7 | O | Status response sent by the payment platform to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
URLNotify | ans..256 | M | Complete URL which the payment platform calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead. |
UserData | ans..1024 | O | If specified at request, the payment platform forwards the parameter with the payment result to the shop |
Capture | ans..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 |
expirationTime | ans..19 | O | timestamp for the end time of the transaction processing, specified in UTC. Format: YYYY-MM-ddTHH:mm:ss |
| DateOfBirth | n8 | M | Date of birth in "ddmmyyyy" format |
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Axepta settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..60 | O | Name of the card holder |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
addata1 | ans..28 | O | Transaction code [AN3]/Number of instalments [AN2]/Invoice number [AN15]/Invoice date [N8] To be transferred without separators. The invoice number and invoice date may not yet be available for the initial reservation. In this case spaces are to be entered in these fields. The transaction code was implemented according to the Cofidis specification; see the following table for transaction codes. Please observe the separate note regarding this parameter. |
Textfeld1 | ans..30 | O | further reference number of transaction |
Parameters for credit card payments with Cofidis via Payment platform form
Note regarding Cofidis parameter Addata1: Cofidis expects all reservations to be made with the transaction code 590 and replaced by the correct transaction code during the capture. Since the invoice number and date may not yet be known at the time of the reservation, transfer spaces in their place during the reservation. If the transaction code is no longer available when invoicing, the reservation can already be carried out with the correct code. Axepta then replaces the capture transaction code by 590 and changes it back when invoicing to the one transferred during the reservation. The invoice number and date are adopted at the same time and transferred to Cofidis.
Type of financing | PGI request | Transaction code | Number of instalments |
|---|---|---|---|
Small instalment | Capture, tel. Authorisation | 460 | 0 (irrelevant) |
Small instalment | Credit | 470 | 0 (irrelevant) |
Down payment | Capture | 423 | 1 |
Down payment | Credit | 523 | 1 |
Monthly instalment | Capture | 423 | x |
Monthly instalment | Credit | 523 | x |
Payment suspension | Capture | 974 | 0 (irrelevant) |
Payment suspension | Credit | 975 | 0 (irrelevant) |
Cofidis transaction codes
Parameter | Format | CND | Description |
|---|---|---|---|
Template | ans..20 | M | Name of XSLT-file with your own layout for the pay form. If you want to use the redesigned and downwards compatible Axepta template, please transfer the template name “bnp_compatible”. If you want to use the responsive Axepta template for mobile devices, please transfer the template name “bnp_responsive”. |
Background | ans..256 | M | Background ambiance of form: URL for a background image - HTML-colour value for background colour as HEX value or - HTML-colour name |
BGColor | ans..7 | M | Form background colour: - HTML-colour value for background colour as HEX value or - HTML-colour name |
BGImage | ans..256 | M | Form background image: URL for a background image Please note that this value supersedes “BGColor”. |
FColor | ans..6 | M | Text colour: - HTML-colour value as HEX value or - HTML-colour name |
FFace | a..10 | M | HTML-name for the font |
FSize | n2 | M | Number for font size |
Language | a2 (enum) | M | Language code: <de> German, <al> Albanian, <at> Austrian, <cz/cs> Czech, <dk> Danish, <en> English, <fi> Finish, <fr> French, <gr> Greek, <hu> Hungarian, <it> Italian, <jp> Japanese, <nl> Dutch, <no> Norwegian, <pl> Polish, No details means the language is German. |
CCSelect | a..10 | M | Determines preselected card type in the form: VISA, MasterCard, AMEX, DINERS, JCB, CBN, Hipercard, Elo, Aura, Dankort, Airplus, ComfortCard, CUP |
URLBack | ans..256 | M | URL for "Cancel" button |
Center | n1 | M | By default the form is centered vertically and horizontally. The value <1> centres the form at the top. |
tWidth | ans..4 | M | Width of table for input of the credit card data as percent- (50%) or pixel values (320). |
tHeight | ans..4 | M | Height of table for input of the credit card data as percent- (70%) or pixel values (480). |
The following table describes the result parameters that Payment platform transmits to your URLNotify, URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description | |
|---|---|---|---|---|
MID | ans..30 | M | ID of merchant, assigned by BNP | |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files | |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform | |
TransID | ans..15 | M | TransactionID which should be unique for each payment | |
Status | a..50 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) | |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm | |
UserData | ans..1024 | O | If specified at request, the payment platform forwards the parameter with the payment result to the shop | |
| RefNr | an..15 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Axepta settlement file (CTSF) we cannot add the additional payment data. | |
| TID | n..15 | M | The value will be returned as provider TransactionID | |
| addata1 | ans..28 | O | Return as with call up | |
PCNr | n16 | O | Pseudo Card Number: Random number generated by the payment platform which represents a genuine card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits. | |
CCBrand | a..22 | OC | In combination with PCNr: Designation of credit card brand Please note the spelling! According to table of credit card brands! | |
CCExpiry | n6 | OC | In combination with PCNr: Expiry date of the credit card in the format YYYYMM (201706). | |
MaskedPan | an..19 | OC | Masked card number 6X4. If you want to receive the parameter MaskedPan, please contact our support, which can activate the return. | |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID | |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 | |
CustomField[n] | ans..50 | O | Field that can be used individually by the merchant. Presently 14 fields from CustomField1 to CustomField14 are supported. | |
Return parameters for URLNotify, URLSuccess and URLFailure with Cofidis via Payment platform form
Credit card payment via Server-to-Server connection
In order to execute a TLS credit card payment with Cofidis via a server-to-server connection, please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally, this parameter has to be passed in plain language too. |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
CCNr | n..19 | M | Credit card number at least 12-digit, numerical without spaces. You can optionally transmit also a pseudo card number (PCN). |
CCCVC | n..4 | O | Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express. |
CCExpiry | n6 | M | Expiry date of the credit card in the format YYYYMM, e.g. 201707. |
CCBrand | a..22 | M | Credit card brand. Please note the spelling according to table of credit card brands! |
Capture | ans..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
| DateOfBirth | n8 | M | Date of birth in "ddmmyyyy" format |
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Axepta settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..60 | O | Name of the card holder |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
addata1 | ans..28 | M | Transaction code [AN3]/Number of instalments [AN2]/Invoice number [AN15]/Invoice date [N8] To be transferred without separators. The invoice number and invoice date may not yet be available for the initial reservation. In this case spaces are to be entered in these fields. |
Textfeld1 | ans..30 | O | further reference number of transaction |
Parameters for credit card payments with Cofidis via socket connection
The following table gives the parameters with which Payment platform responds:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | Merchant ID, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, refund note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..50 | M | OK or AUTHORIZED as well as FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes |
PCNr | n16 | O | TOKEN (Pseudo Card Number): Random number generated by the payment platform which represents a genuine card number. The TOKEN (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and refunds. |
CCExpiry | n6 | OC | Optional in combination with PCNr: Expiry date of the credit card in the format YYYYMM (201706). |
CCBrand | a..22 | OC | Optional in combination with PCNr: Designation of credit card brand. Please note the spelling! According to table of credit card brands! |
MaskedPan | an..19 | OC | Masked card number 6X4. If you want to receive the parameter MaskedPan, please contact our support, which can activate the return. |
RefNr | ans..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Axepta settlement file (CTSF) we cannot add the additional payment data. |
addata1 | ans..28 | O | Return as with call up |
Results parameters for socket connection for Cofidis
Capture of a credit card payment with Cofidis
Captures are possible via a Server-to-Server connection. To perform a capture via a Server-to-Server connection please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by the payment platform for the payment to be captured |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
| RefNr | ans..15 | O | Merchant’s unique reference number |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for captures of Cofidis via socket connections
The following table describes the payment platform response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..30 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes |
| RefNr | ans..15 | O | Merchant’s unique reference number |
Response parameters for captures of Cofidis via socket connections
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture.
To carry out a credit with a reference transaction, please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP Paribas. Additionally, this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by the payment platform for the payment to be credited |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
| RefNr | ans..15 | O | Merchant’s unique reference number |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for credit of credit card payments with Cofidis via socket connection
The following table describes the Payment platform response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | ID of merchant, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..30 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file |
| RefNr | ans..15 | O | Merchant’s unique reference number |
Response parameters for credits of credit card payments with Cofidis via socket connections
Reversal
Reversals are possible via a Server-to-Server connection. A credit card authorisation lowers the customer's credit line. The Payment platform can reverse an authorisation so that it no longer block the limit any more.
To carry out a reversal with a reference transaction, please use the following URL:
Notice: For security reasons, the payment platform rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
Notice: Reverse.aspx does not only reverse authorisations, but any LAST TRANSACTION STAGE!! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use is at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by BNP. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by the payment platform for the payment to be reverted |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
| RefNr | ans..15 | O | Merchant’s unique reference number |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the payment platform will not carry out the payment, but will just return the status of the original transaction. Please note that the payment platform must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for reversals of credit card payments with Cofidis via socket connection
The following table describes the Payment platform response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by BNP |
PayID | an32 | M | ID assigned by the payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the payment platform |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
Status | a..30 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file |
| RefNr | ans..15 | O | Merchant’s unique reference number |
Response parameters for reversals of credit card payments with Cofidis via socket connections
Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing payments / credits with Cofidis and which information can be found within the response file about the payment status.
For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.
Following table gives an overview of all batch versions that are possible for a specific action and their specialities:
Action | Version | Description |
|---|---|---|
Capture | 1.x / 2.x | Standard version |
Credit | 1.x / 2.x | Standard version |
Reverse | 1.x / 2.x | Standard version |
Description of the possible batch versions
The structure for a Cofidis payment within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount> |
Example for Master MID function:
HEAD, [Master] MerchantID,Date,2.x [Slave] MID,Amount,Currency,TransID,Data (depends on Action) |
The following table describes the individual fields and values used within the data set (record) in the batch file:
Parameter | Format | CND | Description |
|---|---|---|---|
Type | a..11 | M | HEAD for Header, FOOT for Footer, CC for Cofidis |
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR |
TransID | ans..15 | M | TransactionID which should be unique for each payment |
RefNr | ans..15 | O | Unique reference number |
PayID | an32 | M | ID for this transaction given by the payment platform |
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks as follows:
HEAD,<MerchantID>,<Date>,<Version> CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
Parameter | Format | CND | Description |
|---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
PayID | an32 | M | ID for this transaction given by the payment platform |
Status | a..50 | M | OK or FAILED |
Code | n8 | M | Error code according to the payment platform Response Codes Excel file |
Description of result parameters within the record for Batch files