Skip to end of metadata
Go to start of metadata


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

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


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

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

C

conditional

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


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


Status inquiries via socket connections

Status inquiries based on PayID

Status inquiries within Paygate give detailed information about the amounts that are actually authorized, captured or credited. Especially before executing reversals via the interface reverse.aspx it is recommended to check the transaction status with inquire.aspx, because Reverse.aspx reverses not only authorizations but ALWAYS THE LAST TRANSACTION STEP.

Inquiries of transaction status based on PayID are possible via a Server-to-Server connection. In order to inquire about the status of a transaction via a Server-to-Server connection, please use the following URL:


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

The following table describes the encrypted payment request parameters:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Parameters for status inquiries via socket connections

 

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

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

Status

a..50

M

OK or FAILED as status of inquiry and not of the requested transaction

OK oder FAILED als Status der Abfrage, nicht der angefragten Transaktion
Descriptiona,s..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! It relates to the inquiry and not to the requested transaction.Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus! Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.
Coden8MError code according to Paygate Response Codes (A4 Error codes). It relates to the inquiry and not to the requested transaction.
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes). Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.

Key

Format

CND

Description

Beschreibung

AmountAuth

n..10

O

Approved amount

Genehmigter Betrag

AmountCap

n..10

O

Captured amount

Gebuchter Betrag

AmountCred

n..10

O

Credited amount

Gutgeschriebener Betrag
Currencya3OCurrency code, three digits DIN / ISO 4217. For payment types that don´t have the "Currency" parameter nothing will be returned.Währungskürzel, drei Zeichen DIN / ISO 4217. Für Zahlungsarten ohne Parameter "Currency" wird nichts zurückgegeben.

LastStatus

a..50

O

Status of last transaction (Authorisation, Capture or Credit)

Status der letzten Transaktion (Autorisierung, Buchung oder Gutschrift)

Response parameters in the case of status inquiries via socket connections

 

Notice: The LastStatus parameter is not sufficient to determine the status because it supplies the status of only the last transaction. For example LastStatus delivers the status Failed if a credit has failed although the previous authorisation and capture were successful. The fields AmountAuth, AmountCap and AmountCred give the precise status.



Status inquiries based on TransID

Inquiries of transaction status based on TransID are possible via a Server-to-Server connection. In order to inquire about the status of a transaction via a Server-to-Server connection, please use the following URL:


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

The following table describes the encrypted payment request parameters:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Parameters for status inquiries via socket connections


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

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

Status

a..50

M

OK or FAILED as status of inquiry and not of the requested transaction

OK oder FAILED als Status der Abfrage, nicht der angefragten Transaktion
Descriptiona,s..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! It relates to the inquiry and not to the requested transaction.Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus! Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.
Coden8MError code according to Paygate Response Codes (A4 Error codes). It relates to the inquiry and not to the requested transaction.
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes). Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.

Key

Format

CND

Description

Beschreibung

AmountAuth

n..10

O

Approved amount

Genehmigter Betrag

AmountCap

n..10

O

Captured amount

Gebuchter Betrag

AmountCred

n..10

O

Credited amount

Gutgeschriebener Betrag
Currencya3OCurrency code, three digits DIN / ISO 4217. For payment types that don´t have the "Currency" parameter nothing will be returned.Währungskürzel, drei Zeichen DIN / ISO 4217. Für Zahlungsarten ohne Parameter "Currency" wird nichts zurückgegeben.

LastStatus

a..50

O

Status of last transaction (Authorisation, Capture or Credit)

Status der letzten Transaktion (Autorisierung, Buchung oder Gutschrift)
LastXCoden8O

Error code of last transaction according to Paygate Response Codes (A4 Error codes)

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

LastXAmountn..10OAmount in the smallest currency unit (e.g. EUR Cent)Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)
CCBranda..22O

Credit card brand (e.g. Visa, MasterCard, Maestro etc.)

Returned only after configuration by Merchant Services (Computop Helpdesk).

Kreditkartenmarke (z.B. Visa, MasterCard, Maestro usw.)

Rückgabe nur nach Konfiguration durch Merchant Services (Computop Helpdesk).

Response parameters in the case of status inquiries via socket connections

 

Notice: The LastStatus parameter is not sufficient to determine the status because it supplies the status of only the last transaction. For example LastStatus delivers the status Failed if a credit has failed although the previous authorisation and capture were successful. The fields AmountAuth, AmountCap and AmountCred give the precise status.