Versions Compared

Version Old Version 16 New Version Current
Changes made by

Juan BARRAZA

Rémi DEROM

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

...

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.

...

  • The PayXpress v4 app must be installed in the terminal.

  • It is possible to call PayXpress with our parameters only via Intent calls. (For detailed information on the android intent api, please consult the official Android documentation : https://developer.android.com/training/basics/intents, here is a sample application with examples of how to get started :

    View file
    nameintent-call-test.zip
    )

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.

...

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

Code Block
languagekotlin
intent.putExtra("transaction_bundle_key_action", "PRINT_LAST")

intent.putExtra("transaction_bundle_key_type_print_ticket", 0)

...

Parameter

Description

Format

Type

Mandatory

transactionIdid

Id of the transaction

/

String

Yes

transactionType

Type of the transaction

0: Debit

1: Refund / Credit
2: Cancellation

8: Deferred debit

Integer

Yes

mode

Type of transaction / Payment method

0: Contact

1: Contactless

Integer

Yes

date

Date’s timestamp

171017239300

Long

Yes

reference

Reference of the transaction transmitted as input

/

String

No

amount

Amount of the transaction

100: 1,00 €

1050: 10,50 €

Integer

Yes

currency

Currency of the transaction

/

String

Yes

aid

Selected AID during the transaction

/

String

No

isDegradedMode

Transaction without network / offline ?

true: Transaction without network / offline

false: Transaction with network / online

Boolean

No

error

Outcome of the transaction

0: Accepted

1: Denied

2: Invalid parameters

3: Transaction already in progress

4: Application in background

5: Error

6: Reference already exists

7: Cancelled

8: Not finished

9: Timeout

Yes

maskedPan

Masked PAN of the card

/

String

No

cardLabel

Type of card used

/

String

No

expirationDate

Expiration date of the card

250630

Integer

Yes

amountTips

Amount of the tips (in case the functionality is activated)

100: 1,00 €

1050: 10,50 €

Integer

No

panType

Type of PAN (Partial PAN when nothing returned)

0: Full PAN

1: Partial PAN

2: Token

Integer

No

numAuthorization

Authorization number if provided by the bank

/

String

No

...

Parameter

Description

Format

Type

Mandatory

status

Outcome of the print

0: Printing is successful

1: Printing has failed

Integer

Yes

tickets

Client & merchant tickets

see JSON description.

String

No

Note:

  • For the device without integrated printer, the status will be always 0 (successful).

  • Tickets data returned from intent call will always return client and merchant ticket in base64.