AA

variable, max 64

PAN

AB

fixed, 4

Expiration date

AC

variable, max 10

Authorization number

AE

fixed, 2

Status of the action

AF

variable, 2-50

Complementary value to the Status of the action

AI

variable, max 32

Application ID (AID) of the card

AK

variable, max 900

Ticket data

AL

fixed, 1

Type of PAN

BA

fixed, 1

Response delay

BH

fixed, 20

Shopper’s phone number from cash register

BI

fixed, 256

Shopper’s email from cash register

CA

fixed, 2

Cash register number

CB

variable, 2-12

Amount

CD

fixed, 1

Type of action

CE

fixed, 3

Currency code

CF

variable, 1-99

This field is reserved for private use

CI

fixed, 1

How card was read

CJ

fixed, 12

Cash Register Protocol identifier

CK

fixed, 3

'Print ticket?' selection

CZ

fixed, 4

Protocol Version used

ZT

variable, max 999

Constructed Tag for the ticket

PAN (primary account number) of the card

Processing on cash register side:

Processing on terminal side:
PayXpresss always send the partial PAN for security reasons.
This tag is always with the tag AL with the value at “1” (partial PAN)

Remarks:

Transmission is not secure.
For EMV applications, the PAN cannot be returned complete. The terminal returns a partial PAN or a token.

Example - PAN is 0165017677122000674

Expiration date of the card

Processing on cash register side:

Processing on terminal side:

An application can return the expiration date of the card being used in the transaction (YYMM format).

Remarks:

Example - Expiration date is 03/16

Authorization number

Processing on cash register side:

Processing on terminal side:

PayXpress can return your bank’s identifier of the given authorization transaction.

Remarks:

Example - Authorization nº is A00395

Status of the action being performed on the terminal

Processing on cash register side:

Processing on terminal side:

‘01’ = Operation not performed
‘10’ = Operation performed

Remarks:

01: Operation not performed because of a network error, or PayXpress is busy. PayXpress can be busy if there is another process which is running / another transaction ongoing. This answer could also be given if the app is not in the foreground (but rather, it has been pushed to the background).

10: The request successfully reached the terminal and the terminal can handle it.

Example - The operation has not been performed

Additional information to the status

Processing on cash register side:

Processing on terminal side:

The terminal can provide additional information to the overall status of the action:

‘00’ - Unknown – If error is unknown by PayXpress. Could be a technical issue. Not a nominal scenario.
‘01’ - Transaction authorized - Transaction has been accepted by the bank.
‘04’ - Refused - Transaction declined by the bank.
‘06’ - Abandoned - If Cardholder cancelled the transaction during the payment process.
‘07’ - Not completed - This is a additional information from the TAG AE 01 (Operation not performed).
‘08’ - Timeout from PayXpress* - If PayXpress detects a timeout during the transaction then the transaction will be closed automatically.
‘09’ - Operation not performed because of message format error - If we detect an error with the parameters.

Remarks:

We send the response after processing the transaction.
*A transaction can time out depending on the specific timeout values of the specific screen on which the cardholder is situated.

Example - Cancelled

Application ID of the card

Processing on cash register side:

Processing on terminal side:

An application can send the AID of the card that performed the transaction.

Remarks:

Example - An example AID

Generic data to include on ticket

Processing on cash register side:

Printing the ticket.

Processing on terminal side:

This Tag is included in the constructed Tag ZT. It is composed of the ticket data.

Remarks:

This Tag is a generic ticket data container. And may contain, depending on the case, merchant ticket data, cardholder ticket data, or another type of data. The format of the Tag CK that accompanies this Tag in the constructed Tag determines the type of data and its format.

Example: See this example

Gives us the type of PAN returned by reading the card

Processing on cash register side:

Processing on terminal side:

Returned PAN type is always '1' = a Partial PAN.

Remarks:

This Tag is optional.

Example - An example response:

Response delay

Processing on cash register side:

By default, set this field to 0 (response at the end of the transaction).

Processing on terminal side:

List of terminal response times:

• ‘0’ = Response at the end of the transaction

• ‘1’ = Immediate response (without valid status)

Remarks:

If this field is omitted, the default value is taken into account (Response at the end of the transaction).
If an immediate response is requested, the status of the transaction is unknown at the time of the response: the status simply indicates that the request is taken into account.

Example - The cash register needs an immediate response

Shopper’s mobile phone number

Processing on cash register side:

Mobile number with the possibility of transmitting an extension for international numbers.

Processing on terminal side:
This can be used later to send the dematerialized ticket to the shopper’s phone in text (SMS) format via a web service.

Remarks:

Example

Shopper’s email address

Processing on cash register side:

The email address of the shopper as input or appearing on the cash register (x@x.xx).

Processing on terminal side:
This can be used later to email the dematerialized ticket to the shopper in HTML format via a web service.

Remarks:

Example

Cash register nº.

Processing on cash register side:

The cash register indicates its own cash register number in this Tag. Field composed of numeric characters: ‘0’ to ‘9’

Processing on terminal side:
No processing, returned in the response message as is.

Remarks:

This Tag is managed exclusively by the cash register. This number is not intended to be printed on the transaction ticket.

This value is stored in “MerchantIdentifier” in PayXpress.

Example - The cash register number is 1

Transaction amount expressed in smallest way with 0’s to the left

Processing on cash register side:

Indicate an amount >= 0.

Processing on terminal side:
In the return message, the terminal will provide the amount actually paid.

Remarks:

This Tag is managed exclusively by the cash register. This number is not intended to be printed on the transaction ticket.

Example - The amount = 1,50

Example - Amount = 235,70

Defines the type of operation requested by the cash register

Processing on cash register side:

Processing on terminal side:
List of types of transaction actions:

• ‘0’ = Debit (Purchase)

• ‘1’ = Refund by Credit. Not linked to original transaction of Debit.

• ‘2’ = Cancellation. Linked to original transaction of Debit but can only be the original amount of the Debit.

• ‘3’ = Duplicate

• '7' = Deferred debit

List of types of Selection/Input Actions:

• ‘I’ = Identification

• ‘P’ = Printing on the terminal of a buffer transmitted by the cash register

• 'R' = Reboot the POS - Only compatible with Castles devices

• 'C' = CTMS Status - Only compatible with Castles devices

• 'T' = Transaction Status

Remarks:

If the type of operation cannot be carried out, the terminal responds with ‘Status: Operation not carried out’ and in the complementary info Tag AF ‘Type of action requested unknown’. In the case of printing a buffer (ASCII encoded base 64) sent by the cash register, the tag CD with type of action ‘P’ will be completed with a constructed Tag ZT containing the buffer to be printed.

Example - Perform a debit. See example

Numerical code of the currency to be transacted

Processing on cash register side:

Indicate in three digits (ISO 4217) the currency code corresponding to the amount mentioned in the amount field.

Processing on terminal side:
Partial list of currency codes:

• ‘978’ = EUR

If the terminal does not support the requested currency, it responds with 'Operation not performed'.

Remarks:

This Tag is mandatory for all financial transactions.

In response, the terminal indicates the currency actually used for the transaction (it may be different).

Example - the amount is in EUR

Private data destined for PayXpress or to be sent back to the cash register in the response message

Processing on cash register side:

Indicate the data you want to transmit to PayXpress.

Processing on terminal side:
Private data that can be used by the merchant/integrator which they would like to be stored by PayXpress as part of the transaction details.
The value is stored in PayXpress at the transaction level as part of the field “Order Id“.

Remarks:

Example

The way that the card is read during the payment

Processing on cash register side:

The card-reading mode to use for the payment.

Processing on terminal side:
In response, the terminal can provide the reading mode that was actually used for the payment.

List of reading modes:

• ‘0’ indifferent

• ‘1’ contact

• ‘2’ contactless

• ‘3’ magnetic stripe

• ‘4’ manual entry

Remarks:

By default the payment mode is indifferent. If the cash register transmits this Tag, it must be in line with all other selection modes, applications, the contract number, etc., otherwise the status of the action will be returned ‘Operation not carried out.’

Example - Only accept contact payments.

The version of the protocol that the cash register and/or terminal is using.

Processing on cash register side:

The version of the protocol the cash register is using. Sent in every message to terminal.

Processing on terminal side:
The version of the protocol the terminal is using. Sent in every message to cash register.

Remarks:

By default we must always put the value 323540032810 in this Tag.

Example

How the cash register handles the ticket.

Processing on cash register side:

Position 1:

• ‘0‘ Ticket management not supported (positions 2 and 3 ignored)

• ‘1’ Ticket management supported, Response in the ZT constructed field

Position 2:

• ‘0’ Customer ticket

• ‘1’ Merchant ticket

• ‘2’ Customer and Merchant tickets

Position 3:

• ‘0’ : Extended ASCII format (Latin-1) encoded base 64

• ‘1’ : HTML format encoded base 6

Processing on terminal side:
If this Tag is absent or at position 1 valued at ‘0’ in the message ACTION: TYPE TRANSACTION, no ticket is transmitted to the cash register.

If this Tag is transmitted by the cash register with the value ‘1’ the transaction ticket(s) are transmitted to the cash register in the response message in accordance with the details of positions 2 and 3.

For values ​​‘1’, ‘2’, as far as printing the merchant ticket on the cash register, check that the functionality is available on the terminal used. The base64 format is recommended for encoding non-alphanumeric data (in alphanumeric) to manage both carriage returns (line breaks) and small images.

Remarks:
If position 1 is valued at ‘0’, then positions 2 and 3 are ignored.
If position 2 is valued at ‘2’ then two ZT Tags are transmitted.

Example

Tells the cash register and/or the terminal the version to use.

Processing on cash register side:

Tells the terminal what version the incoming communication is in.

Processing on terminal side:
Tells the cash register what version the incoming communication is in.

Remarks:
This Tag should be the first one in the messages transmitted by both cash register and terminal.
By default it must be 0320.

Example - “I am sending this message in protocol version 3.20”

Ticket sent by terminal

Processing on cash register side:

Reception following a request with a CK Tag in 1xx format requesting the cardholder and/or merchant tickets.

Processing on terminal side:
Transmits a ticket to the cash register to be printed there.
It is composed of the Tags:

• CK: Ticket management

• AK: Ticket data (in the format defined by the CK Tag).

Remarks:
In response to a TRANSACTION message.

Several ZT Tags can be repeated in the response message, if both tickets are requested (cardholder and merchant).

Example

CZ0040320CJ012322508084341CA00201CD001PZT833CK003100AK820ICAgICAgICAgU1lNT1RST05JQwo3NSBSdWUgRnJhbmNpcyBkZSBQcmVzc2Vuc2UKICAgICAgIFBBUkMgUkVQVUJMSVFVRQogICAgICA2OTEwMCBWSUxMRVVSQkFOTkUKICAgIC0tLS0tLS0tLS0tLS0tLS0tLS0tLQpUVkEgSW50cmFjb20gRlIgMjkgNDA5IDA5NCAyNDAKU2lyZXQgNDA5IDA5NCAyNDAgMDAwMjgKICAgIC0tLS0tLS0tLS0tLS0tLS0tLS0tLQogdmVuZHJlZGkgMyBhdnJpbCAyMDIwIDEyOjU1CiAgICAtLS0tLS0tLS0tLS0tLS0tLS0tLS0KICAgICAgIFRpY2tldCBWZW50ZQogICAgICAgIE4uIDAwMDAyNAoKUmVmLiAgIFEuIERlc2lnbmF0aW9uICAgICBQcml4Ci0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQoyNDggICAgMSAgQmFkb2l0IC0gMC41TCAgIDEsNzQKMjc0ICAgIDEgIERhbmlvIE15cnRpbGxlICAxLDI0CjI1MiAgICAxICBQb3VsZXQgcm90aSAgICAgNiw3NAoKTW9kZSBkZSBSZWdsZW1lbnQ6IENCCk1vbnRhbnQgSFQ6ICAgICAgICAgOS4yMiBFVVIKTW9udGFudCBUVkE6ICAgICAgICAwLjUwIEVVUgpNb250YW50IFRUQzogICAgICAgIDkuNzIgRVVSCiAgICAtLS0tLS0tLS0tLS0tLS0tLS0tLS0KICAgIE1lcmNpIGRlIHZvdHJlIHZpc2l 0ZQog

Configurable, 0320 by default

CZ0040320

Configurable, 323540032810 by default.
This is PayXpert’s Association du Paiement-assigned ID for this field.

CJ012323540032810

Constant 1

CA0011

Amount in cents. 25,00€

CB0042500

Depends on what we want:
'0’ = Debit (Payment)
‘1’ = Refund by Credit (not linked to Original Transaction)
‘2’ = Cancellation
‘3’ = Duplicata

Debit: CD0010

Refund : CD0011

Cancellation: CD0012

Duplicata: CD0013

Code for Euro.
Constant is 978.

CE003978

Taken from the initial message sent by the cash register

CZ0040320

Taken from the initial message sent by the cash register

CJ012323540032810

Taken from the initial message sent by the cash register

CA0011

Taken from the initial message sent by the cash register

CB0042500

Taken from the initial message sent by the cash register

CD0010

Taken from the initial message sent by the cash register

CE003978

‘01’ = Operation not performed
‘10’ = Operation performed

AE00210

0 = POS terminal will answer the cash register at the end of the transaction.
1 = POS will answer the cash register with an immediate response after request and not wait until the end of the transaction.

BA0010

Either:
0 = Debit (Request of the Cashier)
1 = Credit/Reimbursement
2 = Void/Cancellation

CD0010

‘1’ contact
‘2’ contactless
‘3’ magnetic reader
‘4’ manual entry

CI0012

The PAN will always be masked.
Example: XXXXXXX
XXXXX2897

AA016XXXXXXXXXXXX2897

Date format AAMM, for example:
3005 for 05/2030

AB0043005

When a payment is accepted the authorization number is included.
Example: 664845

AC006664845

1 = Partial PAN (Masked)

AL0011

Configurable, 0320 by default

CZ0040320

Configurable, 323540032810 by default.
This is PayXpert’s Association du Paiement-assigned ID for this field.

CJ012323540032810

Constant 1

CA0011

Amount in cents. 25,00€

CB0042500

Depends on what we want:
'0’ = Debit (Payment)
‘1’ = Credit (Refund)
‘2’ = Annulation
‘3’ = Duplicata

Debit : CD0010

Refund : CD0011

Cancellation: CD0012

Duplicata : CD0013

Code for Euro.
Constant is 978.

CE003978

Position 1:

• ‘1’ Ticket management supported; r4esponse in the ZT constructed field

Position 2:

• ‘0’ Customer ticket

• ‘1’ Merchant ticket

• ‘2’ Customer and Merchant tickets

Position 3:

• ‘0’: Extended ASCII format (Latin-1) encoded base 64

• ‘1’: HTML format encoded base 64

CK003100

Taken from the initial message sent by the cash register

CZ0040320

Taken from the initial message sent by the cash register

CJ012323540032810

Taken from the initial message sent by the cash register

CA0011

Taken from the initial message sent by the cash register

CB0042500

Taken from the initial message sent by the cash register

CD0010

Taken from the initial message sent by the cash register

CE003978

AA016***********0674

AB0041603

AC006A00395

AL0011

‘01’ = Operation not performed
‘10’ = Operation performed

AE00210

AF00201

‘1’ contact
‘2’ contactless
‘3’ magenetic reader
‘4’ manual entry

CI0012

Only the Customer Ticket is given in the response.

ZT617CK003100AK604VEFSSkVUQSBCQU5DQVJJQQpTSU4gQ09OVEFDVE8KQm9uam91ciAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKQTAwMDAwMDAwNDEwMTAKRGViaXRvCiAyMS8xMC8yNCAtIDIzOjEyOjI0Ckc3IFRFU1QgICAgICAgICAgMjEgCkRJSk9OICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgCjA4OTkwMTMKMjAwNDEKMzI0Mzc5ODY2MDAwMTkKWFhYWFhYWFhYWFhYMjg5NwpFQzNBRjY5QTE2QkI3NDM4CjY1NSAwMDIgMDAwMDA2ICAwMSAgQyAgQApOVU1FUk8gQVVUT1JJWkFDST9OOiA2NjQ4NDUKUkVGLiA6IDE5OTU1MjkwMTM0MTg3MzUKSU1QT1JURQoxLDAwP0VVUgpWRU5UQQpSRUNJQk8gUEFSQSBFTCBDTElFTlRFCkEgQ09OU0VSVkFSCkRVUExJQ0FETwpNZXJjaSwgYXUgcmV2b2lyLiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAo=

Configurable, 0320 by default

CZ0040320

Configurable, 323540032810 by default.
This is PayXpert’s Association du Paiement-assigned ID for this field.

CJ012323540032810

Constant 1

CA0011

Depends on what we want :
'0’ = Debit (Payment)
‘1’ = Refund
‘2’ = Cancellation
‘3’ = Duplicata

Debit : CD0010

Refund : CD0011

Cancellation: CD0012

Duplicata : CD0013

Position 1:

• ‘1’ Ticket management supported, Response in the ZT constructed field

Position 2:

• ‘0’ Customer ticket

• ‘1’ Merchant ticket

• ‘2’ Customer and Merchant tickets

Position 3:

• ‘0’: Extended ASCII format (Latin-1) encoded base 64

• ‘1’: HTML format encoded base 64

CK003100

Configurable, 0320 by default

CZ0040320

Configurable, 323540032810 by default.
This is PayXpert’s Association du Paiement-assigned ID for this field.

CJ012323540032810

Constant 1

CA0011

‘01’ = Operation not performed
‘10’ = Operation performed

AE00210

Only the Customer Ticket is given in the response.

ZT617CK003100AK604VEFSSkVUQSBCQU5DQVJJQQpTSU4gQ09OVEFDVE8KQm9uam91ciAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKQTAwMDAwMDAwNDEwMTAKRGViaXRvCiAyMS8xMC8yNCAtIDIzOjEyOjI0Ckc3IFRFU1QgICAgICAgICAgMjEgCkRJSk9OICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgCjA4OTkwMTMKMjAwNDEKMzI0Mzc5ODY2MDAwMTkKWFhYWFhYWFhYWFhYMjg5NwpFQzNBRjY5QTE2QkI3NDM4CjY1NSAwMDIgMDAwMDA2ICAwMSAgQyAgQApOVU1FUk8gQVVUT1JJWkFDST9OOiA2NjQ4NDUKUkVGLiA6IDE5OTU1MjkwMTM0MTg3MzUKSU1QT1JURQoxLDAwP0VVUgpWRU5UQQpSRUNJQk8gUEFSQSBFTCBDTElFTlRFCkEgQ09OU0VSVkFSCkRVUExJQ0FETwpNZXJjaSwgYXUgcmV2b2lyLiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAo=

Configurable, 0320 by default

CZ0040320

Configurable, 323540032810 by default.
This is PayXpert’s Association du Paiement-assigned ID for this field.

CJ012323540032810

Constant 1

CA0011

I for Identification method

CD001I

Protocol version

Taken from the initial message sent by the cash register

CZ0040320

Cash register protocol version

Taken from the initial message sent by the cash register

CJ012323540032810

Cash register number

Taken from the initial message sent by the cash register

CA0011

Action type

Taken from the initial message sent by the cash register

CD001I

Status of the action

‘01’ = Operation not performed
‘10’ = Operation performed

AE00210

Configurable, 0320 by default

CZ0040320

Configurable, 323540032810 by default.
This is PayXpert’s Association du Paiement-assigned ID for this field.

CJ012323540032810

Constant 1

CA0011

P for Print method

CD001P

ZT0025CK003100AK0012Ym9uam91cg==

Position 1:

• ‘1’ Ticket management supported, Response in ZT constructed field

Position 2:

• ‘0’ Customer ticket

Position 3:

• ‘0’: Extended ASCII format (Latin-1) encoded in base 64

CK003100

Base 64 encoding of the ticket to be printed, 900 max
Example: text "bonjour"

AK0012Ym9uam91cg==

Protocol version

Taken from the initial message sent by the cash register

CZ0040320

Cash register protocol version

Taken from the initial message sent by the cash register

CJ012323540032810

Cash register number

Taken from the initial message sent by the cash register

CA0011

Action type

Taken from the initial message sent by the cash register

CD001P

Status of the action

‘01’ = Operation not performed
‘10’ = Operation performed

AE00210