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.
Logo |
|
Info | 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. |
Type |
Card Scheme |
Carte 4Etoiles |
cofidis3xcb |
facilypay-3x |
facilypay-3xsansfrais |
facilypay-4x |
facilypay-4xsansfrais |
Process flow chart
Cofidis process flow via the form interface
Paygate interface
Definitions
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 | Comment |
CND | condition | |
M | mandatory | If a parameter is mandatory, then it must be present |
O | optional | If a parameter is optional, then it can be present, but it is not required |
C | conditional | If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional |
Notice: Please note that the names of parameters can be returned in upper or lower case.
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:
https://www.computop-paygate.com/cofidis.aspx
Notice: For security reasons, Computop Paygate 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:
| Key | Format | CND | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |||||||||
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment | ||||||||
RefNr | ans..15 | O | Merchant’s unique reference number | ||||||||
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | |||||||||
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |||||||||
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |||||||||
ans..256 | M | Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData. Common notes:
| |||||||||
ans..256 | M | Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData. Common notes:
| |||||||||
a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. | |||||||||
ans..256 | M | Complete URL which Paygate 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 UserDataparameter instead. Common notes:
| |||||||||
ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | |||||||||
ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. | |||||||||
an..6 | OM | Determines the type and time of capture.
| |||||||||
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. | ||||||||
CCBrand | an14 | M | "Carte 4Etoiles" | ||||||||
ans..50 | O | A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. "Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. | |||||||||
ans..1024 | O | "Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. Please find a sample here: Custom |
Parameters for credit card payments via Cofidis form interface
The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..15 | O | Merchant’s unique reference number |
a..50 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ans..1024 | O | If specified at request, Paygate 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 Paygate |
n16 | O | Pseudo Card Number: Random number generated by Computop Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. The PCN can be used like a genuine card number for authorisation, capture and credits. PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON | |
ans..50 | O | A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. "Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. | |
ans..1024 | O | "Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. Please find a sample here: Custom |
Return parameters for URLSuccess, URLFailure and URLNotify via Cofidis form interface
Credit card payment with Cofidis via standard Paygate form interface
In order to execute an TLS credit card payment with Cofidis via standard Paygate form, please use the following URL:
https://www.computop-paygate.com/payssl.aspx
Notice: For security reasons, Computop Paygate 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:
| Key | Format | CND | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |||||||||
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment | ||||||||
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | |||||||||
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |||||||||
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |||||||||
ans..256 | M | Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData. Common notes:
| |||||||||
ans..256 | M | Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData. Common notes:
| |||||||||
a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. | |||||||||
ans..256 | M | Complete URL which Paygate 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 UserDataparameter instead. Common notes:
| |||||||||
ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | |||||||||
ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. | |||||||||
an..6 | OM | Determines the type and time of capture.
| |||||||||
ans..50 | O | A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. "Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. | |||||||||
ans..1024 | O | "Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. Please find a sample here: Custom | |||||||||
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 Computop 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, R = Routine payment (Recurring) | ||||||||
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 Paygate 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. Computop 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
To adapt the layout of the SSL-page to your shop you can use the following unencrypted parameters to configure colours, fonts and images:
| Key | Format | CND | Description |
|---|---|---|---|
ans..20 | O | Name of XSLT-file with your own layout for the pay form. If you want to use the redesigned and downwards compatible Computop template, please transfer the template name “ct_compatible”. If you want to use the responsive Computop template for mobile devices, please transfer the template name “ct_responsive”. | |
ans..256 | O | Background ambiance of form: URL for a background image - HTML-colour value for background colour as HEX value or - HTML-colour name | |
ans..7 | O | Form background colour: - HTML-colour value for background colour as HEX value or - HTML-colour name | |
ans..256 | O | Form background image: URL for a background image Please note that this value supersedes “BGColor”. | |
ans..7 | O | Text colour: - HTML-colour value as HEX value or - HTML-colour name | |
a..10 | O | HTML-name for the font | |
n2 | O | Number for font size | |
Language | a2 enum | O | 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, <pt> Portuguese, <ro> Romanian, <ru> Russian, <sp> Spanish, <se> Swedish, <sk> Slovakian, <sl> Slovenian, <tr> Turkey, <zh> Simplified Chinese. No details means the language is German. |
CCSelect | a..16 | O | Determines preselected card type in the form: VISA, MasterCard, AMEX, DINERS, JCB, CBN, Hipercard, Elo, Aura, Dankort, Airplus, ComfortCard, CUP or Maestro |
ans..256 | O | Complete URL which Paygate calls in case that Cancel is clicked by the customer. The parameter "URLBack" can be sent
In order to exchange values between Paygate and shop you may use something like this: URLBack=https://your.shop.com/back.php?param1%3Dvalue1%26param2%3Dvalue3%26status%3Dcancelled When user cancels payment this URL is called exactly like this and you may use URL Decode to extract parameter and values. | |
n1 | O | By default the form is centered vertically and horizontally. The value <1> centres the form at the top. | |
ans..4 | O | Width of table for input in the form as percent- (50%) or pixel values (320). | |
ans..4 | O | Height of table for input of the payment data in the form as percent- (70%) or pixel values (480). | |
ans..50 | O | Merchants can customize up to 14 special fields (called CustomField1 to CustomField14) on their payment form template. CustomFields are a feature that allows you to show additional information such as your logo, order details and customer details on the payment form. Special characters (like &, ', <, >) are not allowed – even not "urlencoded". The usage / display of CustomField{n] depends on the template that is used. |
Layout parameters for Paygate forms for credit card payments with Cofidis via Paygate form
The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..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 Computop settlement file (CTSF) we cannot add the additional payment data. |
a..50 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | |
TID | n..15 | M | The value will be returned as provider TransactionID |
addata1 | ans..28 | O | Return as with call up |
n16 | O | Pseudo Card Number: Random number generated by Computop Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. The PCN can be used like a genuine card number for authorisation, capture and credits. PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON | |
CCBrand | a..22 | OC | In combination with PCNr: Designation of credit card brand Please note the spelling according to table of credit card brands! |
n6 | OC | Optional in combination with PCNr: Expiry date of the credit card in the format YYYYMM (202207) | |
MaskedPan | an..19 | OC | Masked card number 6X4. If you want to receive the parameter MaskedPan, please contact the Computop Helpdesk, which can activate the return. |
ans..50 | O | A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. "Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. | |
ans..1024 | O | "Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. Please find a sample here: Custom | |
ans..50 | O | Merchants can customize up to 14 special fields (called CustomField1 to CustomField14) on their payment form template. CustomFields are a feature that allows you to show additional information such as your logo, order details and customer details on the payment form. Special characters (like &, ', <, >) are not allowed – even not "urlencoded". The usage / display of CustomField{n] depends on the template that is used. |
Return parameters for URLNotify, URLSuccess and URLFailure with Cofidis via Paygate 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:
https://www.computop-paygate.com/direct.aspx
Notice: For security reasons, Computop Paygate 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:
| Key | Format | CND | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |||||||||
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment | ||||||||
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | |||||||||
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |||||||||
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! | ||||||||
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |||||||||
ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. | |||||||||
an..6 | OM | Determines the type and time of capture.
| |||||||||
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 Computop 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, R = Routine payment (Recurring) | ||||||||
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. 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 socket connection
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
a..50 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
n16 | O | Pseudo Card Number: Random number generated by Computop Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. The PCN can be used like a genuine card number for authorisation, capture and credits. PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON | |
CCBrand | a..22 | OC | In combination with PCNr: Designation of credit card brand Please note the spelling according to table of credit card brands! |
n6 | OC | Optional in combination with PCNr: Expiry date of the credit card in the format YYYYMM (202207) | |
MaskedPan | an..19 | OC | Masked card number 6X4. If you want to receive the parameter MaskedPan, please contact the Computop Helpdesk, which can activate the return. |
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 Computop 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:
https://www.computop-paygate.com/capture.aspx
Notice: For security reasons, Computop Paygate 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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |
an32 | M | ID assigned by Paygate for the payment to be captured | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..15 | O | Merchant’s unique reference number |
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. |
Parameters for captures of Cofidis via socket connections
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..15 | O | Merchant’s unique reference number |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
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:
https://www.computop-paygate.com/credit.aspx
Notice: For security reasons, Computop Paygate 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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |
an32 | M | ID assigned by Paygate for the payment to be credited | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..15 | O | Merchant’s unique reference number |
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. |
Parameters for credit of credit card payments with Cofidis via socket connection
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..15 | O | Merchant’s unique reference number |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
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. Paygate 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:
https://www.computop-paygate.com/reverse.aspx
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.
Notice: For security reasons, Computop Paygate 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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |
an32 | M | ID assigned by Paygate for the payment to be reversed | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..15 | O | Merchant’s unique reference number |
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. |
Parameters for reversals of credit card payments with Cofidis via socket connection
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..15 | O | Merchant’s unique reference number |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
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:
1HEAD,<MerchantID>,<Date>,<Version>2CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>3CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>4CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>5FOOT,<CountRecords>,<SumAmount>Example for Master MID function:
1HEAD,[Master]MerchantID,Date,2.x2Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)3FOOT,CountRecords,SumAmountThe following table describes the individual fields and values used within the data set (record) in the batch file:
| Key | Format | CND | Description |
|---|---|---|---|
Type | a..11 | M | HEAD für Header, FOOT for Footer, CC for Cofidis |
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
TransID | ans..15 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..15 | O | Merchant’s unique reference number |
an32 | M | ID assigned by Paygate for this transaction |
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks as follows:
1HEAD,<MerchantID>,<Date>,<Version>2CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>3CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>4CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>5FOOT,<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):
| Key | Format | CND | Description |
|---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
an32 | M | ID assigned by Paygate for this transaction | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Description of result parameters within the record for Batch files