About PFConnect
General information about PFConnect
Process flow chart
PFConnect process flow
Platform interface
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) 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
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
Calculate quotations with PFConnect via form interface
Prior to redirection (before initiating the Authorization operation through PFconnect.aspx) it is imperative to employ simulations/quotations. This step ensures that customers are provided with options for financial products and simulations on your pages/apps. Utilize this form to query financial products and perform quotation calculations, obtaining a list of available financial products for financing purposes.
To calculate quotations for financing options with PFConnect, please use the following URL:
https://www.computop-paygate.com/PFQuotation.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. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | an..13 | C | Supplementary transaction identifier. Only the following characters are allowed:
Notice: If RefNr is not present, TransID will be used instead. Therefore in such case TransID should meet format and length of RefNr. |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | 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). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| CountryCode | a2 | O | Country, where merchant operates. Possible values: FR, IT, ES |
| ProductID | n..10 | M | Financial product identifier |
| TimeUnit | ans..10 | M | Time unit for the duration, defines the time between two installments. possible values: QUARTER, BIMONTH, MONTH, BIWEEK, WEEK |
| InstallmentNumber | n..10 | O | Duration of the credit by credit time unit |
| XID | an30 | O | ID of financed element |
| ShoppingBasketAmount | n..10 | C | Mandatory only if also DownPaymentAmount is valorized (and viceversa) |
| DownPaymentAmount | n..10 | C | Mandatory only if also ShoppingBasketAmount field is valorized (and viceversa) |
| DeliveryDate | dttm | C | Delivery date, estimated by the merchant. Mandatory if merchant operates in France. |
| Articlelist | string | C | Base64 encoded value. Mandatory if merchant operates in Italy. |
| itemtypes | array | C | Array of items, e.g.: {"items": [{items1 ...}{item2...}]} |
| itemtypes.id | ans..30 | C | ID will be assigned by merchant for the purchased good |
| itemtypes.name | ans..30 | C | Name of the purchased goods, assigned by merchant |
| itemtypes.description | ans..30 | O | Description for purchased goods, assigned by merchant |
Articlelist
Articlelist should be sent as a base64-encoded value. Please find the example below.
"itemTypes": [
{
"id": "273",
"name": "Biclycle",
"description": "Biclycle"
}
]
Articlelist=Iml0ZW1UeXBlcyI6IFsgCnsgCiJpZCI6ICIyNzMiLAoibmFtZSI6ICJCaWNseWNsZSIsIAoiZGVzY3JpcHRpb24iOiAiQmljbHljbGUiIAp9IApd
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. mid, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | an..13 | C | Supplementary transaction identifier. Only the following characters are allowed:
Notice: If RefNr is not present, TransID will be used instead. Therefore in such case TransID should meet format and length of RefNr. |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description | |
|---|---|---|---|---|
| Financing | ans..1024 | M | FinancingScenarioDetail – A set of quotations (simulations variations) calculated for a Financeable and FinancialProduct pair. Contains financial product data for a previous initialization. They are returned in JSON format and Base64 encoded. | |
Return parameters for calculate quotation with PFConnect
Create PFConnect authorisation
To create an authorisation with PFConnect, please use the following URL:
https://www.computop-paygate.com/PFConnect.aspx |
Notice: Please keep in mind that a session expires within 30 minutes. An iFrame integration is not recommended.
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. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
|---|---|---|---|
PayID | an32 | M | Unique payment reference ID returned in the quotation response. It must be included in the authorisation request to link the calculated quotation with the Financial Journey of the customer. |
RefNr | an..13 | C | Supplementary transaction identifier. Only the following characters are allowed:
Notice: If RefNr is not present, TransID will be used instead. Therefore in such case TransID should meet format and length of RefNr. |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | 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). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| URLSuccess | ans..256 | M | Complete URL which calls up 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 Platform and shop, please use the parameter UserData.
|
| Key | Format | CND | Description |
|---|---|---|---|
| URLFailure | ans..256 | M | Complete URL which calls up 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 Platform and shop, please use the parameter UserData.
|
| Key | Format | CND | Description |
|---|---|---|---|
| Response | a7 | O | Status response sent by Platform to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
| Key | Format | CND | Description |
|---|---|---|---|
| URLNotify | ans..256 | M | Complete URL which 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.
|
| Key | Format | CND | Description |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Platform forwards the parameter with the payment result to the shop. |
| Key | Format | CND | Description |
|---|---|---|---|
| ReqId | 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 Platform 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 Platform. |
| Key | Format | CND | Description |
|---|---|---|---|
| Plain | 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. |
| Key | Format | CND | Description |
|---|---|---|---|
| Custom | 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. |
Key | Format | CND | Description |
|---|---|---|---|
| StoreName | ans..50 | C | Merchant identifier assigned by PF. Mandatory for the merchants, which operates in Spain and Italy. |
| AboID | ns..30 | C | SubscriptionID on PSP side will be used by axepta to identfy its merchant. Mandatory for the merchants, which operates in France. |
| Date | dttm | C | Date of the application for financing. Mandatory for merchants operating in France and optional for those operating in Spain. |
| Customer information | |||
| FirstName | ans..23 | C | First name of the customer Mandatory for merchants operating in France and optional for those operating in Spain. |
| LastName | ans..23 | C | Last name of the customer Mandatory for merchants operating in France and optional for those operating in Spain. |
| DateOfBirth | ns10 | O | Date of birth in the format YYYY-MM-DD |
| NatIdentNr | ans..20 | O | National identification |
| Phone | a8..15 | O | Phone number (fixed network) |
| MobileNr | a8..15 | C | Phone number (mobile) Mandatory for merchants operating in France and optional for those operating in Spain. |
| ans..49 | C | E-Mail-Address of the customer Mandatory for merchants operating in France and optional for those operating in Spain. | |
| Role | ans..10 | M | Identifier role of the customer, Possible values: OWNER, THIRD, CUSTOMER |
| Billing address | |||
| bdAddressAddition | ans..60 | C | Additional/complementary address line. Special character [;] not allowed. Mandatory for merchants operating in France and optional for those operating in Spain. |
| bdZIP | ans..10 | C | Postal code in the invoicing address Mandatory for merchants operating in France and optional for those operating in Spain. |
| bdCity | ans..40 | C | Town/city in the invoicing address Mandatory for merchants operating in France and optional for those operating in Spain. |
| bdCountryCode | a2 | C | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars Mandatory for merchants operating in France and optional for those operating in Spain. |
| Shipping address | |||
| sdAddressAddition | ans..60 | C | Address information in the delivery address Mandatory for merchants operating in France and optional for those operating in Spain. |
| sdZip | ans..10 | C | Postcode in the delivery address Mandatory for merchants operating in France and optional for those operating in Spain. |
| sdCity | ans..40 | C | Town/city in the delivery address Mandatory for merchants operating in France and optional for those operating in Spain. |
| sdCountryCode | a2 | C | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars Mandatory for merchants operating in France and optional for those operating in Spain. |
| Custom properties | |||
| CustomValue | ans..60 | O | Value of the customProperties MerchantData |
| To be financed elements | |||
| XID | an30 | C | Identification of the order bag to be financed. Mandatory for merchants operating in Spain and Italy. |
| ShoppingBasketAmount | n..10 | C | The total price amount of the orderBag Mandatory for merchants operating in Spain. |
| DeliveryDate | dttm | O | Delivery date, estimated by the merchant |
| Articlelist | string | C | Base64 encoded value. Mandatory if merchant operates in Italy. |
| itemtypes | array | C | Array of items, e.g.: {"items": [{items1 ...}{item2...}]} |
| itemtypes.id | ans..30 | C | ID will be assigned by merchant for the purchased good |
| itemtypes.name | ans..30 | C | Name of the purchased goods, assigned by merchant |
| itemtypes.description | ans..30 | O | Description for Purchased goods, assigned by merchant |
| Financing criteria | |||
| ProgramID | O | Financial programID | |
| PlanID | C | ID of the quotation (value transmitted on the response of the CalculateQuotation). Mandatory for merchants operating in France. | |
| InstallmentNumber | C | In this field the partner can include the duration of the loan if they know it (eg: 6, 12, 18, 24, 36, 48 or 60). This field may also come empty. If it is empty, the longest duration will be shown to the user by default, and they will be able to play with the monthly payments, so that we will finally use the promotion that best suits the user's selection. Mandatory for merchants operating in France. | |
| ProductID | n..10 | M | Financial Product identifier |
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. mid, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | an..13 | C | Supplementary transaction identifier. Only the following characters are allowed:
Notice: If RefNr is not present, TransID will be used instead. Therefore in such case TransID should meet format and length of RefNr. |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| 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! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Platform Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description | |
|---|---|---|---|---|
| CodeExt | ans..256 | O | External error code | |
| ErrorText | ans..256 | O | Description of external error code | |
| ApplicationID | ans..32 | O | PF Identifier | |
Capture
Captures are possible via a Server-to-Server connection. With this call you can process only full captures, a partial capture ist not possible. In order to perform a capture for PFConnect 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. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Platform for the payment to be captured |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | 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). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
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. mid, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| 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! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Platform Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
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. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Platform for the payment to be credited |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | 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). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
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. mid, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| 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! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Platform Response Codes (A4 Error codes) |
Reversal
Reversals are possible via a Server-to-Server connection. If a Capture is still not done, with this call you can reverse the complete authorisation. In order to reverse a transaction with PFConnect, please use the following URL:
https://www.computop-paygate.com/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. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Platform for the payment to be reversed |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | 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). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
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. mid, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| 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! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Platform Response Codes (A4 Error codes) |

