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

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

. 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

SpaceWithExcerpt	EN
MultiExcerptName	Definition
PageWithExcerpt	Definition EN

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

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

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Name
PageWithExcerpt	Wording

via VPN connection

(4) Paygate

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

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

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Name
PageWithExcerpt	Wording

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

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

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

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1623403576706_1705504988
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	notification_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1623403576718_-976239833
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	MID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Key				Format	CND	Config	Description	Beschreibung

TransIDans..64MUnique transaction identifier supplied by CCV acCEPT


RefNr				ans..30	M		Unique reference number	Eindeutige Referenznummer

Table Excerpt Include

static	true
name	Status
page	Status

a..50M

Payment status which can be either of the following:

• AUTHORIZED

• FAILED

• OK (= Captured)


type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key				Format	CND	Config	Description	Beschreibung

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.Coden8MError code according to Paygate Response Codes (A4 Error codes)MACan64MHash Message Authentication Code (HMAC) with SHA-256 algorithm


POSTerminalID	an..20	M		Terminal Identification Number assigned and linked to a specific point-of-sale (POS) terminal	Terminal-Identifikationsnummer, die einem bestimmten POS-Terminal zugeordnet und damit verknüpft ist
MessageType	n2	M		Message Type describing the performed action: 01=Sale, 02=Reversal, 03=Credit	Der Message Type beschreibt die ausgeführte Aktion: 01=Verkauf, 02=Storno, 03=Gutschrift
DMACKSN	an..20	M		Serial Number of the key (DUKPT) that was used to generate the DMAC	Seriennummer des Schlüssels (DUKPT), der zum Erzeugen des DMAC verwendet wurde
DMAC	an16	M		Message Authentication Code	Nachrichten-Authentisierungscode
CodeExt	an..10	O	X	Original code from external payment system	Originaler Code vom externen Zahlungssystem
AQ	a..5	O	X	Acquirer	Acquirer
EMVData	an..2028	O	X	EMV Data	EMV Daten
CCNr	n12..19	O	X	Credit card number at least 12-digit, numerical without spaces	Kreditkartennummer, mindestens 12 Ziffern ohne Leerzeichen
PCNr	n16	O	X

Paygate card token

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

card token

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Platform-Kurz
PageWithExcerpt	DE:Wording

-Kartentoken

CCBrand

a..22

O

X

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

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

CCExpiry

n6

O

X

Card expiry date

Ablaufdatum der Karte

MaskedPan

an12..19

M

Masked card number (6X4)

Maskierte Kartennummer (6X4)

baseAmount

n..10

M

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

baseCurrency

a3

M

Merchant’s local currency at the Point of Sale (POS)

Lokale Währung des Händlers am Point of Sale (POS)

Amount

n..10

C

Amount in its smallest currency unit of card currency

Betrag in der kleinsten Währungseinheit der Kartenwährung

Currency

a3

C

Cardholder’s currency

Währung des Karteninhabers

dccRateValue

ans13

C

Applicable FX rate with 4 decimal places (e.g. ‘3.0245’)

Anwendbarer Wechselkurs mit 4 Dezimalstellen (z.B. ‘3.0245’)

schemeReferenceID

ans..64

C

Card 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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

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

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Name
PageWithExcerpt	Wording

.

For reconciliation purposes, Computop

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

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

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

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

MultiExcerptName	references_acquirer

Acquirer	Protocol / Protokoll	Size limit / Größenlimit
ConCardis	GICC	30
JPMorgan Chase	ISO8583	22
American Express	GICC	30
AirPlus	GICC	30
Worldpay	APACS	20

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

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

getStatus.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1623404987798_1056203061
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	status_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1623404987799_-1881547046
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Key	Format	CND	Description	Beschreibung

MerchantID

ans..30

M

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


RefNr	ans..30	M	Merchant’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

static	true
name	MAC
page	MAC
type	page

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

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1623405159667_1913448944
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	status_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1623405159669_933232196
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	MID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Key	Format	CND	Config	Description	Beschreibung
LastStatus	an32	M		Payment 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)
LastXCode	n8	O	X	Response code of the most recent payment action	Antwortcode der letzten Zahlungsaktion
LastXAmount	n..10	O	X	Amount of the most recent payment action	Betrag der letzten Zahlungsaktion
XID	an32	O	X	Identifier of the most recent payment action assigned by

Paygate

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

Vom

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Platform-Kurz
PageWithExcerpt	DE:Wording

vergebene ID der letzten Zahlungsaktion

AmountAuth

n..10

M

Sum of authorized amounts

Summe der autorisierten Beträge

AmountCap

n..10

M

Sum of captured amounts

Summe der gebuchten Beträge

AmountCred

n..10

M

Sum of refunded amounts

Summe der gutgeschriebenen Beträge

CCNr

n12..19

O

X

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

Kreditkartennummer, mindestens 12 Ziffern ohne Leerzeichen

CCBrand

a..22

O

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.)
CCExpiry	n6	O	X	Card expiry date	Ablaufdatum der Karte
MaskedPan	an12..19	M		Masked card number (6X4)	Maskierte Kartennummer (6X4)
baseAmount	n..10	C		Amount 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)
baseCurrency	a3	C		Merchant’s local currency at the Point of Sale (POS)	Lokale Währung des Händlers am Point of Sale (POS)
dccRateValue	ans13	C		Applicable FX rate with 4 decimal places (e.g. ‘3.0245’)	Anwendbarer Wechselkurs mit 4 Dezimalstellen (z.B. ‘3.0245’)
schemeReferenceID	ans..64	C		Card 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

MultiExcerptName	brands

Code				Brand / Kartenmarke
VISA				Visa
MasterCard				MasterCard
Maestro				Maestro
AMEX				American Express
Diners				Diners Club
Discover				Discover
AirPlus				AirPlus Corporate Accounts (UATP)

Acquirer

Multiexcerpt

MultiExcerptName	acquirer

Code				Acquirer
CON				Concardis
CHASE				Chase Paymentech
AME				American Express
AIR				AirPlus
WLP				Worldpay

Space shortcuts

Page tree

Versions Compared

Old Version 1

New Version 2

Key

Terms and Definitions

Terms

Schematic overview

Process narrative

Notification request

References

Status inquiry

Code Listings

Brands

Acquirer

Paygate

Computop

Help

Intranet Tools

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 1

New Version 2

Key

Terms and Definitions

Terms

Schematic overview

Process narrative

Notification request

References

Status inquiry

Code Listings

Brands

Acquirer