| Table of Contents | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
none
|
Version History
Version | Date | Changes | Author |
|---|---|---|---|
1.0 | 11 April 2024 | Initial Documentation for V4 | Anne-Claire Femia |
1.1 | 14 Oct 2024 | Added Json Ticket Example | David Guignard |
1.2 | 28 Oct 2024 | Added Process Flow | Tim MacGowan |
1.3 | 13 Nov 2024 | Added link of official Android intent documentation + sample app | Rémi DEROM |
Introduction
This document lists all the PayXpress V4 features available in order to make an Inter-application (‘app-to-app’) integration between mobile apps installed on the same mobile device.
...
| Code Block | ||
|---|---|---|
| ||
intent.putExtra("transaction_bundle_key_amount", 1500)
intent.putExtra("transaction_bundle_key_transaction_type", 1)
intent.putExtra("transaction_bundle_key_print_ticket", false)
intent.putExtra("transaction_bundle_key_reference", "test") |
Parameter | Description | Format | Type | Mandatory |
| Amount of the transaction. |
| Integer | Yes |
| Type of the transaction. |
| Integer | No |
| Decide if the ticket should be printed or not. |
| Boolean | No |
| Your id for the transaction | String | Yes |
Ticket printing
You can print merchant or client tickets directly in the POS of the last performed transaction.
| Code Block | ||
|---|---|---|
| ||
intent.putExtra("transaction_bundle_key_action", "PRINT_LAST")
intent.putExtra("transaction_bundle_key_type_print_ticket", 0) |
Parameter | Description | Format | Type | Mandatory |
| Defines which ticket you want to print |
| Integer | Yes |
Retrieve Intent’s result
For a transaction
...
The result is a JSON that is formatted as a String. It can be found in the extras under the name result. Inside you will find a IntentTransactionOutcomeobject with the following parameters:
Parameter | Description | Format | Type | Mandatory |
| Outcome of the transaction |
| Integer | Yes |
| Transaction’s infos | See table below | Transaction | No |
| Client & merchant tickets | JSON description. See bellow | String | No |
The Transactionobject can have several parameters:
Parameter | Description | Format | Type | Mandatory |
| Id of the transaction | / | String | Yes |
| Type of the transaction |
| Integer | Yes |
| Type of transaction / Payment method |
| Integer | Yes |
| Date’s timestamp |
| Long | Yes |
| Reference of the transaction transmitted as input | / | String | No |
| Amount of the transaction |
| Integer | Yes |
| Currency of the transaction | / | String | Yes |
| Selected AID during the transaction | / | String | No |
| Transaction without network / offline ? |
| Boolean | No |
| Outcome of the transaction |
| Yes | |
| Masked PAN of the card | / | String | No |
| Type of card used | / | String | No |
| Expiration date of the card |
| Integer | Yes |
| Amount of the tips (in case the functionality is activated) |
| Integer | No |
| Type of PAN (Partial PAN when nothing returned) |
| Integer | No |
| Authorization number if provided by the bank | / | String | No |
Client & Merchant Tickets
...
The result is a JSON that is formatted as a String. It can be found in the extras under the name result. Inside you will find a IntentTransactionOutcome object with the following parameters:
Parameter | Description | Format | Type | Mandatory |
| Outcome of the print |
| Integer | Yes |
| Client & merchant tickets | String | No |
Note:
For the device without integrated printer, the
statuswill be always0 (successful).Ticketsdata returned from intent call will always return client and merchant ticket in base64.
...