API Reference

This is the API reference for Grid Checkout API.

Request authentication

• In Grid Console, you need to generate an Access Token under the "Developer" tab.
• Add x-api-key in the request header, with the generated access token value.

Base API URL overview

The {baseUrl} for the Grid Checkout API is determined by the data residency of your tenant.

Regional Grid Checkout base API URLs:

• The standard base URL for most API operations is structured as follows: https://api.omborigrid.com/regions/{dataResidency}/phycheckout/api/tenants/{tenantId}

• The {tenantId} parameter should be substituted with your specific tenant ID, which can be found in your Grid console.

The following endpoints are available in the API:

GET Transaction by ID

Retrieves a specific transaction by ID

GET {baseUrl}/api/tenants/{tenantId}/transactions/{transactionId}

Response

{
    data: Transaction
}

Reference: Transaction

Query Parameters

GET Transactions

Retrieves a list of transactions based on specified query parameters.

GET {baseUrl}/api/tenants/{tenantId}/transactions

Query Parameters

To use query parameters, add them as GET properties to the URL.

Response

{
    items: Array<Transaction>,
    page: number,
    totalPages: number,
    totalItems: number,
    limit: number,
}

Reference: Transaction