🏁 Get started

Introduction

Welcome to the Yavin API Documentation!

The Yavin API allows developers and integrators to seamlessly integrate payment functionalities into their own user journeys. Whether you need to process payments, print receipts, or access transaction data, our API provides the tools to do so efficiently.

Here are potential use cases: Payment on terminal, Click & Collect online payment, Order & Pay via QR code, Pay at Table via QR code

Integration Options:

Our API accepts two major use cases of integrations:

• In-store payment : Any application, whether installed on the payment device itself or on a different device, can launch a payment from their interface, without interacting with our application. This use case can be completed using 3 different types of integration
  • Local Integration: Perfect for an integration when the POS application is not on the same device than the Yavin payment application, but on the same wifi network.
  • Cloud Integration: Ideal for an integration when the POS application is not on the same device than the Yavin payment application, but not on the same wifi network. Is perfect as well for web-based POS systems.
  • Android Intent Integration: Perfect for an integration when the POS application and the Yavin payment application are on the same device.
• Online payement :
  • E-commerce Integration: Designed for managing online payment transactions.

For detailed guides and examples on each integration type, visit the corresponding section in the documentation.

Getting Started:

• Step 1: Review our Authentication Guide to set up your API credentials.
• Step 2: Check out the Quick Start Guide to make your first API call.
• Step 3: Dive deeper into specific use cases through the detailed endpoint documentation.

Need Assistance?

If you have an Android app and wish to deploy directly on Yavin terminals, or if you encounter any issues, feel free to contact us for support and partnership opportunities.