Kreditkarten - Buchung / Gutschrift / Storno / PayNow / Batch

MerchantID

BasicAuth.Username

ans..30

M

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

TransID

"transactionId": "..."

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

RefNr

"referenceNumber": "..."

ns..30

C

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

nicht bei EVO Payments, bei CardComplete im Format an..25, bei Cofidis im Format n..15, bei Omnipay im Format ns..15, bei RBI im Format ns..20)

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

Amount

"amount": { "value": ...}

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

"amount": { "currency": "..."}

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

• HMAC-Authentisierung (Anfrage)

• HMAC-Authentisierung (Notify)

ReqId

"requestId": "..."

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

FinishAuth

"finishAuth": "..."

a1

C

Nur bei ETM: Übergeben Sie den Wert <Y>, um bei Teilbuchungen die Autorisierungserneuerung oder die Reservierung des Restbetrages zu stoppen. Bitte nutzen Sie den Parameter nur, wenn Sie die Zusatzfunktion ETM (Erweitertes Transaktions-Managament) nutzen. (Nicht bei Clearhaus)

Textfeld1

"cardHolder": { "name": "..."}

ans..30

O

Karteninhaber-Information: Name (Nicht bei Clearhaus)

Für Banksys: Name des Händlers.Bei VISA-Transaktionen sind bis zu 25 Zeichen erlaubt, bei MasterCard nur bis zu 22.

Textfeld2

"cardHolder": { "city": "..."}

ans..30

O

Karteninhaber-Information: Ort (Nicht bei Clearhaus)

Für Banksys: Ort des Händlers. Der Wert wird nach 13 Zeichen abgeschnitten.

CHDesc

–––

ans..22

OC

Nur bei Clearhaus: Text, der auf der Kreditkartenabrechnung angezeigt wird. Nur ASCII druckbare Zeichen von 0x20 bis 0x7E

mid

"merchantId": "..."

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

XID

"xId": "..."

an32

M

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

TransID

"transactionId": "..."

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

Description

"description": "..."

ans..1024

M

Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

Code

"code": ...

an8

M

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

"referenceNumber": "..."

ns..30

C

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

nicht bei EVO Payments, bei CardComplete im Format an..25, bei Cofidis im Format n..15, bei Omnipay im Format ns..15, bei RBI im Format ns..20)

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

Aid

"authorizationId": "..."

n6

OC

Nur bei Card Complete: von Card Complete zurückgegebene Autorisierungs-ID

Amount

"amountValue": "..."

n..10

OC

Nur bei Clearhaus: Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Sollte der tatsächliche Betrag vom angefragten Betrag abweichen, wird dieser zurückgegeben.

CodeExt

"externalErrorCode": "..."

n5

OC

Nur bei Clearhaus: Nur wenn konfiguriert: externer Fehlercode (nachgelagertes System).

ErrorText

"errorText": "..."

ans.128

OC

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit Computop Helpdesk möglich.

TransactionID

"clearhausTransactionId": "..."

ans36

OC

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

TID

"cofidisTransactionId": "..."

n..15

M

Nur bei Cofidis: Wenn RefNr übergeben wurde, wird dieser Wert zurückgegeben. Anderenfalls werden die ersten 15 Stellen der TransactionID zurückgegeben.

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

Please note for some connections the different formats that are given within the specific parameters.

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)

RefNr

ns..30

C

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

(not with EVO Payments, Only for CardComplete, for Clearhaus (ns..30, optional, only printable ASCII characters from 0x20 to 0x7E), for RBI (ns..20, optional), for Cofidis (n..15, optional).)

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

OrderDesc

ans..768

O

Description of refunded goods, unit prices, merchant’s comment etc. (not with Clearhaus)

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.

CCNr

n..19

M

Credit card number for credit card payments. 

It can be filled:

• either with the real credit card number (PAN)

• or with the pseudo card number that you have received previously in a Paygate response in parameter PCNr.

With 3-D Secure 2.x the CCNr (PAN or PCNr) is sent as card.JSON.

We recommend to use "Hosted Payment Page" or Credit Card Form (paySSL) for simplified PCI DSS certification and usage of PCNr.

CCCVC

n..4

O

Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express.

CCExpiry

n6

M

Expiry date of the credit card in the format YYYYMM, e.g. 202507

CCBrand

a..22

M

Credit card brand.

Please note the spelling! According to table of credit card brands!

UserData

ans..1024

OC

Only with Clearhaus: If specified at request, Paygate forwards the parameter with the payment result to the shop.

Textfeld1

ans..30

O

Not with Clearhaus: Card holder information: Name

For Banksys: Name of merchant. For VISA transactions up to 25 characters are allowed, for MasterCard only up to 22.

Textfeld2

ans..30

O

Not with Clearhaus: Card holder information: City

For Banksys: City of merchant.The value is truncated after 13 characters.

CHDesc

ans..34

OC

Only with Clearhaus, format ans..22: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E

Only for Credorax: Text printed on the customer’s credit card bill.

This function must be enabled by Credorax and have the following structure.

1. merchant DBA name (up to 20 characters)

2. asterisk

3. additional text (up to 13 characters).

e.g. Computop*Test

This value can be alternatively permanently defined by Computop Helpdesk

CreditCardHolder

an..255

MC

Only with Credorax, ECPCC: Name of the card holder

Email

ans..64

MC

Only with Credorax, ECPCC: Email address of the customer

IPAddr

ans..15

OC

Only with Credorax, ECPCC: Customer´s IP address

PaymentOfWinnings

ans..4

OC

In the case of the acquirer EMS (Omnipay) the merchant can control CFT credit notes in this way.Transfer PaymentOfWinnings=True to credit a win rather than simply repaying a paid amount.

PaymentAddData

JSON

C

Only with Omnipay: Additional data if PaymentOfWinnings=True

TransactionID

an..150

M

Additional reference number

Further address parameters in case of ECPCC connection

DateOfBirth

n8

O

Date of birth of the customer in format YYYYMMDD

Phone

n..32

O

Customer’s phone number

FirstName

ans..255

M

First name of the customer

LastName

ans..255

M

Last name of the customer

AddrStreet

ans..255

O

Street name

AddressAddition

ans..255

O

Address c/o

AddrZip

an..9

O

Postcode

AddrCity

ans..255

O

City

AddrState

a2

O

Code of the customer’s Federal State

AddrCountryCode

a2

M

Country code according to ISO-3166-1, alphanumeric 2 chars

sdFirstName

ans..255

O

First name in the delivery address

sdLastName

ans..255

O

Surname in the delivery address

sdStreet

ans..255

O

Street name in the delivery address

sdAddressAddition

ans..255

O

Address addition in the delivery address

sdZIPCode

an..9

O

Postcode in the delivery address

sdCity

ans..255

O

Town/city in the delivery address

sdState

a2

O

Code of Federal State in the delivery address

sdCountryCode

a2

O

Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars

Further address parameters in case of Kalixa connection

IPAddr

ans..15

M

Customer´s IP address

BrowserSessionID

ans..64

M

Customer´s Session ID

CreditCardHolder

ans..100

M

Name of the card holder

CustomerID

an..20

M

Customer number: Number to identify the customer

Name

ans..100

C

User name of the customer

FirstName

ans..100

C

First name of the customer

LastName

ans..100

C

Last name of the customer

Email

ans..64

C

Email address of the customer

Language

a2

C

Language of the customer according to ISO, alphanumeric 2-digits

sdFirstName

ans..100

C

First name in the delivery address

sdLastName

ans..100

C

Surname in the delivery address

sdStreet

ans..200

C

Street name in the delivery address

sdStreetNr

ans..5

C

Street number in the delivery address

sdZIPCode

an..20

C

Postcode in the delivery address

sdCity

ans..40

C

Town/city in the delivery address

sdState

a2

C

Code of Federal State in the delivery address

sdCountryCode

a2

C

Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars

Further address parameters in case of Vantiv connection

bdFirstName

ans..25

O

First name in the invoicing address

bdLastName

ans..25

O

Last name in the invoicing address

bdStreet

ans..35

O

Street name in the invoicing address

Please note that bdStreet and bdStreetNr together may have 34 characters maximum.

bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters.

bdStreetNr

ans..35

O

Street number in the invoicing address

Please note that bdStreet and bdStreetNr together may have 34 characters maximum.

bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters.

bdStreet2

ans..35

O

Address addition in the billing address

bdZIPCode

ans..20

O

Postcode in the invoicing address

bdCity

ans..35

O

Town/city in the invoicing address

bdState

ans..30

O

State/country in the invoicing address

bdCountryCode

a2

O

Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars

bdMail

ans..100

O

Email address in the invoicing address

bdPhone

ans..20

O

Phone number in the invoicing address

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 which should be unique for each payment

Please note for some connections the different formats that are given within the specific parameters.

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)

AID

n6

OC

Only in the case of Card Complete: Authorisation ID returned by Card Complete

RefNr

an..25

OC

Only for Card Complete: If a RefNr has been transmitted, it is returned.

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

Amount

n..10

OC

Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent)

If the actual amount differs from the requested amount this will be returned.

CodeExt

n5

OC

Only with Clearhaus: Only if configured: External error code (downstream system)

ErrorText

ans..128

OC

Only with Clearhaus: Detailed Clearhaus error message.

Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk

UserData

ans..1024

OC

Only with Clearhaus: If specified at request, Paygate forwards the parameter with the payment result to the shop.

TransactionID

ans36

OC

Only with Clearhaus: Transaction number from Clearhaus

PaymentSenderReference

an..19

C

Only with Omnipay: Reference number generated by the Acquirer that will be used to identify the payment transaction. It can be returned for MasterCard Payment of winnings transactions when the required additional parameters are submitted in the request.

MerchantID

BasicAuth.Username

ans..30

M

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

PayID

"paymentId": "..."

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

"transactionId": "..."

ans..64

M

TransactionID which should be unique for each payment

Please note for some connections the different formats that are given within the specific parameters.

Amount

"amount": { "value": ...}

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

"amount": { "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)

RefNr

"referenceNumber": "..."

ans..30

OC

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

Only for Card Complete, for Clearhaus (ans..30, only printable ASCII characters from 0x20 to 0x7E).

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

ReqId

"requestId": "..."

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

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

PayID

"paymentId": "..."

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

"xId": "..."

an32

M

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

TransID

"transactionId": "..."

ans..64

M

TransactionID which should be unique for each payment

Please note for some connections the different formats that are given within the specific parameters.

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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!

Code

"code": ...

an8

M

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

RefNr

"referenceNumber": "..."

ans..30

OC

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

Only for Card Complete, for Clearhaus (ans..30, only printable ASCII characters from 0x20 to 0x7E).

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

AID

"authorizationId": "..."

n6

OC

Only in the case of Card Complete: Authorisation ID returned by Card Complete

CodeExt

"externalErrorCode": "..."

n5

OC

Only with Clearhaus: Only if configured: External error code (downstream system)

ErrorText

"errorText": "..."

ans.128

OC

Only with Clearhaus: Detailed Clearhaus error message.

Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk

TransactionID

"clearhausTransactionId": "..."

ans36

OC

Only with Clearhaus: Transaction number from Clearhaus

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

TransID for the identification of the payment process to be reversed

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

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)

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

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)

RefNr

ns..30

O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

Format must be mutually agreed beforehand with Computop Helpdesk!

CCNr

n..16

M

Credit card number at least 12-digit, numerical without spaces

CCCVC

n..4

O

Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express.

CCExpiry

n6

M

Expiry date of the credit card in the format YYYYMM, e.g. 201707

CCBrand

a..22

M

Credit card brand.

Please note the spelling! According to table of credit card brands!

Track2

ans..80

M

Hexadecimal data on track 2 of the credit card

Track3

ans..80

M

Hexadecimal data on track 3 of the credit card

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Capture

an..6

OM

Determines the type and time of capture.

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

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)

TID

n..20

M

Usually a nine-digit terminal number

AuthCode

ans..6

M

Acquiring Bank's authorisation code

Status

a..50

M

AUTHORIZED or FAILED. OK status applies only to Sale transactions.

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.

XID

an32

M

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

TransID

ans..64

M

ID of merchant for the identification of the payment process to be reversed

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Code

an8

M

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

Paygate-Formular

PayNow

payssl.aspx?MerchantID=[mid]&Len=[len]&Data=[data]

CCNr

n..19

M

Credit card number for credit card payments. 

It can be filled:

• either with the real credit card number (PAN)

• or with the pseudo card number that you have received previously in a Paygate response in parameter PCNr.

With 3-D Secure 2.x the CCNr (PAN or PCNr) is sent as card.JSON.

We recommend to use "Hosted Payment Page" or Credit Card Form (paySSL) for simplified PCI DSS certification and usage of PCNr.

CCCVC

n3

O

Card verification number: The last 3 digits on the signature strip of the credit card

CCExpiry

n6

M

Expiry date of the credit card in the format YYYYMM, e.g. 201807

CCBrand

a..22

M

Credit card brand.

Please note the spelling! According to table of credit card brands!

Action

Version

Description

Authorize

1.2 / 2.2

with textfeld1, textfeld2, RTF, cardholder, transactionID, schemeReferenceID

1.21 / 2.21

with textfeld1, textfeld2, RTF, approvalcode, cardholder, transactionID, schemeReferenceID

1.3 / 2.3

with CVC, transactionID, schemeReferenceID

1.5 / 2.5

with CVC, Zone

Capture

1.2 / 2.2

with textfeld1, textfeld2

1.21 / 2.21

with textfeld1, textfeld2, approvalcode

1.4 / 2.4

with stop of authorisation renewal (FinishAuth)

CaptureEx

1.3 / 2.3

with CVC

Credit

1.2 / 2.2

with textfeld1, textfeld2

1.21 / 2.21

with textfeld1, textfeld2

1.4 / 2.4

with stop of authorisation renewal (FinishAuth)

CreditEx

1.2 / 2.2

with textfeld1, textfeld2

1.21 / 2.21

with textfeld1, textfeld2

1.3 / 2.3

with textfeld1, textfeld2

Sale

1.2 / 2.2

with textfeld1, textfeld2, RTF, cardholder, transactionID, schemeReferenceID

1.21 / 2.21

with textfeld1, textfeld2, RTF, approvalcode, cardholder, transactionID, schemeReferenceID

1.3 / 2.3

with CVC, textfeld1, textfeld2, transactionID, schemeReferenceID

1.5 / 2.5

with CVC, Zone

Reverse

1.x / 2.x

Standard version

Type

a..11

M

HEAD for Header, FOOT for Footer, CC for credit card

Action

a..20

M

The parameter Action defines the type of transaction:

Authorize (authorisation)

Capture

Sale

Credit

CreditEx (credit note without previous capture; please agree this with Computop Helpdesk beforehand)

Reverse (cancellation)

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

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 which should be unique for each payment.

Please note for some connections the different formats that are given within the specific parameters.

RefNr

ns..30

O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

OrderDesc

ans..127

O

Description of purchased goods, unit prices etc.

CCBrand

a..22

C

Credit card brand.

Please note the spelling! According to table of credit card brands!

CCNr

n..16

C

Credit card number at least 12-digit, numerical without spaces. You can optionally transmit also a pseudo card number (PCN)

PCNr

n16

O

Pseudo Card Number: Random number generated by Computop Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. The PCN can be used like a genuine card number for authorisation, capture and credits.

PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON

CCExpiry

n6

OC

Optional in combination with PCNr: Expiry date of the credit card in the format YYYYMM (202207)

CCCVC

n..4

O

Card verification number in Version 1.3: In the case of Visa and MasterCard the last 3 numbers on the signature strip of the credit card. 4 numbers in the case of American Express.

FinishAuth

ans1

O

Version=1.4: If using the authorisation renewal, cancel repeat with the value Y in the field FinishAuth in the case of Capture or Credit. Example: You capture a partial delivery. The rest of the order cannot be supplied. You therefore enter Y in the FinishAuth field for Part-capture so that the Paygate does not authorise the remaining amount. Please note for this also the following section about Cancel authorisation renewals.

Action

a..20

M

The parameter Action defines the type of transaction like capture or credit – see above.

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.

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Code

an8

M

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

PCNr

n16

O

Pseudo Card Number: Random number generated by Computop Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. The PCN can be used like a genuine card number for authorisation, capture and credits.

PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON

CC,Capture,5,EUR,BestNr.0815,Rg.Nr.5180,a86dga4310d24453acd6f8a3112a769,y