Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata


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.

TypeMixed payment methods EN


Further information can be found on the webpage of PayMorrow (https://paymorrow.de/).

 

Process flow chart


PayMorrow process flow


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


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 go to the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the transfer parameters to be encrypted:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID which should be unique for each payment

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

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR is permissible.

TaxAmount

n..11

M

Tax amount of the entire order in the smallest currency unit (e.g. EUR Cent).

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

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

O

Telephone number

MobileNo

ans..50

O

Mobile telephone number

e-mail

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..15

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

Parameters for PayMorrow payment initialisations


The following table describes the result parameters with which the Paygate responds to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

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!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

O

Merchant’s unique reference number

bdStreet

ans..50

C

Only in case of correction by PayMorrow: Street name in the invoicing address

bdStreetNr

s..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

Response parameters for the PayMorrow payment initialisation



Confirming a PayMorrow authorisation

In order to confirm a PayMorrow authorization, go to the following URL:


Notice: For security reasons, 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:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

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

Parameters for the confirmation of a PayMorrow authorisation


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID which should be unique for each payment

Status

a..50

M

OK or FAILED

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!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

M

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

Reply parameters for the confirmation of a PayMorrow authorisation



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, visit the following URL:


Notice: For security reasons, 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:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

TransID

ans..64

M

Merchant’s transaction number which is used as the order number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

EventToken

a2

M

12 for updateOrderID (change order number)

Parameters for changing the PayMorrow TransID


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

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!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

M

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

Reply parameters for changing the PayMorrow TransID



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, go to the following URL:


Notice: For security reasons, 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:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

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).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR is permissible.

TaxAmount

n..11

M

Tax 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).

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

RefNr

ns..30

MC

Unique reference number / invoice number

Optional if EventToken=27: to settle a certain invoice after transfer of the original RefNr

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

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
“+” 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

Optional and only by arrangement with PayMorrow, also the following short article list:

VatRate;VatAmount

Parameters for capture of a PayMorrow payment


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

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!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Response parameters for capturing a PayMorrow payment



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 go to the following URL:


Notice: For security reasons, 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:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

RefNr

ns..30

M

Unique reference number / invoice number

EventToken

a2

M

24 for updateInvoiceID (update invoice number)

Parameters for the updating of an invoice number with PayMorrow payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

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!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Reply parameters for the updating of an invoice number with PayMorrow payments



Querying a PayMorrow order status

In order to query the status of a PayMorrow order, please go to the following URL:


Notice: For security reasons, 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:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR is permissible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

EventToken

a2

M

52 for getOrderStatus (query order status)

Parameters for querying the status of a PayMorrow order


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Status

a..50

M

OK or FAILED

LastStatus

a..50

M

OK or FAILED

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!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

M

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

Reply parameters for querying the status of a PayMorrow order



Pausing PayMorrow payments

In order to pause an order or a payment with PayMorrow, please go to the following URL:


Notice: For security reasons, 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:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

O

XID of the transaction to be paused

If no XID is transferred, the entire order is paused.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

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

Parameters for the pausing of PayMorrow payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

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!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

M

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

Reply parameters for the pausing of PayMorrow payments



Reversal of PayMorrow payments

In order to cancel an order or a payment with PayMorrow, please go to the following URL:


Notice: For security reasons, 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:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

C

Obligatory if EventToken=42: XID of a certain capture

Amount

n..10

M

Amount of the entire order to be reverser in the smallest currency unit (e.g. EUR Cent).

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR is permissible.

MAC

an64

O

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

EventToken

a2

M

40 to cancel the order

41 to cancel the capture

42 to cancel a certain partial capture

Parameters for reversal of a PayMorrow payment


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

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!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

M

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

Reply parameters for reversal of PayMorrow payments



Issuing a PayMorrow credit

In order to issue a full or partial credit for a previous capture with PayMorrow, please go to the following URL:


Notice: For security reasons, 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:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

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

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..11

M

Tax 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).

MAC

an64

O

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

RefNr

ns..30

M

Unique reference number for the credit

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

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
“+” 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

Optional and only by arrangement with PayMorrow, also the following short article list:

VatRate;VatAmount

Parameters for crediting of a PayMorrow payment


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

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!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

M

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

Response parameters for crediting a RatePAY payment



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 / 2x.

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


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 Funktion:

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:

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, RatePay for the transactions

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

TaxAmount

n..11

M

Tax amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Description of fields within the record for Batch files

 

 

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 in):

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Description of result parameters within the record for Batch files