The Android Intent API allows merchant to interact directly with payment terminals through Android devices. It provides functions to manage payment transactions, and receipts, and integrates with other systems seamlessly. The API supports real-time payment processing, multi-device compatibility, and offers a variety of tools for both testing and production environments.
<aside> đź’ˇ This API only accepts parameters following the camelCase convention
</aside>
The current API integration version is v4 which takes a first-order position in endpoints.
| API Version | Documentation | Last updated date |
|---|---|---|
v4 |
- | August 22, 2024 |
v1 |
- | May 2, 2022 |
These objects are used in several API routes, for each use, the context is clearly highlighted.
Customer
| Parameters | Type | Default value | Required | Description |
|---|---|---|---|---|
firstName |
String | no | First name of the customer | |
lastName |
String | no | Last name of the customer | |
email |
String | no | Email of the customer | |
phone |
String | no | Phone number of the customer with the international format starting with + symbol (eg: +33612345678) |
|
birthDate |
String | no | Birthdate of the customer |
ReceiptTicket
| Parameters | Type | Default value | Required | Description |
|---|---|---|---|---|
data |
String | yes | Data to print | |
format |
String | text | no | Format of data to print |
tax |
Array | no | See Tax Object |
Tag info
| Parameters | Type | Default value | Required | Description |
|---|---|---|---|---|
serialNumber |
String | null | no | Tag identifier |
Tax
<aside> ⚠️
This is the only object in snake_case convention
</aside>
| Parameters | Type | Default value | Required | Description |
|---|---|---|---|---|
tax_amount |
Integer | null | no | Calculated tax amount depending on the associated tax_percentage applied to the transaction amount |
tax_percentage |
Integer | null | no | Percentage applied to the transaction amount, giving tax_amount (e.g: 20 for 20%) |
Transaction
| Parameters | Type | Default value | Required | Description |
|---|---|---|---|---|
amount |
String | yes | Amount of the transaction in cents, this field must be positive | |
giftAmount |
String | null | no | Tips or donation in cents |
appVersion |
String | yes | Version of Pay app | |
createdAt |
String | yes | Date of creation in the Yavin database | |
currencyCode |
String | yes | Currency code, this parameter is in ISO 4217 (eg: € is equal to EUR) |
|
status |
String | yes | Status of the transaction | |
transactionId |
String | yes | Identifier of the transaction | |
localId |
String | yes | Local identifier of the transaction | |
serialNumber |
String | yes | Terminal identifier from which the transaction has been made | |
paymentApplication |
String | null | no | Payment application of the transaction (eg: EMV_CONTACTLESS) |
scheme |
String | null | no | Acceptance network of the transaction (eg: VISA) |
issuer |
String | null | no | Issuer of the card used for the transaction |
reference |
String | null | no | Waiter or person who performed the transaction if feature used |
transactionType |
String | yes | Type of the transaction (eg: debit) | |
clientTicket |
String | null | no | Client ticket |
companyTicket |
String | null | no | Merchant ticket |
pan |
String | null | no | PAN of the card used for the transaction |
id |
Integer | yes | ||
description |
String | null | no | |
ticketUrl |
String | yes | URL of the digital client ticket |
Vendor
| Parameters | Type | Default value | Required | Description |
|---|---|---|---|---|
softwareName |
String | no | Name of POS software | |
softwareVersion |
String | no | Version of POS software - this could be useful to help track and identify bugs as quickly as possible |