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 Cockpit. 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. |
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) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
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 Pay-Jet encryption key and forwards the authorization request via SSL through a central proxy server to CCV acCEPT
(3) CCV acCEPT routes the transaction to Pay-Jet Cockpit via VPN connection
(4) Cockpit 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
Pay-Jet Cockpit 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 Cockpit 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.
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
Cockpit 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 Pay-Jet Cockpit.
For reconciliation purposes, Pay-Jet 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, Pay-Jet 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 Cockpit 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 | |||
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.payjet-cockpit.de/getStatus.aspx |
Notice: For security reasons, Pay-Jet Cockpit 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:
Parameters for status inquiries via socket connections
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
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 | |||
AMEX | American Express | |||
Diners | Diners Club | |||
Discover | Discover | |||
AirPlus | AirPlus Corporate Accounts (UATP) |
Acquirer
Code | Acquirer | |||
---|---|---|---|---|
CON | Concardis | |||
CHASE | Chase Paymentech | |||
AME | American Express | |||
AIR | AirPlus | |||
WLP | Worldpay |