About PayMorrow
General information about PayMorrow
| Logo |
|
|---|---|
| Info | PayMorrow supports invoice purchasing and secured direct debit in Germany. Merchants benefit from comprehensive protection against bad debt. |
| Type | Mixed payment methods |
Further information can be found on the webpage of PayMorrow (https://paymorrow.de/)
Process flow chart
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
PayMorrow purchase on invoice and direct debit
A payment with PayMorrow consists of several transaction steps, which are partly optional and depend on the situation. The PayMorrow interface offers 12 different requests for this, which can be used in different ways.
During the creation of an authorisation or at the latest when confirming it, PayMorrow requires a DeviceID which is unique and which the merchant himself can assign. A UUID with 128 bits should be used for this. This UUID is generated during communication with the customer’s browser and is then transferred to Paygate in one of the requests.
A payment with PayMorrow always starts by creating an authorisation, which can still be updated if necessary. Subsequently, this authorisation must be confirmed. Optionally a received TransID of an order can still be changed before the capture. The capture or partial capture of payments takes place via the usual capture interface. Note that with PayMorrow you must make sure that a payment received in another way (bank transfer) must also be noted in this way in the capture. If necessary, you can optionally update an invoice number after capture. You can determine the status of a procedure by means of a query. In addition you can optionally shift the date for an order or individual invoices belonging to it by pausing them. Furthermore, cancellations as well as credits and partial credits are possible via the usual interfaces.
Creating/updating a PayMorrow authorisation
In order to initialise a payment with PayMorrow via a server-to-server-connection or to update an existing authorisation, please use the following URL:
https://www.computop-paygate.com/paymorrow.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 |
|---|---|---|---|
PayID | an32 | C | Obligatory if EventToken=11: ID assigned by Paygate for the payment, e.g. for referencing in batch files |
| RefNr | ns..30 | M | 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 |
|---|---|---|---|
| TaxAmount | n..10 | M | Tax amount of the entire order in the smallest currency unit (e.g. EUR Cent). Please note that: TaxAmount = Amount * x/(1+x), where x is the VAT rate. Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
OrderDesc | ans..384 | M | Description of purchased goods, unit prices etc. The first 50 characters appear in the merchant’s settlement file. You can view the full data in Computop Analytics. |
| EventToken | a2 | M | 10 for prepareOrder (create authorisation) 11 for updateOrder (update authorisation) |
| TermsAndConditions | a..3 | M | YES/NO |
| ArticleList | ans..1024 | M | Article list with the following parameters: „;“ separates the single parameters „+“ separates several articles Quantity;ArticleID;Name;Type;Category;UnitPriceGross;GrossAmount;VatRate;VatAmount Possible values for “type”: GOODS, VOUCHER, SHIPPING, PAYMENT_FEE Please use the values specified for “Category” from the Paymorrow specification. Example “VatRate”: for 19%, enter 1900 |
| CustomerID | ans..50 | O | Customer number |
| Title | ans..20 | O | Title, e.g. Dr. |
| Gender | a1 | M | Gender (M=male/F=female) |
| FirstName | ans..50 | M | First name |
| LastName | ans..100 | M | Last name |
| Phone | ans..20 | OC | Telephone number. Either Phone or MobileNo or both need to be present. |
| MobileNo | ans..50 | OC | Mobile telephone number. Either Phone or MobileNo or both need to be present. |
| ans..80 | M | E-mail address | |
| DateOfBirth | ans8 | M | Date of birth in the format YYYYMMDD |
| bdStreet | ans..50 | M | Street name in the invoicing address |
| bdStreetNr | ans..5 | M | Street number of the invoicing address |
| bdZIP | ans..5 | M | Postcode in the invoicing address |
| bdCity | ans..50 | M | Town/city of the invoicing address |
| bdCountryCode | a3 | M | Country code for the invoicing address, 3 characters according to ISO 3166 |
| sdLastName | ans..50 | O | Name of company |
| sdStreet | ans..50 | O | Street name of the separate delivery address |
| sdStreetNr | n..5 | O | Street number of the delivery address |
| sdStreet2 | ans..50 | O | Address addition in the delivery address |
| sdZIP | ans..5 | O | Postcode in the delivery address |
| sdCity | ans..50 | O | Town/city in the delivery address |
| sdCountryCode | a3 | O | Country code for the delivery address, 3 characters according to ISO 3166 |
| IPAddr | ans..39 | O | Customer´s IP address |
| BrowserSessionID | ans..50 | M | Customer´s Session ID |
| CookiesID | ans..50 | M | Customer´s CookieID |
| BrowserHeader | ans..100 | M | Customer’s BrowserHeader |
| Language | a2 | M | Language: DE |
| IBAN | ans..34 | O | International Bank Account Number |
| BIC | ans..11 | O | Bank Identifier Code |
| MandateProvided | a..3 | O | SEPA mandate issued YES / NO |
| RPMethod | a..10 | O | INVOICE / SDD (SEPA direct debit) If nothing is transferred both payment methods are validated, otherwise PayMorrow validates only this one. |
| CustomerHistory | ans..1024 | O | Customer’s article list in the form: OrderDate;totalAmount;RPMethod;Paymentstatus OrderDate = YYYY-MM-DD Paymentstatus = PAID,NOT_PAID,IN_DUNNING_PROCESS “+” separates further entries |
| ShoppingDuration | n..100 | O | Shopping duration in milliseconds |
| CheckoutDuration | n..100 | O | Checkout duration in milliseconds |
| DeviceID | ans..100 | O | Unique Device-ID |
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) |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| bdStreet | ans..50 | C | Only in case of correction by PayMorrow: Street name in the invoicing address |
| bdStreetNr | ans..5 | C | Only in case of correction by PayMorrow: Street number of the invoicing address |
| bdZIP | ans..5 | C | Only in case of correction by PayMorrow: Postcode in the invoicing address |
| bdCity | ans..50 | C | Only in case of correction by PayMorrow: Town/city of the invoicing address |
| bdCountryCode | a3 | C | Only in case of correction by PayMorrow: Country code for the invoicing address, 3 characters according to ISO 3166 |
| sdLastName | ans..50 | C | Only in case of correction by PayMorrow: Name of company |
| sdStreet | ans..50 | C | Only in case of correction by PayMorrow: Street name of the separate delivery address |
| sdStreetNr | n..5 | C | Only in case of correction by PayMorrow: Street number of the delivery address |
| sdStreet2 | ans..50 | C | Only in case of correction by PayMorrow: Address addition in the delivery address |
| sdZIP | ans..5 | C | Only in case of correction by PayMorrow: Postcode in the delivery address |
| sdCity | ans..50 | C | Only in case of correction by PayMorrow: Town/city in the delivery address |
| sdCountryCode | a3 | C | Only in case of correction by PayMorrow: Country code for the delivery address, 3 characters according to ISO 3166 |
| InvoiceStatus | a..20 | M | VALIDATED / NOT_VALIDATED |
| InvoiceDeclineType | ans..20 | M | |
| InvoiceDeclineCommunicated | ans..512 | M | Possible detailed feedback for the customer with regard to purchase on invoice |
| SDDStatus | a..20 | M | VALIDATED / NOT_VALIDATED |
| SDDDeclineType | ans..20 | M | |
| SDDDeclineCommunicated | ans..512 | M | Possible detailed feedback for the customer with regard to SEPA direct debit |
| CodeExt | n3 | O | Forwarded from Paymorrow: error_1_code |
| ErrorText | ans..255 | O | Forwarded from Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc |
| CodeExt2 | n3 | O | Forwarded from Paymorrow: error_2_code |
| ErrorText2 | ans..255 | O | Forwarded from Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc |
| CodeExt[n] | n3 | O | Forwarded from Paymorrow: error_[n]_code |
| ErrorText[n] | ans..255 | O | Forwarded from Paymorrow: up to 15 value pairs: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc |
Confirming a PayMorrow authorisation
In order to confirm a PayMorrow authorization, please use the following URL:
https://www.computop-paygate.com/paymorrow.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, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
EventToken | a2 | M | 13 for ConfirmOrder (confirm authorisation) |
| RPMethod | a..10 | C | Obligatory if INVOICE and SDD have been validated |
| DeviceID | ans..100 | C | Obligatory if not yet transferred: Unique Device-ID |
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) |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number |
| CodeExt | n3 | O | Forwarded from Paymorrow: error_1_code |
| ErrorText | ans..255 | O | Forwarded from Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc |
| CodeExt2 | n3 | O | Forwarded from Paymorrow: error_2_code |
| ErrorText2 | ans..255 | O | Forwarded from Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc |
| CodeExt[n] | n3 | O | Forwarded from Paymorrow: error_[n]_code |
| ErrorText[n] | ans..255 | O | Forwarded from Paymorrow: up to 15 value pairs: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc |
Changing the PayMorrow TransID of an order
In order to change the TransID of a PayMorrow order, for instance to change a provisional order number into a final order number, please use the following URL:
https://www.computop-paygate.com/paymorrow.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, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
EventToken | a2 | M | 12 for updateOrderID (change order number) |
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) |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number |
| CodeExt | n3 | O | Forwarded from Paymorrow: error_1_code |
| ErrorText | ans..255 | O | Forwarded from Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc |
| CodeExt2 | n3 | O | Forwarded from Paymorrow: error_2_code |
| ErrorText2 | ans..255 | O | Forwarded from Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc |
| CodeExt[n] | n3 | O | Forwarded from Paymorrow: error_[n]_code |
| ErrorText[n] | ans..255 | O | Forwarded from Paymorrow: up to 15 value pairs: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc |
Capture a PayMorrow payment (full / partial capture)
In order to execute a capture or partial capture for a PayMorrow order or to note another receipt of payment, 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, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
|---|---|---|---|
TransID | ans..64 | MC | ID assigned by Merchant for the payment process to be captured. Optional if EventToken=27: serves to settle an order or all associated invoices after transfer of the original TransID |
| Amount | n..10 | M | Amount of the entire order to be captured in the smallest currency unit (e.g. EUR Cent). Please contact the 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 |
|---|---|---|---|
| TaxAmount | n..10 | M | Tax amount of the entire order to be captured in the smallest currency unit (e.g. EUR Cent). Please note that: TaxAmount = Amount * x/(1+x), where x is the VAT rate. Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
| 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 | ns..30 | MC | Unique reference number / invoice number Optional if EventToken=27: to settle a certain invoice after transfer of the original RefNr |
| 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 |
|---|---|---|---|
EventToken | a2 | M | 21 for partial capture 22 for partial capture with approval of the remaining authorised amount 27 for registerDirectPayment (capture of a payment receipt via a different way) |
| ArticleList | ans..1024 | C | Not if EventToken=27; obligatory if EventToken=21 or 22 Article list with the following parameters: “;” separates the individual parameters Quantity;ArticleID;Name;Type;Category;UnitPriceGross;GrossAmount;VatRate;VatAmount Possible values for “type”: GOODS, VOUCHER, SHIPPING, PAYMENT_FEE Please use the values specified for “Category” from the Paymorrow specification. Example “VatRate”: for 19%, enter 1900 Optional and only by arrangement with PayMorrow, also the following short article list: VatRate;VatAmount |
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) |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | ns..30 | M | Unique reference number / invoice number |
| CodeExt | n3 | O | Forwarded from Paymorrow: error_1_code |
| ErrorText | ans..255 | O | Forwarded from Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc |
| CodeExt2 | n3 | O | Forwarded from Paymorrow: error_2_code |
| ErrorText2 | ans..255 | O | Forwarded from Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc |
| CodeExt[n] | n3 | O | Forwarded from Paymorrow: error_[n]_code |
| ErrorText[n] | ans..255 | O | Forwarded from Paymorrow: up to 15 value pairs: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc |
Updating PayMorrow invoice numbers
In order to update an invoice number for a PayMorrow payment that was not yet known at the time of the capture, please use the following URL:
https://www.computop-paygate.com/paymorrow.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, 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 |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| RefNr | ns..30 | M | Unique reference number / invoice number |
EventToken | a2 | M | 24 for updateInvoiceID (update invoice number) |
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) |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | ns..30 | M | Unique reference number / invoice number |
| CodeExt | n3 | O | Forwarded from Paymorrow: error_1_code |
| ErrorText | ans..255 | O | Forwarded from Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc |
| CodeExt2 | n3 | O | Forwarded from Paymorrow: error_2_code |
| ErrorText2 | ans..255 | O | Forwarded from Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc |
| CodeExt[n] | n3 | O | Forwarded from Paymorrow: error_[n]_code |
| ErrorText[n] | ans..255 | O | Forwarded from Paymorrow: up to 15 value pairs: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc |
Querying a PayMorrow order status
In order to query the status of a PayMorrow order, please use the following URL:
https://www.computop-paygate.com/inquire.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, e.g. for referencing in batch files as well as for capture or credit request. |
| 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 |
|---|---|---|---|
EventToken | a2 | M | 52 for getOrderStatus (query order status) |
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 |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Key | Format | CND | Description |
|---|---|---|---|
LastStatus | a..50 | M | OK or FAILED |
| 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 |
|---|---|---|---|
RefNr | ns..30 | M | Unique reference number / invoice number |
| CodeExt | n3 | O | Forwarded from Paymorrow: error_1_code |
| ErrorText | ans..255 | O | Forwarded from Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc |
| CodeExt2 | n3 | O | Forwarded from Paymorrow: error_2_code |
| ErrorText2 | ans..255 | O | Forwarded from Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc |
| CodeExt[n] | n3 | O | Forwarded from Paymorrow: error_[n]_code |
| ErrorText[n] | ans..255 | O | Forwarded from Paymorrow: up to 15 value pairs: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc |
Pausing PayMorrow payments
In order to pause an order or a payment with PayMorrow, please use the following URL:
https://www.computop-paygate.com/paymorrow.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, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
|---|---|---|---|
XID | an32 | O | XID of the transaction to be paused. If no XID is transferred, the entire order is paused. |
| 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 | ns..30 | C | Obligatory if EventToken=26: Unique reference number |
EventToken | a2 | M | for postponeOrderCollection (capture): 26 (pauses the capture specified with XID) 53 (paused all captures belonging to the payment) |
| NumberOfDays | n..3 | M | Number of days by which the order/payment is to be put back |
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) |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | ns..30 | M | Unique reference number / invoice number |
| CodeExt | n3 | O | Forwarded from Paymorrow: error_1_code |
| ErrorText | ans..255 | O | Forwarded from Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc |
| CodeExt2 | n3 | O | Forwarded from Paymorrow: error_2_code |
| ErrorText2 | ans..255 | O | Forwarded from Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc |
| CodeExt[n] | n3 | O | Forwarded from Paymorrow: error_[n]_code |
| ErrorText[n] | ans..255 | O | Forwarded from Paymorrow: up to 15 value pairs: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc |
Reversal of PayMorrow payments
In order to cancel an order or a payment with PayMorrow, 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 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 | C | Obligatory if EventToken=42: XID of a certain capture |
| 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 |
|---|---|---|---|
| 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 |
|---|---|---|---|
EventToken | a2 | M | 40 to cancel the order 41 to cancel the capture 42 to cancel a certain partial 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) |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | ns..30 | M | Unique reference number / invoice number |
| CodeExt | n3 | O | Forwarded from Paymorrow: error_1_code |
| ErrorText | ans..255 | O | Forwarded from Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc |
| CodeExt2 | n3 | O | Forwarded from Paymorrow: error_2_code |
| ErrorText2 | ans..255 | O | Forwarded from Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc |
| CodeExt[n] | n3 | O | Forwarded from Paymorrow: error_[n]_code |
| ErrorText[n] | ans..255 | O | Forwarded from Paymorrow: up to 15 value pairs: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc |
Issuing a PayMorrow credit
In order to issue a full or partial credit for a previous capture with PayMorrow, 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, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
|---|---|---|---|
XID | an32 | M | ID assigned by Paygate for all single transactions (authorization, capture, credit), which are made for one payment. The XID of the Capture to which the credit is to take place must be transferred here. |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount of the entire order to be credited in the smallest currency unit (e.g. EUR Cent). Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
TaxAmount | n..10 | M | Tax amount of the entire order to be credited in the smallest currency unit (e.g. EUR Cent). Please note that: TaxAmount = Amount * x/(1+x), where x is the VAT rate. Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
| 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 | ns..30 | M | Unique reference number for the credit |
| 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 |
|---|---|---|---|
EventToken | a2 | M | 30 credit for full amount 31 credit for partial amount 35 credit for full amount with receipt of authorisation for the amount 36 credit for partial capture with receipt of authorisation for the amount |
| ArticleList | ans..1024 | C | (only with partial credits, EventToken=31 or 36) Article list with the following parameters: “;” separates the individual parameters Quantity;ArticleID;Name;Type;Category;UnitPriceGross;GrossAmount;VatRate;VatAmount Possible values for “type”: GOODS, VOUCHER, SHIPPING, PAYMENT_FEE Please use the values specified for “Category” from the Paymorrow specification. GrossAmount + VatAmount must always be positive. Example “VatRate”: for 19%, enter 1900 Optional and only by arrangement with PayMorrow, also the following short article list: VatRate;VatAmount |
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) |
Key | Format | CND | Description |
|---|---|---|---|
RefNr | ns..30 | M | Unique reference number / invoice number |
| CodeExt | n3 | O | Forwarded from Paymorrow: error_1_code |
| ErrorText | ans..255 | O | Forwarded from Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc |
| CodeExt2 | n3 | O | Forwarded from Paymorrow: error_2_code |
| ErrorText2 | ans..255 | O | Forwarded from Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc |
| CodeExt[n] | n3 | O | Forwarded from Paymorrow: error_[n]_code |
| ErrorText[n] | ans..255 | O | Forwarded from Paymorrow: up to 15 value pairs: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc |
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 a PayMorrow transaction and which information can be found within the response file about the payment status.
Following table gives an overview of all batch versions that are possible for a specific action an their specialities:
Action | Version | Description |
|---|---|---|
| Capture | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) | |
Credit | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) | |
| Reverse | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
The structure for a capture or credit within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> PAYMORROW,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<TaxAmount> PAYMORROW,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<TaxAmount> PAYMORROW,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount>
Example for Master MID function:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount
The 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 for Header, FOOT for Footer, PayMorrow for the transactions |
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
| 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 |
|---|---|---|---|
| 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 |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for this transaction |
Key | Format | CND | Description |
|---|---|---|---|
TaxAmount | n..10 | M | Tax amount in the smallest currency unit (e.g. EUR Cent). Please note that: TaxAmount = Amount * x/(1+x), where x is the VAT rate. Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
The record area within the response file for Batch transactions looks as follows:
HEAD,<MerchantID>,<Date>,<Version> PAYMORROW,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<TaxAmount>,<Status>,<Code> PAYMORROW,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<TaxAmount>,<Status>,<Code> PAYMORROW,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount>
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
Key | Format | CND | Description |
|---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for this transaction |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |