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.

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

FormatCND

Description

RefNrans..30MUnique reference number

KeyFormatCNDDescription
Status

a..50

M

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

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

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription

MAC

an64

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

Key

FormatCND

Description

POSTerminalIDan..20MTerminal Identification Number assigned and linked to a specific point-of-sale (POS) terminal
MessageTypen2MMessage Type describing the performed action: 01=Sale, 02=Reversal, 03=Credit, 05=Authorisation/Reservation, 06=Incremental Authorisation, F0=Autoreversal
DMACKSNan..20MSerial Number of the key (DUKPT) that was used to generate the DMAC
DMACan16MMessage Authentication Code
CodeExtan..10OOriginal code from external payment system
AQa..5OAcquirer
EMVDataan..2028OEMV Data
CCNrn12..19OCredit card number at least 12-digit, numerical without spaces
PCNrn16O

Paygate card token

CCBranda..22OCredit card brand (e.g. Visa, MasterCard, Maestro etc.)
CCExpiryn6OCard expiry date
MaskedPanan12..19MMasked card number (6X4)
IBANEMVfieldan..64CIBAN, hex-coded, only available with Girocard
baseAmountn..10MAmount in its smallest currency unit of merchant’s local currency at the Point of Sale (POS)
baseCurrencya3MMerchant’s local currency at the Point of Sale (POS)
Amountn..10CAmount in its smallest currency unit of card currency
Currencya3CCardholder’s currency
dccRateValueans13CApplicable FX rate with 4 decimal places (e.g. ‘3.0245’)
dccMarginans..5CDCC margin/markup percentage. Only present when DCC was used.
dccCommissionans..12CDCC commission percentage. Only present when DCC was used.
dccSourceans..32CExchange rate source (e.g., "REUTERS WHOLESALE INTERBANK"). Only present when DCC was used.
dccForeignAmountn..10CAmount in cardholder's foreign currency (smallest unit). Only present when DCC was used.
dccForeignCurrencyCoden3CISO 4217 numeric currency code of cardholder's currency. Only present when DCC was used.
schemeReferenceIDans..64CCard scheme specific transaction ID required for subsequent credential-on-file payments, delayed authorizations and resubmssions.
FormFactorans..64O

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

Currently possible values:

  • Card
  • Mobile Device
  • Watch / Wristband
Devicean..20OSerial number of POS device

KeyFormatCNDDescription
TransactionId

ans..64

C

Card scheme specific transaction ID required for subsequent credential-on-file payments, delayed authorizations and resubmissions.

Mandatory: CredentialOnFile – initial false – unscheduled MIT / recurring

TransactionId is a value used with 3DS1 payments. Pls. ensure that you are prepared for 3DS2 payments where schemeReferenceID is returned instead.

Key

FormatCND

Description

VUNran..12OContract partner number
ApprovalCodean..6OAuthorising code of transaction
additionalresponsedataan..128OAdditional text which the operator’s processing system can send optionally in replies to payment/cutover requests.
TerminalIDa..20OID of the terminal
IBANan..34OInternational Bank Account Number
TrxTimeans21OTime stamp of transaction in the format dd.MM.yyyy 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.

Notice: The parameters AQ, EMVData, CCNr, CCBrand, CCExpiry can be used only after only after configuration by Merchant Services (Computop Helpdesk).


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

Size limit

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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

Key

Format

CND

Description

RefNrans..30MMerchant’s unique reference number. Reference used at the Point of Sale (POS) 

KeyFormatCNDDescription

MAC

an64

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

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. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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

KeyFormatCNDDescription
Code

an8

M

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

Key

FormatCND

Description

LastStatusan32MPayment status which can be either of the following: AUTHORIZED, FAILED, CAPTURE_REQUEST, CREDIT_REQUEST, OK (=captured)
LastXCoden8OResponse code of the most recent payment action
LastXAmountn..10OAmount of the most recent payment action
XIDan32O

Identifier of the most recent payment action assigned by Paygate

AmountAuthn..10MSum of authorized amounts
AmountCapn..10MSum of captured amounts
AmountCredn..10MSum of refunded amounts
CCNrn12..19OCredit card number at least 12-digit, numerical without spaces
CCBranda..22O

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

CCExpiryn6OCard expiry date
MaskedPanan12..19MMasked card number (6X4)
IBANEMVfieldan..64CIBAN, hex-coded, only available with Girocard
baseAmountn..10CAmount in its smallest currency unit of merchant’s local currency at the Point of Sale (POS)
baseCurrencya3CMerchant’s local currency at the Point of Sale (POS)
dccRateValueans13CApplicable FX rate with 4 decimal places (e.g. ‘3.0245’)
schemeReferenceIDans..64CCard scheme specific transaction ID required for subsequent credential-on-file payments, delayed authorizations and resubmssions.
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.

Notice: The parameters LastXCode, LastXAmount, XID, CCNr, CCBrand, CCExpiry are returned only after configuration by Merchant Services (Computop Helpdesk).


Code Listings

Brands

Code

Brand

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