Chart of process flow: Mandate approval via form interface / Direct Debit via Server-2-Server connection
Paygate 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
Mandate creation with customer approval via OTP
The interface of the Paygate form to approve a SEPA mandate is MandateForm.aspx.
https://www.computop-paygate.com/MandateForm.aspx |
This section explains the parameters for Mandate Approval.
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..35 | M | TransactionID which should be unique for each payment. When using auto-mandate (filling-in of MandateID with TransID or RefNr) the permitted character set is that of the MandateID parameter. |
Account | ans..12 | O | Within Paygate several EasyCollect accounts can be stored on one MerchantID and controlled by the parameter Account. Each account relates to a specific creditor configuration. By default, first entry will be used. The setup must be agreed with Computop Helpdesk. |
| 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: |
| 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 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. |
| Key | Format | CND | Description |
|---|---|---|---|
| URLSuccess | 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.
|
| Key | Format | CND | Description |
|---|---|---|---|
| URLFailure | 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.
|
| Key | Format | CND | Description |
|---|---|---|---|
| Response | a7 | O | Status response sent by Paygate 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 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 UserData parameter instead.
|
Key | Format | CND | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Consumer Data | |||||||||
| ans..254 | O | Email address of the customer | |||||||
| FirstName | ans..50 | O | First name | ||||||
| LastName | ans..50 | O | Last name | ||||||
| companyName | ans..50 | O | Name of the company | ||||||
| bdStreet | ans..50 | M | Street | ||||||
| bdStreetNr | ans..50 | M | Street number | ||||||
| bdZip | ans..50 | M | Postcode | ||||||
| bdCity | ans..50 | M | Town | ||||||
| bdCountryCode | a..3 | M | Country code 2 or 3 characters according to ISO 3166 | ||||||
| phone | ans..50 | O | Mobile phone of the customer; an OTP value is sent to this mobile number in case agreementScheme=SMS is used | ||||||
| bdGender | a1 | O |
| ||||||
| Mandate Data | |||||||||
| contractId | ans..50 | O | Underlying contract identifier | ||||||
| contractDescription | ans..50 | O | Underlying contract description | ||||||
| businessIdentifier | ans..50 | O | Unique SIREN Id of the merchant | ||||||
| agreementScheme | enum | O | The way how the OneTimePassword (OTP) will be forwarded to the customer.
| ||||||
| DocumentSignature | enum | O | The stamp is added on the last page of the mandate document.
| ||||||
| GoogleAnalyticsConsent | enum | O | Debtor consent to use google analytics
| ||||||
| SignatureBySca | enum | O | If "true" customer will be authenticated by AccountIdentificationService.
| ||||||
| Sps | enum | O | Allows to identify that WS call comes from SPS
| ||||||
| Validation | enum | O | If Validation = TRUE --> ORG / If Validation = FALSE --> OTU
| ||||||
| customerType | enum | O | Type of customer
| ||||||
| MandateID | ans..35 | O | Predefined mandate id. The mandate itself will use this mandate id. Pattern: ^[a-zA-Z\+\?\(\)\-\s:/.,_'0-9] {1,35}$ | ||||||
| MdtSeqType | enum | O | Indicates whether the mandate is a one-off mandate or a mandate for recurring direct debits. There is no default. The default value depends on merchant configuration.
| ||||||
| MdtType | enum | O | Indicates whether the mandate is a business-to-business mandate or a customer-to-business mandate. There is no default. The default value depends on merchant configuration.
| ||||||
| EventToken | enum | O | Creates a new mandate and first direct debit transaction simultaneously.
| ||||||
| DueDate | ans10 | O | DueDate of this transaction. If missing the current day will be used. Pattern: YYYY-MM-DD | ||||||
| CustomerId | an1..64 | O | Customer identifier submitted by the merchant during a payment | ||||||
| RemittanceInfo | ans..50 | O | The RemittanceInfo parameter is required for reconciliation purposes, providing essential customer-visible information on customer bank statements for better tracking and reporting.
| ||||||
| signerPositionOccupied | ans..70 | O | Title of the signatory's position in the company | ||||||
| template | ans..20 | O | Name of a XSLT template to get an individual layout for your EasyCollect form which matches with your shop layout. Details are available here: Corporate PayPage and templates. |
| Key | Format | CND | Description |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| 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. |
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 Paygate 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 Paygate |
| 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 Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description | |
|---|---|---|---|---|
| MandateID | ans..35 | O | Predefined mandate id. The mandate itself will use this mandate id. Pattern: ^[a-zA-Z\+\?\(\)\-\s:/.,_'0-9] {1,35}$ | |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| 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. |