Zinia

Logo

Info

Zinia offers Buy Now Pay Later solution on purchases

Type

Payments by Invoice and Installments

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

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

Computop request

Zinia request

Description

Authorize

Merchant_login

Create_order

Computop executes automatically the requests, Provided the merchant API credentials are configured in the MAT. merchant login is used to get acess token to carry out the checkout and the create order is used to initate the payment.

Capture

Capture

Activates and/or carries out payment. This request must be given when the goods are shipped.

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

PayType

enum

M

Enum: BNPL, INSTALMENTS

pmtChannel

enum

M

Enum: ECOMMERCE , POS , POS_HOME_DELIVERY , CALL_CENTER and CLICKANDCOLLECT

OrderDesc

ans..768

O

Description of the goods purchased

E-mail

ans..255

M

eMail address of the card holder

CustomerID

an..30

O

Unique customer ID in merchant system or the customer’s email address

Title

ans..45

O

Title

Salutation

ans..45

O

Salutation

Gender

a1

M

Gender: Sex (M=male / F=female / U=unknown)

DateOfBirth

dttm8

C

Date of birth in the format YYYYMMDD

PhoneAreaCode

ans..30

C

Telephone code. Mandatory if MobileAreaCode is not transmitted.

Phone

ans..30

C

Phone number. Mandatory if Mobile is not transmitted.

FaxAreaCode

ans..30

O

Fax area code

Fax

ans..30

O

Fax number

MobileAreaCode

ans..30

C

Mobile area code. Mandatory if PhoneAreaCode is not transmitted.

Mobile

ans..30

C

Mobile telephone number. Mandatory if Phone is not transmitted.

ShopSystem

ans..127

O

Name of the shop system

ShopSystemVersion

ans..127

O

Version name of the shop system

Customer data

CompanyName

ans..100

C

Company name

CompanyID

ans..100

C

Registration ID of the Organization (in the event that the customer type is a company) (Only for B2B customers).

Example: 123423-CO

CustomerType

string

O

PERSON or COMPANY

docNumber

string

O

Legal document number

docType

enum

O

Legal document type

ENUM: NATIONAL_ID , SSN , FOREIGN_NATIONAL_NUMBER and PASSPORT

Delivery data

sdSalutation

ans..45

O

Salutation

sdCompany

ans..100

O

Company name

sdFirstName

ans..100

M

First name of the customer

sdLastName

ans..100

M

Nachname des Kunden

sdStreet

ans..100

O

Street name and house number

sdStreetHouseNumber

ans..10

O

Street number

sdStreetAddition

ans..50

O

Addition in the delivery address

sdZIPCode

ans..10

O

Postcode

sdCity

ans..255

O

City

sdCountryCode

a2

O

Two characters country code according to ISO 3166

sdPhone

ns..32

O

Customer’s phone number

Invoice data

bdSalutation

ans..45

O

Salutation

bdCompany

ans..100

O

Company name

bdFirstName

ans..100

M

First name of the custumer

bdLastName

ans..100

M

Last name of the customer

bdCompanyName

ans..100

O

Name of company

bdStreet

ans..50

M

Street name in the invoicing address

bdStreetNr

ans..10

M

Street number of the invoicing address

bdStreetAddition

ans..50

O

Address addition in the billing address

bdZIP

ans..10

M

Postcode in the invoicing address

bdCity

ans..255

M

Town/city of the invoicing address

bdCountryCode

a2

M

Country code for the invoicing address, 2 characters according to ISO 3166

bdPhone

ns..32

M

Customer’s phone number

Registration address (B2B)

FirstName

ans..100

M

First name

LastName

ans..100

M

Last name

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.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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 UserDataparameter instead.

Common notes:

• Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.

• Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Key

Format

CND

Description

ArticleList.name

ans..64

M

Article Name

ArticleList.description

ans..64

M

Article description

ArticleList.id

ans..128

M

Article ID

ArticleList.imageUrl

n..8

O

Image URL of the Article

ArticleList.amount

ans..16

M

Gross price per article.

Please note, that values has to be specified with “.” as decimal separator.

ArticleList.quantity

ans..16

M

Net price per article.

Please note, that values has to be specified with “.” as decimal separator.

ArticleList.totalAmount

n..2

M

VAT in percent

ArticleList.vatPercent

ans..16

O

VAT as amount per item.

Please note, that values has to be specified with “.” as decimal separator.

ArticleList.vatAmount

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the installment payment in the Riverty portal. Limited to 100-1280px.

ArticleList.discount

ans..16

O

Discount amount (only for statistical purposes).

Please note, that values has to be specified with “.” as decimal separator.

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

INIT 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

an8

M

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

refnr

ans..30

O

Merchant’s unique reference number

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from Zinia, if agreed with Computop Helpdesk

ExternalCode

ans..64

O

Error code from Zinia, if agreed with Computop Helpdesk

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 to be captured

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

InvoiceID

ans..50

O

Invoice number

InvoiceUrl

ans..256

O

Invoice URL

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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

an8

M

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

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from Zinia, if agreed with Computop Helpdesk

ExternalCode

ans..64

O

Error code from Zinia, if agreed with Computop Helpdesk

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 to be credited

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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

an8

M

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

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from Zinia, if agreed with Computop Helpdesk

ExternalCode

ans..64

O

Error code from Zinia, if agreed with Computop Helpdesk

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 as well as for capture or credit request.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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

an8

M

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

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from Zinia, if agreed with Computop Helpdesk

ExternalCode

ans..64

O

Error code from Zinia, if agreed with Computop Helpdesk