Skip to end of metadata
Go to start of metadata


Terms and Definitions

Terms

Term

Definition

Transaction

A transaction consists of a number of linked messages. At its simplest a transaction will consist of a minimum of a request message and a response message.

Payment

A payment is the equivalent to a transaction in Paygate. During a payment lifecycle, the state of a transaction will change, depending on the performed action. These actions may include authorization, capture, sale, cancel and refund. A payment is thereby defined as a sequence of actions.

Action

An action is an operation that changes the status of a payment when performed successfully.


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.


Schematic overview

The following block diagram provides a high level process overview.


Process narrative

(1) ECR submits estimated amount and a Reference Number via OPI message protocol to the POI device

(2) POI device performs cardholder authentication, encrypts the PIN block and the PAN with the Computop encryption key and forwards the authorization request via SSL through a central proxy server to CCV acCEPT

(3) CCV acCEPT routes the transaction to Computop Paygate via VPN connection

(4) Paygate submits authorization request to the acquirer

(5) Authorization result are transferred via notification request

Please note that authorization and notification are two distinct asynchronous processes.


Notification request

Computop Paygate will submit a notification request via HTTP POST in order to transfer the authorization status and transaction details to the server URL as stored in the merchant configuration.

The request will be sent in real-time. If no response Paygate will retry the notification once after 2 seconds of the first submission. In case that the retry fails Merchant System may actively request the status of the transaction once the system is available again.

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

FormatCND

Description

Beschreibung
RefNrans..30MUnique reference numberEindeutige Referenznummer

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure)

OK oder AUTHORIZED (URLSuccess) sowie FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

FormatCND

Description

BeschreibungConfig
POSTerminalIDan..20MTerminal Identification Number assigned and linked to a specific point-of-sale (POS) terminalTerminal-Identifikationsnummer, die einem bestimmten POS-Terminal zugeordnet und damit verknüpft ist
MessageTypen2MMessage Type describing the performed action: 01=Sale, 02=Reversal, 03=Credit, 05=Authorisation/Reservation, 06=Incremental Authorisation, F0=AutoreversalDer Message Type beschreibt die ausgeführte Aktion: 01=Verkauf, 02=Storno, 03=Gutschrift, 05=Autorisierung/Reservierung, 06=Inkrementelle Autorisierung, F0=Autostorno
DMACKSNan..20MSerial Number of the key (DUKPT) that was used to generate the DMACSeriennummer des Schlüssels (DUKPT), der zum Erzeugen des DMAC verwendet wurde
DMACan16MMessage Authentication CodeNachrichten-Authentisierungscode
CodeExtan..10OOriginal code from external payment systemOriginaler Code vom externen Zahlungssystem
AQa..5OAcquirerAcquirerX
EMVDataan..2028OEMV DataEMV DatenX
CCNrn12..19OCredit card number at least 12-digit, numerical without spacesKreditkartennummer, mindestens 12 Ziffern ohne LeerzeichenX
PCNrn16O

Paygate card token

Paygate-Kartentoken

X
CCBranda..22OCredit card brand (e.g. Visa, MasterCard, Maestro etc.)

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

X
CCExpiryn6OCard expiry dateAblaufdatum der KarteX
MaskedPanan12..19MMasked card number (6X4)Maskierte Kartennummer (6X4)
IBANEMVfieldan..64CIBAN, hex-coded, only available with GirocardHEX-kodierte IBAN, nur für Girocard
baseAmountn..10MAmount in its smallest currency unit of merchant’s local currency at the Point of Sale (POS)Betrag in der kleinsten Währungseinheit der lokalen Währung des Händlers am Point of Sale (POS)
baseCurrencya3MMerchant’s local currency at the Point of Sale (POS)Lokale Währung des Händlers am Point of Sale (POS)
Amountn..10CAmount in its smallest currency unit of card currencyBetrag in der kleinsten Währungseinheit der Kartenwährung
Currencya3CCardholder’s currencyWährung des Karteninhabers
dccRateValueans13CApplicable FX rate with 4 decimal places (e.g. ‘3.0245’)Anwendbarer Wechselkurs mit 4 Dezimalstellen (z.B. ‘3.0245’)
schemeReferenceIDans..64CCard scheme specific transaction ID required for subsequent credential-on-file payments, delayed authorizations and resubmssions.Spezifische Transaktions-ID des Kartenschemas, die für nachfolgende Zahlungen mit gespeicherten Zugangsdaten, verzögerte Autorisierungen und Wiedereinreichungen erforderlich ist.

Notice: The parameters baseAmount, baseCurrency, and dccRateValue will be only present when DCC was used. In this case the Amount and the Currency parameter correspond to the foreign values. For transaction that have been carried out without DCC the parameter Amount will refer to the amount in the merchant's local currency as given in the parameter Currency.


References

Paygate supports two external references, TransID and RefNr. For POS environments the parameter TransID holds a unique identifier from CCV acCEPT. Thus, the merchant may submit a unique reference via RefNr to Computop Paygate.

For reconciliation purposes, Computop maps the parameter RefNr against suitable elements in the corresponding acquirer protocol in order to make sure that values are shown in the electronic merchant statements (e.g. EPA file). As RefNr is an optional element, Computop automatically reverts to the TransID if RefNr is not given in the request message.



Merchant may transfer his Reference Number in the OPI protocol to the acCEPT server. CCV will map this element against the Paygate parameter RefNr.

Please note that acquirers do have different size limits for references that can be submitted depending on the message protocol and host capabilities.

Acquirer

Protocol / Protokoll

Size limit / Größenlimit

ConCardis

GICC

30

JPMorgan Chase

ISO8583

22

American Express

GICC

30

AirPlusGICC30
WorldpayAPACS20


Status inquiry

In order to inquire about the status of a payment 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.

Key

Format

CND

Description

Beschreibung
RefNrans..30MMerchant’s unique reference number. Reference used at the Point of Sale (POS) Eindeutige Referenznummer des Händlers. Am Point of Sale (POS) verwendete Referenz.

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

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
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

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

Key

FormatCND

Description

BeschreibungConfig
LastStatusan32MPayment status which can be either of the following: AUTHORIZED, FAILED, CAPTURE_REQUEST, CREDIT_REQUEST, OK (=captured)Zahlungsstatus, der folgende Werte annehmen kann: AUTHORIZED, FAILED, CAPTURE_REQUEST, CREDIT_REQUEST, OK (=gebucht)
LastXCoden8OResponse code of the most recent payment actionAntwortcode der letzten ZahlungsaktionX
LastXAmountn..10OAmount of the most recent payment actionBetrag der letzten ZahlungsaktionX
XIDan32O

Identifier of the most recent payment action assigned by Paygate

Vom Paygate vergebene ID der letzten Zahlungsaktion

X
AmountAuthn..10MSum of authorized amountsSumme der autorisierten Beträge
AmountCapn..10MSum of captured amountsSumme der gebuchten Beträge
AmountCredn..10MSum of refunded amountsSumme der gutgeschriebenen Beträge
CCNrn12..19OCredit card number at least 12-digit, numerical without spacesKreditkartennummer, mindestens 12 Ziffern ohne LeerzeichenX
CCBranda..22O

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

Kreditkartenmarke (z.B. Visa, MasterCard, Maestro usw.)X
CCExpiryn6OCard expiry dateAblaufdatum der KarteX
MaskedPanan12..19MMasked card number (6X4)Maskierte Kartennummer (6X4)
IBANEMVfieldan..64CIBAN, hex-coded, only available with GirocardHEX-kodierte IBAN, nur für Girocard
baseAmountn..10CAmount in its smallest currency unit of merchant’s local currency at the Point of Sale (POS)Betrag in der kleinsten Währungseinheit der lokalen Währung des Händlers am Point of Sale (POS)
baseCurrencya3CMerchant’s local currency at the Point of Sale (POS)Lokale Währung des Händlers am Point of Sale (POS)
dccRateValueans13CApplicable FX rate with 4 decimal places (e.g. ‘3.0245’)Anwendbarer Wechselkurs mit 4 Dezimalstellen (z.B. ‘3.0245’)
schemeReferenceIDans..64CCard scheme specific transaction ID required for subsequent credential-on-file payments, delayed authorizations and resubmssions.Spezifische Transaktions-ID des Kartenschemas, die für nachfolgende Zahlungen mit gespeicherten Zugangsdaten, verzögerte Autorisierungen und Wiedereinreichungen erforderlich ist.

Notice: The parameter baseAmount, baseCurrency and dccRateValue will be only present when DCC was used. In this case AmountAuth, AmountCap and AmountCred are given in the cardholder's currency. For transaction that have been carried out without DCC all Amounts refer the merchant's local currency.


Code Listings

Brands

Code

Brand / Kartenmarke

VISA

Visa

MasterCard

MasterCard

Maestro

Maestro

AMEXAmerican Express
DinersDiners Club
DiscoverDiscover
AirPlusAirPlus Corporate Accounts (UATP)

Acquirer

Code

Acquirer

CON

Concardis

CHASE

Chase Paymentech

AME

American Express

AIRAirPlus
WLPWorldpay