Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation

Table of Contents


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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
. 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.


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Schematic overview

The following block diagram provides a high level process overview.


Multiexcerpt
MultiExcerptNameimg_schematic
shouldDisplayInlineCommentsInIncludesfalse

Image Modified

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
via VPN connection

(4) Paygate  

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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.

Parameter

FormatConditionConfig

Description

MID

ans..30M

MerchantID, assigned by Computop

PayID

an32M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32M

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

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623403576706_1705504988
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamenotification_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623403576718_-976239833
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

FormatCND

Description

Beschreibung
TransIDans..64MUnique transaction identifier supplied by CCV acCEPT
RefNrans..30MUnique reference numberEindeutige Referenznummer

Table Excerpt Include
statictrue
nameStatus

a..50M

Payment status which can be either of the following:

•       AUTHORIZED

•       FAILED

•       OK (= Captured)

Descriptionans..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! For automated payment processing please always use the code parameter.

pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

FormatCND

Description

BeschreibungConfig
Coden8MError code according to Paygate Response Codes (A4 Error codes)MACan64MHash Message Authentication Code (HMAC) with SHA-256 algorithm
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..10O
X
Original code from external payment systemOriginaler Code vom externen Zahlungssystem
AQa..5O
X
AcquirerAcquirerX
EMVDataan..2028O
X
EMV DataEMV
Data
DatenX
CCNrn12..19O
X
Credit card number at least 12-digit, numerical without spacesKreditkartennummer, mindestens 12 Ziffern ohne LeerzeichenX
PCNrn16O
XPaygate card token

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
card token

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePlatform-Kurz
PageWithExcerptDE:Wording
-Kartentoken

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

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

X
CCExpiryn6O
X
Card 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.
FormFactorans..64O

Defines the form / device which has been used for payment.

Currently possible values:

  • Card
  • Mobile Device
  • Watch / Wristband

Definiert das Gerät, das zur Zahlung verwendet wurde.

Derzeit mögliche Werte:

  • Card
  • Mobile Device
  • Watch / Wristband

Devicean..20OSerial number of POS deviceSeriennummer des POS-Terminals

Table Excerpt Include
statictrue
nameTransactionId
pageTransactionId
typepage

Key

FormatCND

Description

Beschreibung
VUNran..12OContract partner numberVertragspartnernummer
ApprovalCodean..6OAuthorising code of transactionAutorisierungscode der Transaktion
additionalresponsedataan..128OAdditional text which the operator’s processing system can send optionally in replies to payment/cutover requests.Zusätzlicher Text, den das Verarbeitungssystem des Betreibers optional als Antwort auf Zahlungs-/Umstellungsanforderungen senden kann.
TerminalIDa..20OID of the terminalID des Terminals
IBANan..34OInternational Bank Account NumberInternational Bank Account Number
TrxTimeans21OTime stamp of transaction in the format dd.MM.yyyy HH:mm:ssffZeitstempel der Transaktion im Format TT.MM.JJJJ HH:mm:ssff

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
.

For reconciliation purposes, Computop

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
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
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
automatically reverts to the TransID if RefNr is not given in the request message.


Multiexcerpt
MultiExcerptNameimg_references
shouldDisplayInlineCommentsInIncludesfalse

Image Modified


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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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.

Multiexcerpt
MultiExcerptNamereferences_acquirer

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:

https://www.computop-paygate.com/getStatus.aspx

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

The following table describes the encrypted request parameters:

Parameter

Format

CND

Description

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
getStatus.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623404987798_1056203061
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamestatus_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623404987799_-1881547046
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Key

Format

CND

Description

Beschreibung

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
RefNrans..30MMerchant’s unique reference number. Reference used at the Point of Sale (POS) 
MACan64MHash Message Authentication Code (HMAC) with SHA-256 algorithm
Eindeutige Referenznummer des Händlers. Am Point of Sale (POS) verwendete Referenz.

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Parameters for status inquiries via socket connections

The following table describes the Paygate response parameters:

Parameter

FormatConditionConfig

Description

MID

ans..30M

MerchantID, assigned by Computop

PayID

an32M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

Statusa..50MOK or FAILEDDescriptionans..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!Coden8MError code according to Paygate Response Codes (A4 Error codes)


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623405159667_1913448944
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamestatus_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623405159669_933232196
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

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)
LastXCoden8O
X
Response code of the most recent payment actionAntwortcode der letzten ZahlungsaktionX
LastXAmountn..10O
X
Amount of the most recent payment actionBetrag der letzten ZahlungsaktionX
XIDan32O
X

Identifier of the most recent payment action assigned by

Paygate

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording

Vom

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePlatform-Kurz
PageWithExcerptDE:Wording
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..19O
X
Credit card number at least 12-digit, numerical without spacesKreditkartennummer, mindestens 12 Ziffern ohne LeerzeichenX
CCBranda..22O
X

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

Returned only after configuration by Merchant Services (helpdesk@computop.com).
Kreditkartenmarke (z.B. Visa, MasterCard, Maestro usw.)X
CCExpiryn6O
X
Card 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

Multiexcerpt
MultiExcerptNamebrands

Code

Brand / Kartenmarke

VISA

Visa

MasterCard

MasterCard

Maestro

Maestro

AMEXAmerican Express
DinersDiners Club
DiscoverDiscover
AirPlusAirPlus Corporate Accounts (UATP)

Acquirer

Multiexcerpt
MultiExcerptNameacquirer

Code

Acquirer

CON

Concardis

CHASE

Chase Paymentech

AME

American Express

AIRAirPlus
WLPWorldpay