iCard

Logo

Info

iCard

Type

Payments by Credit Card

Key

Format

CND

Description

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

CustomerID

ans..255

O

Customer access data on the merchant’s checkout page (email, ID, telephone number or name)

OrderDesc

ans..768

O

Description of purchased goods, unit prices etc.

RTF

a1

O

for repeat payments (subscriptions): I = Initial payment of a new subscriptionR = Routine payment (Recurring)

Key

Format

CND

Description

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

ErrorText

ans..

OC

Error text from iCard, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant.

CodeExt

n..3

OC

Error code from iCard, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant.

ApprovalCode

ans..6

O

ApprovalCode or Authorisation code returned by card issuer

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.

RefNr

"referenceNumber": "..."

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, for CardComplete in the format an..25, for Cofidis in the format n..15, for Omnipay in the format ns..15, for RBI in the format ns..20)

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

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)

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.

FinishAuth

"finishAuth": "..."

a1

C

Only with ETM: Transmit value <Y> in order to stop the renewal of guaranteed authorisations and rest amounts after partial captures. Please use this parameter only if you are using the additional function ETM (Extended Transactions Managament). (not with Clearhaus)

Textfeld1

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

ans..30

O

Card holder information: Name (not with Clearhaus)

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

Textfeld2

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

ans..30

O

Card holder information: City (not with Clearhaus)

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

CHDesc

–––

ans..22

OC

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

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": "..."

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, for CardComplete in the format an..25, for Cofidis in the format n..15, for Omnipay in the format ns..15, for RBI in the format ns..20)

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

Amount

"amountValue": "..."

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

"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

GuWID

"wirecardTransactionId": "..."

ans..22

O

Only with Wirecard: TransactionID of the Acquiring Bank

TID

"cofidisTransactionId": "..."

n..15

M

Only with Cofidis: If RefNr was submitted, it's value will be returned. Otherwise the first 15 digits of TransactionID will be returned.

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

RefNr

"referenceNumber": "..."

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

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)

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.

ApprovalCode

ans..6

M

taken from the original authorization

JSON object

captureinfo

ans..1024

M

New parameter for multiple partial captures. This parameter must be created in JSON format.

The individual parameters in JSON format are following:

curIdx (M) - format: n..2 – Unique ID for this particular capture - Needed for a refund of this exact capture,

total (M) - format: n..2 – Multiple Capture Sequence Count – maximum number of captures per authorisation - possible values 1-99

final (M) - format: an..3 – Final capture flag

"no" – Not last capture

"yes" – Last capture – After sending a "yes", no more captures are possible!

This is an example of the JSON that can be used. Important: captureinfo=Base64-JSON (base64 encoded)

1
{
2
    "$schema": "http://json-schema.org/draft-07/schema#",
3
    "$id": "https://www.computop-paygate.com/schemas/captureInfo.json",
4
    "title": "captureInfo",
5
    "examples": [
6
        // usage: capture=manual|auto|<nn>|Base64-JSON
7
        {
8
            "auto": "yes"
9
        },
10
        {
11
            "manual": {
12
                "final": "no"
13
            }
14
        },
15
        {
16
            "manual": {
17
                "final": "no",
18
                "total": 3
19
            }
20
        },
21
        {
22
            "manual": {
23
                "final": "yes"
24
            }
25
        },
26
        {
27
            "manual": {
28
                "final": "yes",
29
                "curIdx": 2,
30
                "total": 3
31
            }
32
        },
33
        {
34
            "manual": {
35
                "final": "yes",
36
                "total": 3
37
            }
38
        },
39
        {
40
            "delayed": {
41
                "hours": 30
42
            }
43
        }
44
    ],
45
    "description": "captureInfo",
46
    "properties": {
47
        "auto": {
48
            "type": "string",
49
            "enum": [
50
                "yes"
51
            ],
52
            "additionalProperties": false
53
        },
54
        "manual": {
55
            "type": "object",
56
            "properties": {
57
                "final": {
58
                    "type": "string",
59
                    "enum": [
60
                        "yes",
61
                        "no"
62
                    ]
63
                },
64
                "total": {
65
                    "type": "integer",
66
                    "minimum": 1,
67
                    "maximum": 99
68
                },
69
                "curIdx": {
70
                    "type": "integer",
71
                    "minimum": 1,
72
                    "maximum": 99
73
                }
74
            },
75
            "required": [
76
                "final"
77
            ],
78
            "additionalProperties": false
79
        },
80
        "delayed": {
81
            "type": "object",
82
            "properties": {
83
                "hours": {
84
                    "type": "integer",
85
                    "minimum": 1,
86
                    "maximum": 99
87
                }
88
            },
89
            "required": [
90
                "hours"
91
            ],
92
            "additionalProperties": false
93
        }
94
    },
95
    "oneOf": [
96
        {
97
            "required": [
98
                "manual"
99
            ]
100
        },
101
        {
102
            "required": [
103
                "delayed"
104
            ]
105
        },
106
        {
107
            "required": [
108
                "auto"
109
            ]
110
        }
111
    ],
112
    "additionalProperties": false
113
}

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

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": "..."

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

original_trn

n20

M

TRN of the original transaction

ApprovalCode

ans..6

M

taken from the original authorization

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": "..."

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

Notice: For CAPN multiple partial credits on the same day are allowed. Please note, that for each partial credit a seperate unique RefNr is required.

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

OrderDesc

"orderDescription": "..."

ans..768

O

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

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.

Textfeld1

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

ans..30

O

Card holder information: Name (not with Clearhaus)

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

Textfeld2

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

ans..30

O

Card holder information: City (not with Clearhaus)

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

CHDesc

–––

ans..22

OC

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

TID

"safeChargeTransactionId": "..."

ans..30

OC

Only with SafeCharge: TransaktioncID of the capture to be credited, if the merchants wants to credit a specifc capture. If the parameter is nut submitted the last capture will be credited.

Additional parameters for Wirecard connection (for Visa Direct)

refundType

"wirecardConnection": { "refundType": "p2p"}

"wirecardConnection": { "refundType": "md"}

"wirecardConnection": { "refundType": "acc2acc"}

"wirecardConnection": { "refundType": "ccBill"}

"wirecardConnection": { "refundType": "fd"}

enum

C

Type of refund. Possible values: “p2p”, “md”, “acc2acc”. “ccBill”, “fd”

receiverFirstName

"wirecardConnection": {"receiver": { "firstName": "..." }}

an..12

C

First name of the receiver. Mandatory for cross-border transactions.

receiverLastName

"wirecardConnection": {"receiver": { "lastName": "..." }}

an..12

C

Last name of the receiver. Mandatory for cross-border transactions.

senderAccountNumber

"wirecardConnection": {"sender": { "accountNumber": "..." }}

n..12

C

Account number of the sender.

Mastercard: Mandatory. Visa: Mandatory, if RefNr is empty.

senderFirstName

"wirecardConnection": {"sender": { "firstName": "..." }}

an..12

C

First name of the sender.

Mastercard: Mandatory. Visa: Mandatory for US domestic transactions and cross-border money transfers.

senderLastName

"wirecardConnection": {"sender": { "lastName": "..." }}

an..12

C

Last name of the sender.

Mastercard: Mandatory. Visa: Optional.

senderAddrStreet

"wirecardConnection": {"sender": { "street": "..." }}

an..25

C

Street name of the sender.

Mastercard: Optional. Visa: Mandatory for US domestic transactions and cross-border money transfers.

senderAddrStreetNr

"wirecardConnection": {"sender": { "streetNumber": "..." }}

an..25

C

Street number of the sender.

Mastercard: Optional. Visa: Mandatory for US domestic transactions and cross-border money transfers.

senderAddrCity

"wirecardConnection": {"sender": { "city": "..." }}

an..32

C

Town/city of the sender.

Mastercard: Optional. Visa: Mandatory for US domestic transactions and cross-border money transfers.

senderAddrState

"wirecardConnection": {"sender": { "stateCode": "..." }}

a2

C

State of the sender.

Mastercard: Mandatory, if senderAddrCountry=US or Canada. Visa: Mandatory for US domestic transactions and cross-border money transfers.

senderAddrCountry

"wirecardConnection": {"sender": { "countryCode": "..." }}

a2

C

Country of the sender.

Mastercard: Optional. Visa: Mandatory if country is US and for cross-border money transfers.

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

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)

Aid

"authorizationId": "..."

n6

OC

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

RefNr

"referenceNumber": "..."

an..25

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

Amount

"amountValue": "..."

n..10

O

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

"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

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

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": "..."

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

ApprovalCode

ans..6

M

taken from the original authorization

XID

"xId": "..."

ans..32

m

XID of the capture to be credited, taken from the capture response

OrderDesc

"orderDescription": "..."

ans..768

O

Description of refunded goods, unit prices, merchant’s comment etc.

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.

JSON object

captureinfo

ans..1024

M

Parameter needed to refund a specific MPC capture. This parameter must be created in JSON format.

curIdx (M) – format: n..2 – Unique ID for this particular capture

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

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": "..."

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

ApprovalCode

ans..6

M

taken from the original authorization

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)

OrderDesc

ans..768

O

Description of refunded goods, unit prices, merchant’s comment etc.

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

Textfeld1

ans..30

O

Card holder information: Name

Textfeld2

ans..30

O

Card holder information: City

TransactionID

an..150

M

Additional reference number

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)

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

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

Amount

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

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent) – the actual still authorized amount you wish to release

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": "..."

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

XID

"xId": "..."

ans..32

M

XID of the authorization to be reversed, taken from the authorization response

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

Status

"status": "OK"

"status": "FAILED"

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

"code": ...

an8

M

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

RefNr

"referenceNumber": "..."

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

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)