Process flow chart
SimplePay process flow
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
Payment with SimplePay over Paygate form interface
To make a payment with SimplePay, please use the following URL:
https://www.computop-paygate.com/simplepay.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 | ans..40 | 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, 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 |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate 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 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 |
|---|---|---|---|
OrderDesc | ans..128 | M | Description of purchased goods, unit prices etc. Permitted characters a-z, A-Z, the digits 0-9 and the special characters :;.,?!()”. |
| 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 | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ans..32 | C | Email address of the customer | |||||||||||||||||||||||||||||
Phone | n..16 | O | Customer phone number | ||||||||||||||||||||||||||||
ans..19 | O | Timestamp for the end time of the transaction processing, specified in UTC | |||||||||||||||||||||||||||||
Language | a2 | O | Language of the payment page | ||||||||||||||||||||||||||||
InvoiceFlag | boolean | C | If the billing information of the buyer is not known in the merchant system, this will allow the customer to provide this information on the payment page. | ||||||||||||||||||||||||||||
ArticleList | array | O |
Articlelist1=ArticleName,ArticleCode,UnitPrice,Quantity,VAT-rate,Description Articlelist2=ArticleName,ArticleCode,UnitPrice,Quantity,VAT-rate,Description ... ArticlelistN=ArticleName,ArticleCode,UnitPrice,Quantity,VAT-rate,Description | ||||||||||||||||||||||||||||
ChargeAmount | n..10 | O | The amount of the shipping cost specified in the currency setup in the account, which will be added to the amount payable | ||||||||||||||||||||||||||||
Discount | n..10 | O | The amount of the discount specified in the currency setup in the account, which will be deducted from the amount payable | ||||||||||||||||||||||||||||
FirstName | ans..32 | O | First name of the customer, if different from the value “invoice”/“name” | ||||||||||||||||||||||||||||
LastName | ans..32 | O | Last name of the customer, if different from the value “invoice”/“name” | ||||||||||||||||||||||||||||
CountryCode | a2 | O | Country code |
| 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. |
Invoice array
Parameter | CND |
|---|---|
bdFirstName bdLastName | C |
| bdCompanyOrPerson | O |
| bdCountryCode | C |
| bdState | C |
| bdCity | C |
| bdZIP | C |
bdStreet bdStreetNr | C |
Delivery array
If different from invoice data
Parameter | CND |
|---|---|
sdFirstName sdLastName | C |
sdCompany | O |
| sdCountryCode | C |
| sdState | C |
| sdCity | C |
| sdZip | C |
sdStreet sdStreetNr | C |
sdStreet2 | O |
sdPhone | O |
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben: es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden
die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
| 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 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 Paygate 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 |
|---|---|---|---|
RefNr | ans..40 | O | Merchant’s unique reference number |
| 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 |
|---|---|---|---|
TransactionID | an..20 | O | Unique transaction number with SimplePay (orderRef) |
| 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. |
Example request
Plain data:
MerchantID=npesic_test&TransID=52269355424149223537&Amount=3000&Currency=HUF&RefNR=15005776&URLBack=https://computop.com/paygate-test&URLSuccess=https://computop.com/developer/blowfish-test/success.php&URLFailure=https://computop.com/developer/blowfish-test/failure.php&URLNotify=https://computop.com/developer/blowfish-test/notify.php&email=nebojsa.pesic@computop.com&Orderdesc=test
Capture
If your MID isn't configured for Sale operation, every initial SimplePay payment (call to simplepay.aspx) should be confirmed using capture.aspx endpoint or canceled via reverse.aspx.
Captures (or confirmations in terms of SimplePay) are possible via a Server-to-Server connection. To carry out 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. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate 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 |
|---|---|---|---|
| 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 |
|---|---|---|---|
CompleteType | ans..3 | O | Specifies whether only a partial amount is being confirmed and authorization should be kept open. If <YES> is transferred, the possible open order is closed on capture. |
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 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) |
Reversal
Reversals are possible via a Server-to-Server connection. In order to cancel a payment via a server-to-server communication, 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. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate 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 |
|---|---|---|---|
| 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 |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate 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 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. |
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 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) |
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 Paygate 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: |
| 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. |
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 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) |