Introduction
This document lists all the PayXpress v4 features available from an Android Intent call.
The following features are available:
Debit transaction
Cancellation transaction
Refund transaction
Deferred debit transaction
Printing the last saved ticket (client & merchant)
Requirements:
The PayXpress v4 app must be installed.
It is possible to call PayXpress with our parameters only via Intent calls.
Calling PayXpress from another Android application
To call PayXpress, you should use an Intent with a Component.
The package should be com.payxpert.merchant and the class com.payxpert.merchant.ui.transaction.TransactionActivity.
There are 2 possible actions for this Intent:
Perform a transaction
Ticket printing
Here is an example for an Intent starting a transaction:
val intent = Intent()
intent.component = ComponentName("com.payxpert.merchant",
"com.payxpert.merchant.ui.transaction.TransactionActivity ")
intent.putExtra("transaction_bundle_key_action", "PERFORM")
//TODO add more extras to specify your needs. See next sections
Parameter | Description | Format | Type | Mandatory |
| The action you want to perform in PayXpress |
| String | Yes |
You should go to the next section to know which extras you should add depending on the action.
Transactions
To trigger a transaction in PayXpress, you should pass to the Intent some extra parameters with the description of the transaction you want to do.
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 of the last performed transaction.
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
When a transaction is triggered via Intent, it is possible to wait for the transaction result to know the outcome of it.
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 transaction |
| Integer | Yes |
| Transaction’s infos | See table below | Transaction | No |
The Transaction object can have several parameters:
Parameter | Description | Format | Type | Mandatory |
| Id of the transaction | / | String | Yes |
| Type of the transaction |
| Integer | Yes |
| Reference of the transaction | / | String | No |
| Amount of the transaction |
| Integer | Yes |
| Currency of the transaction | / | String | Yes |
| Type of transaction |
| Integer | Yes |
| Client & merchant tickets | Json description | String | No |
| Outcome of the transaction |
| Yes | |
| Selected AID during the transaction | / | String | No |
| Transaction without network |
| Boolean | No |
| Masked PAN of the card | / | String | No |
| Type of card | / | String | No |
| Date’s timestamp |
| Long | Yes |
| Amount of the tips |
| Integer | Yes |
| Expiration date of the card |
| Integer | Yes |
| Type of PAN |
| Integer | Yes |
| Authorization number | / | String | No |
For a print
When the instruction to print a ticket is triggered via Intent, it is possible to wait for the result to know the outcome of it.
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 |