Version History

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 in the terminal.

• It is possible to call PayXpress with our parameters only via Intent calls.

Process Flow

Your mobile application can call the PayXpress mobile application in order to handle the payment on the same device. This is done via Android Intent API.

The diagram bellow outlines the relationship and process flow between the systems involved in the Intent communication.

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

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")

Ticket printing

You can print merchant or client tickets directly in the POS of the last performed transaction.

intent.putExtra("transaction_bundle_key_type_print_ticket", 0)

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:

The Transaction object can have several parameters:

Client & Merchant Tickets

Client and Merchant Tickets are restitued in a JSON Structure.

Each ticket is formatted in ASCII mode and encoded in Base64. This is recommended in order to handle non-alphanumeric data (in alphanumeric), handle carriage returns and small images. .

Currently, it is not possible by PayXpress to export only the client or merchant ticket in the JSON Structure. Both tickets are exported. It is up to the merchant/integrator to filter based on PayXpress reponse what is the desired ticket that you want to use.

Please find bellow example/snipped of Client and Merchant Tickets in JSON Structure:

{
	"tickets": [
		{
			"type": "CLIENT",
			"ticket": "Q0FSVEUgQkFOQ0FJUkUKU0FOUyBDT05UQUNUCkJvbmpvdXIgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCkEwMDAwMDAwNDIxMDEwCkNCCkxFIDI5LzEwLzI0IEEgMTI6Mzk6MzAKRzcgVEVTVCAgICAgICAgICAyMSAKRElKT04gICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAKMDg5OTAxMwoyMDA0MQozMjQzNzk4NjYwMDAxOQpYWFhYWFhYWFhYWFgyODU2CjZDM0U1NEE5N0ZCOENFNzAKODk2IDAwMSAwMDAwMDEgIDAxICBDICAKTrAgQVVUTyA6IApSRUYuIDogCk1PTlRBTlQKNCwwMKBFVVIKREVCSVQKQ0FSVEUgREUgVEVTVApUSUNLRVQgQ0xJRU5UCkEgQ09OU0VSVkVSCk1lcmNpLCBhdSByZXZvaXIuICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCg=="
		},
		{
			"type": "MERCHANT",
			"ticket": "Q0FSVEUgQkFOQ0FJUkUKU0FOUyBDT05UQUNUCkJvbmpvdXIgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCkEwMDAwMDAwNDIxMDEwCkNCCkxFIDI5LzEwLzI0IEEgMTI6Mzk6MzAKRzcgVEVTVCAgICAgICAgICAyMSAKRElKT04gICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAKMDg5OTAxMwoyMDA0MQozMjQzNzk4NjYwMDAxOQoyMDEwCjUwNzEwMDQxNTAxMjI4NTYKNkMzRTU0QTk3RkI4Q0U3MApmaW4gMzAvMDYvMjUKODk2IDAwMSAwMDAwMDEgIDAxICBDICAKTrAgQVVUTyA6IApSRUYuIDogCk1PTlRBTlQKNCwwMKBFVVIKREVCSVQKQ0FSVEUgREUgVEVTVApUSUNLRVQgQ09NTUVSQ0FOVApBIENPTlNFUlZFUgpNZXJjaSwgYXUgcmV2b2lyLiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAo="
		}
	]
}

For a ticket print in the POS

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: