Skip to main content

API Introduction

Welcome to our API documentation! This guide will help you understand how to use our API effectively.

Getting Started​

To get started with our API, you'll need to understand a few basic concepts.

What is an API?​

An API (Application Programming Interface) is a set of rules and protocols that allows different software applications to communicate with each other. It defines the methods and data formats that applications can use to request and exchange information.

Authentication​

Most API requests require authentication. Make sure you have your API key ready. You can find more details in the Authentication section.

API Categories​

NeoPaaS provides two main categories of APIs for transaction retrieval and management: B2B APIs and Client APIs.
Each serves a distinct purpose and applies to different usage scenarios.

B2B APIs​

Scope: Merchant-level (all associated terminals)
Purpose: Designed for merchants and ECR partners to retrieve transaction data across all their terminals for reporting, settlement, and reconciliation.

Available B2B APIs​

  1. Get Transaction by ID/UUID

    • Retrieves a single transaction using its id or uuid.
    • The id/uuid can be found in the merchant portal or in a transaction API response.

  2. Get Bulk Transactions (Filtered by Date Range)

    • Retrieves all transactions across all merchant terminals within a given date range.
    • Useful for reconciliation, settlement checks, and financial reporting.

When to use B2B APIs:

  • Merchant or ECR server integrations.
  • When you need all transactions regardless of terminal.
  • For back-office processes (reporting, settlement, auditing).

Client APIs​

Scope: Terminal-level (single specific terminal)
Purpose: Allows terminal/client app users (e.g., cashiers) to query transactions directly related to their device.

Available Client APIs​

  1. Get Last Transaction

    • Retrieves the most recent transaction for the terminal.
    • Helps cashiers confirm whether a transaction went through in case of connectivity issues.

  2. Get Transaction by Reference Number

    • Retrieves a transaction by the original reference number used during purchase.
    • Ensures cashiers can track a specific transaction from the client app records.

When to use Client APIs:

  • On the client app/terminal side for quick checks.
  • For cashier-level troubleshooting (e.g., confirming last transaction status).
  • When the merchant wants transaction data only for a specific terminal.

API Endpoints​

Our API provides several endpoints to access different resources. Each endpoint will be detailed in the subsequent sections of this documentation.

Making Requests​

You can make requests to our API using standard HTTP methods like GET, POST, PUT, and DELETE. The specific method to use will depend on the action you want to perform.

Example Request​

Here's an example of how to make a GET request to a hypothetical /users endpoint:

curl -X GET "https://api.example.com/v1/users" -H "Authorization: Bearer YOUR_API_KEY"

Responses​

The API will return responses in JSON format. Successful requests will typically return a 200 OK status code, while errors will be indicated by other status codes (e.g., 400 Bad Request, 401 Unauthorized, 404 Not Found, 500 Internal Server Error).

Example Response​

{
  "data": [
    {
      "id": 1,
      "name": "User One"
    },
    {
      "id": 2,
      "name": "User Two"
    }
  ],
  "status": "success"
}

We hope this introduction helps you get started. Explore the rest of the documentation to learn more about specific API features and endpoints.