The Cloud API allows merchants to initiate transactions, retrieve transaction history, share receipts, and more through HTTPS requests. It uses API key-based authentication for security and supports various payment methods. This API is flexible, working with multiple devices, and supports asynchronous payment processing via webhooks for streamlined integration with payment terminals.
<aside> đź’ˇ Tips for the Cloud API
The Cloud API allows youTo initiate an action on the terminal, it is communicated to the terminal through a notification sent via the Yavin server. The validity of this notification is constrained to a time window of 5 seconds. If the notification is not received by the terminal within this timeframe - potentially due to the terminal being offline - the action is considered expired and will not be retransmitted once the terminal is reconnected.
</aside>
The current API integration version is v5 which takes a first-order position in endpoints.
| API Version | Documentation | Last updated date |
|---|---|---|
v5 |
- | August 22, 2024 |
v1 |
- | May 2, 2022 |
<aside> đź’ˇ This API only accepts parameters following the snake_case convention
</aside>
These objects are used in several API routes, for each use, the context is clearly highlighted.
Customer
| Parameters | Type | Default value | Required | Description |
|---|---|---|---|---|
first_name |
String | no | First name of the customer | |
last_name |
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) |
|
birth_date |
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 |
Tax
| 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 | |
gift_amount |
String | null | no | Tips or donation in cents |
app_version |
String | yes | Version of Pay app | |
created_at |
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 | |
transaction_id |
String | yes | Identifier of the transaction | |
local_id |
String | yes | Local identifier of the transaction | |
serial_number |
String | yes | Terminal identifier from which the transaction has been made | |
payment_application |
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 |
transaction_type |
String | yes | Type of the transaction (eg: debit) | |
client_ticket |
String | null | no | Client ticket |
company_ticket |
String | null | no | Merchant ticket |
pan |
String | null | no | PAN of the card used for the transaction |
id |
Integer | yes | ||
description |
String | null | no | |
ticket_url |
String | yes | URL of the digital client ticket |
Vendor
| Parameters | Type | Default value | Required | Description |
|---|---|---|---|---|
software_name |
String | no | Name of POS software | |
software_version |
String | no | Version of POS software - this could be useful to help track and identify bugs as quickly as possible |
Webhook