Versions Compared

Version Old Version 43 New Version Current
Changes made by

Technical Writer

Juan BARRAZA

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3
outlinefalse
styledefault
typelist
printabletrue

...

PAN

AA

Variable length. Max 64

PAN (primary account number) of the card

Processing on cash register side:

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

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

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

...

Authorization number

AC

Variable length. Max 10

Authorization number

Processing on cash register side:

Processing on terminal side:

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

Remarks:

Example - Authorization nº is A00395

AC006A00395

...

Status of the action

AE

Fixed length. 2

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:

*When the terminal response must be immediate

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

10: The request successful reach the pos & the pos can treat it successfully reached the terminal and the terminal can handle it.

Example - The operation has not been performed

AE00201

...

Complementary info to the status of the action

AF

Variable length. 2-50

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 that is unkown unknown by PayXpress. Could be a technical issue not . 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 canceled 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 of with the parameters.

Remarks:

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

Exemple : CanceledExample - Cancelled

AF00207

Anchor
AI
AI
Tag AI - AID of the card

...

Response delay

BA

Fixed length. 1

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 - An The cash register needs an immediate response

BA0011

Anchor
BH
BH
Tag BH - Shopper mobile phone from cash register

...

Cash register number

CA

Fixed length. 2

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

CA00201

...

Operation type

CD

Fixed length. 1

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’ = Credit (Refund)Refund by Credit. Not linked to original transaction of Debit.

  • ‘2’ = Cancellation

  • ‘3’ = Duplicate

  • . 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 Devicesdevices

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

  • 'T' = Transaction Status

Remarks:

If the type of operation cannot be carried out, the terminal responds with ‘Status: Operation not carried out’ andin the complementary info Tag AF ‘Operation not carried out - type ‘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

CD0010

CD001C

...

Private field

CF

Variable length. 1-99

Private data destined for the application on the terminal or 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 be transmitted to the payment (or information retrieval) applicationtransmit to PayXpress.

Processing on terminal side:
Private data that can be used by the merchant/integrator and 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“ or “Merchant Id” .

Remarks:

Example

CF020TEST CONCERT CN 3.XX

...

Cash register protocol version

CJ

Fixed length. 12

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:For reference only. Does not control anything.

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

Example

CJ012012345678901CJ012323540032810

Anchor
CK
CK
Tag CK - Ticket on cash register side

...

Protocol version to use

CZ

Fixed length. 4

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 default it must be 0320.

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

CZ0040320

...

Cash register message demanding a sale (debit) of 25 EUR. No ticket is requestrequested.

Code Block
CZ0040320CJ012323540032810CA0011CB0042500CD0010CE003978

Debit Transaction Request (Cash

...

register → Terminal)

Tag

Meaning

Rule

Example

CZ

Concert Protocol version

Configurable, 0320 by default

CZ0040320

CJ

Cash register protocol version

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

CJ012323540032810

CA

Cash register number

Constant 1

CA0011

CB

Amount

Amount in centimescents. 25,00€

CB0042500

CD

Action type

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

CE

Currency

Code for Euro.
Constant is 978.

CE003978

Debit Transaction Response (Terminal → Cash

...

register)

Tag

Meaning

Rule

Example

CZ

Concert Protocol protocol version

Taken from the initial message sent by the Cash Registercash register

CZ0040320

CJ

Cash register protocol version

taken Taken from the initial message sent by the Cash Registercash register

CJ012323540032810

CA

Cash register number

taken Taken from the initial message sent by the Cash Registercash register

CA0011

CB

Amount

taken Taken from the initial message sent by the Cash Registercash register

CB0042500

CD

Action type

taken Taken from the initial message sent by the Cash Registercash register

CD0010

CE

Currency

taken Taken from the initial message sent by the Cash Registercash register

CE003978

AE

Status of the action

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

AE00210

AF

Complementary info to the Action status

BA

POS Response Timeresponse time

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

BA0010

CD

Action that was realized by the POS terminal

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

CD0010

CI

Card-reading mode (payment mode) that was used

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

CI0012

AA

PAN of the card

The PAN will always be masked.
Example: XXXXXXX
XXXXX2897

AA016XXXXXXXXXXXX2897

AB

Expiration date of the card used

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

AB0043005

AC

Authorization Numbernumber

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

AC006664845

AL

Type of PAN that was restitued restituted in the message

1 = Partial PAN (Masked)

AL0011

Anchor
Debit+Ticket
Debit+Ticket
Debit (Cancelation, Refund/Credit or Duplicata) Transaction and only

...

Customer ticket in response

Cash register message demanding a sale (debit) of 25 EUR. Merchant wants to retrieve the customer ticket only via the CK Tag.

Code Block
CZ0040320CJ012323540032810CA0011CB0042500CD0010CE003978CK003100

Debit Transaction Request (Cash

...

register → Terminal)

Tag

Meaning

Rule

Example

CZ

Concert Protocol protocol version

Configurable, 0320 by default

CZ0040320

CJ

Cash register protocol version

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

CJ012323540032810

CA

Cash register number

Constant 1

CA0011

CB

Amount

Amount in centimescents. 25,00€

CB0042500

CD

Action type

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

Debit : CD0010

Refund : CD0011

Cancellation: CD0012

Duplicata : CD0013

CE

Currency

Code for Euro.
Constant is 978.

CE003978

CK

Ticket Managementmanagement

Position 1:

  • ‘1’ Ticket management supported, Response ; 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 664

CK003100

Debit Transaction Response (Terminal → Cash

...

register)

Tag

Meaning

Rule

Example

CZ

Concert Protocol protocol version

Taken from the initial message sent by the Cash Registercash register

CZ0040320

CJ

Cash register protocol version

taken Taken from the initial message sent by the Cash Registercash register

CJ012323540032810

CA

Cash register number

taken Taken from the initial message sent by the Cash Registercash register

CA0011

CB

Amount

taken Taken from the initial message sent by the Cash Registercash register

CB0042500

CD

Action type

taken Taken from the initial message sent by the Cash Registercash register

CD0010

CE

Currency

taken Taken from the initial message sent by the Cash Registercash register

CE003978

AEAA

Status Pan of the action

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

AE00210

AF

Complementary info to the Action status

cardholder

PAN (primary account number) of the card

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

AB

Card expiration date

Expiration date of the card

AB0041603

AC

Authorization number

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

AC006A00395

AL

PAN type

Gives us the type of PAN returned by reading the card

AL0011

AE

Status of the action

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

AE00210

AF

Complementary info to the Action status

AF00201

CI

Card-reading mode (payment mode)

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

CI0012

mode)

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

CI0012

ZT

Ticket

Only the Customer Ticket is given in the response.

ZT617CK003100AK604VEFSSkVUQSBCQU5DQVJJQQpTSU4gQ09OVEFDVE8KQm9uam91ciAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKQTAwMDAwMDAwNDEwMTAKRGViaXRvCiAyMS8xMC8yNCAtIDIzOjEyOjI0Ckc3IFRFU1QgICAgICAgICAgMjEgCkRJSk9OICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgCjA4OTkwMTMKMjAwNDEKMzI0Mzc5ODY2MDAwMTkKWFhYWFhYWFhYWFhYMjg5NwpFQzNBRjY5QTE2QkI3NDM4CjY1NSAwMDIgMDAwMDA2ICAwMSAgQyAgQApOVU1FUk8gQVVUT1JJWkFDST9OOiA2NjQ4NDUKUkVGLiA6IDE5OTU1MjkwMTM0MTg3MzUKSU1QT1JURQoxLDAwP0VVUgpWRU5UQQpSRUNJQk8gUEFSQSBFTCBDTElFTlRFCkEgQ09OU0VSVkFSCkRVUExJQ0FETwpNZXJjaSwgYXUgcmV2b2lyLiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAo=

Duplicata - Print a duplicata

Duplicata Transaction Request (Cash register → Terminal )

Tag

Meaning

Rule

Example

CZ

Concert protocol version

Configurable, 0320 by default

CZ0040320

CJ

Cash register protocol version

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

CJ012323540032810

CA

Cash register number

Constant 1

CA0011

CD

Action type

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

Debit : CD0010

Refund : CD0011

Cancellation: CD0012

Duplicata : CD0013

CK

Ticket management

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

Duplicata Response (Terminal → Cash register)

Tag

Meaning

Rule

Example

CZ

Concert protocol version

Configurable, 0320 by default

CZ0040320

CJ

Cash register protocol version

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

CJ012323540032810

CA

Cash register number

Constant 1

CA0011

AE

Status of the action

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

AE00210

ZT

Ticket

Only the Customer Ticket is given in the response.

ZT617CK003100AK604VEFSSkVUQSBCQU5DQVJJQQpTSU4gQ09OVEFDVE8KQm9uam91ciAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKQTAwMDAwMDAwNDEwMTAKRGViaXRvCiAyMS8xMC8yNCAtIDIzOjEyOjI0Ckc3IFRFU1QgICAgICAgICAgMjEgCkRJSk9OICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgCjA4OTkwMTMKMjAwNDEKMzI0Mzc5ODY2MDAwMTkKWFhYWFhYWFhYWFhYMjg5NwpFQzNBRjY5QTE2QkI3NDM4CjY1NSAwMDIgMDAwMDA2ICAwMSAgQyAgQApOVU1FUk8gQVVUT1JJWkFDST9OOiA2NjQ4NDUKUkVGLiA6IDE5OTU1MjkwMTM0MTg3MzUKSU1QT1JURQoxLDAwP0VVUgpWRU5UQQpSRUNJQk8gUEFSQSBFTCBDTElFTlRFCkEgQ09OU0VSVkFSCkRVUExJQ0FETwpNZXJjaSwgYXUgcmV2b2lyLiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAo=

TODO David Guignard add Duplicata request and response.


Identification of the terminal - Ping

...

request to terminal

Allows you to validate the connexion connection between the cash register and the POS terminal without triggering a transaction. Basically it allows you to identify confirm that the terminal is alivelive.

This message can be implemented either with a regular polling frequency or before triggering a payment transaction.

Identification Request (Cash

...

register → Terminal)

Tag

Meaning

Rule

Example

CZ

Concert Protocol version

Configurable, 0320 by default

CZ0040320

CJ

Cash register protocol version

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

CJ012323540032810

CA

Cash register number

Constant 1

CA0011

CD

Action type

I for Identification method

CD001I

Identification Response (Terminal → Cash

...

register)

Tag

Meaning

Rule

Example

CZ

Protocol version

Taken from the initial message sent by the Cash Registercash register

CZ0040320

CJ

Cash register protocol version

taken Taken from the initial message sent by the Cash Registercash register

CJ012323540032810

CA

Cash register number

taken Taken from the initial message sent by the Cash Registercash register

CA0011

CD

Action type

taken Taken from the initial message sent by the Cash Registercash register

CD001I

AE

Status of the action

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

AE00210

...

Allows a buffer (ASCII coded base 64) sent by the cash register to be printed on the terminal.

Print

...

ticket Request (Cash register → Terminal)

Tag

Meaning

Rule

Example

CZ

Protocol version

Configurable, 0320 by default

CZ0040320

CJ

Cash register protocol version

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

CJ012323540032810

CA

Cash register number

Constant 1

CA0011

CD

Action type

P for Print method

CD001P

ZT

Constructed Tag composed of the data in CK and the (ASCII base64) buffer to print in AK

ZT0025CK003100AK0012Ym9uam91cg==

CK

'Print ticket?' selection

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

AK

Data to print

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

AK0012Ym9uam91cg==

1 If a mandatory field is not present in the message, the action will be refused by the terminal, the status of the action returned as ‘Operation not performed.’

...

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

AK0012Ym9uam91cg==

Print ticket Response (Terminal → Cash

...

register)

The terminal responds immediately to the cash register and then performs the collection(s) of the applications, afterwards, continues with what it was doing.

Tag

Meaning

Rule

Example

CZ

Protocol version

taken Taken from the initial message sent by the Cash Registercash register

CZ0040320

CJ

Cash register protocol version

taken Taken from the initial message sent by the Cash Registercash register

CJ012323540032810

CA

Cash register number

taken Taken from the initial message sent by the Cash Registercash register

CA0011

CD

Action type

taken Taken from the initial message sent by the Cash Registercash register

CD001P

AE

Status of the action

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

AE00210

...