PayXpert - User documentation
Concert V3
- 1 1) Dictionary of Tags used in the protocol
- 1.1 Naming rules
- 1.2 List of Tags in the protocol
- 1.3 Description of each Tag in detail
- 1.3.1 Tag AA - PAN
- 1.3.2 Tag AB - Expiration date
- 1.3.3 Tag AC - Authorization number
- 1.3.4 Tag AE - Status of the action
- 1.3.5 Tag AF - Complementary info to the status of the action
- 1.3.6 Tag AI - AID of the card
- 1.3.7 Tag AK - Ticket data
- 1.3.8 Tag AL - PAN type
- 1.3.9 Tag AP - Date of the operation
- 1.3.10 Tag AQ - POS serial number
- 1.3.11 Tag BA - Response delay
- 1.3.12 Tag BH - Shopper mobile phone from cash register
- 1.3.13 Tag BI - Shopper email address from cash register
- 1.3.14 Tag CA - Cash register number
- 1.3.15 Tag CB - Amount
- 1.3.16 Tag CC - Application selection
- 1.3.17 Tag CD - Operation type
- 1.3.18 Tag CE - Currency code
- 1.3.19 Tag CF - Field reserved for private use
- 1.3.20 Tag CH - External Transaction Reference
- 1.3.21 Tag CI - Payment mode
- 1.3.22 Tag CJ - Cash register protocol version
- 1.3.23 Tag CK - Ticket on cash register side
- 1.3.24 Tag CZ - Protocol version to use
- 1.3.25 Tag ZT - Constructed Tag to handle ticket content
- 1.3.26 Tag ID - Custom Tag - Original transaction ID
- 1.3.27 Tag IM - Custom Tag - PayXpert Debit transaction ID for credit
- 2 2) Examples
- 2.1 Debit (Cancellation, Refund or Duplicata) Transaction and Your Id of the Transaction and no tickets in reponse
- 2.2 Debit (Cancellation, Refund/Credit or Duplicata) Transaction and only Customer ticket in response
- 2.3 Credit Transaction from an Debit Transaction
- 2.3.1 Description
- 2.3.2 Workflow
- 2.3.3 Conditions
- 2.3.4 Debit Transaction Request (Cash register → Terminal)
- 2.3.5 Debit Transaction Response (Terminal → Cash register) - Original Debit Id is retrieved in Tag ID
- 2.3.6 Credit Transaction Request (Cash register → Terminal)
- 2.3.7 Credit Transaction Response(Terminal → Cash Register)
- 2.4 Duplicata - Print a duplicata
- 2.5 Identification of the terminal - Ping request to terminal
- 2.6 Printing of a personalized ticket by the terminal
- 2.7 Get the status of the transaction
- 2.8 Abort a transaction
1) Dictionary of Tags used in the protocol
Naming rules
A* type Tags are terminal elements
B* type Tags are cash register elements
C* type Tags are cash register and terminal elements
Z* type Tags are constructed elements composed of A*, B*, and/or C tags
List of Tags in the protocol
Type | Length | Meaning | Protocol version |
|---|---|---|---|
variable, max 64 | PAN | 0320 | |
fixed, 4 | Expiration date | 0320 | |
variable, max 10 | Authorization number | 0320 | |
fixed, 2 | Status of the action | 0320 | |
variable, 2-50 | Complementary value to the Status of the action | 0320 | |
variable, max 32 | Application ID (AID) of the card | 0320 | |
variable, max 900 | Ticket data | 0320 | |
fixed, 1 | Type of PAN | 0320 | |
fixed, 13 | Date of the operation | Custom | |
variable 2-20 | serial number of the pos | Custom | |
fixed, 1 | Response delay | 0320 | |
fixed, 20 | Shopper’s phone number from cash register | 0320 | |
fixed, 256 | Shopper’s email from cash register | 0320 | |
fixed, 2 | Cash register number | 0320 | |
variable, 2-12 | Amount | 0320 | |
fixed, 1 | Type of action | 0320 | |
fixed, 3 | Currency code | 0320 | |
variable, 1-99 | This field is reserved for private use | 0320 | |
variable, 1-99 | This field is reserved for private use | 0320 | |
fixed, 1 | How card was read | 0320 | |
fixed, 12 | Cash Register Protocol identifier | 0320 | |
fixed, 3 | 'Print ticket?' selection | 0320 | |
fixed, 4 | Protocol Version used | 0320 | |
variable, max 999 | Constructed Tag for the ticket | 0320 | |
variable, max 999 | PayXpert Transaction Id | Custom Tag | |
variable, max 999 | PayXpert Transaction Id | Custom Tag |
Description of each Tag in detail
Tag AA - PAN
PAN | ||
|---|---|---|
AA | Variable length. Max 64 | PAN (primary account number) of the card |
Processing on cash register side: | ||
Processing on terminal side: | ||
Remarks: Transmission is not secure. | ||
Example - PAN is 123456XXXXXX1234 | AA016123456XXXXXX1234 | |
Tag AB - Expiration date
Expiration date | ||
|---|---|---|
AB | Fixed length. 4 | 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 | AB0041603 | |
Tag AC - Authorization number
Authorization number | ||
|---|---|---|
AC | Variable length. Max 10 | 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 | AC006A00395 | |
Tag AE - Status of the action
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 | ||
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). | ||
Example - The operation has not been performed | AE00201 | |
Tag AF - Complementary info to the status of the action
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 is unknown by PayXpress. Could be a technical issue. Not a nominal scenario. | ||
Remarks: We send the response after processing the transaction. | ||
Example - Cancelled | AF00207 | |
Tag AI - AID of the card
AID of the card | ||
|---|---|---|
AI | Variable length. Max 32 | 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 | AI014A0000000041010 | |
Tag AK - Ticket data
Ticket data | ||
|---|---|---|
AK | Variable length. Max 900 | 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 |
| |
Tag AL - PAN type
PAN type | ||
|---|---|---|
AL | Fixed length. 1 | 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: | AL0011 | |
Tag AP - Date of the operation
Date of the operation | ||
|---|---|---|
AP | Fixed length. 13 | Give the date and time in which the operation was realized |
Processing on cash register side: | ||
Processing on terminal side: Returned Date & time in which the operation was realized. | ||
Remarks: This Tag is optional. | ||
Example - An example response: | AP0131738069356000 | |
Tag AQ - POS serial number
Date of the operation | ||
|---|---|---|
AQ | Variable length. 2-20 | Give the serial number of the pos |
Processing on cash register side: | ||
Processing on terminal side: Returned the serial number of the pos | ||
Remarks: | ||
Example - An example response: | AQ010PCAZBGRE41 | |
Tag BA - Response delay
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:
| ||
Remarks: If this field is omitted, the default value is taken into account (Response at the end of the transaction). | ||
Example - The cash register needs an immediate response | BA0011 | |
Tag BH - Shopper mobile phone from cash register
Shopper’s mobile phone number from cash register | ||
|---|---|---|
BH | Variable length. 8-20 | 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: | ||
Remarks: | ||
Example | BH0100625698925 | |
Tag BI - Shopper email address from cash register
Shopper’s email number from cash register | ||
|---|---|---|
BI | Variable length. 6-256 | 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). | ||
© PayXpert Services Ltd, 2025