Skip to content

Payment API Documentation

The API allows merchants to integrate with payment flows and manage payment operations programmatically.

This documentation currently covers the main payin and payout flows, order retrieval, webhook notifications, request signing, and balance retrieval.

Documentation scope

Additional endpoints, examples, and operational details will be added as the API documentation expands.

Overview

The API provides endpoints for creating payment orders, submitting additional payment data when required, retrieving order information, receiving final order status notifications, and checking balance data.

The API is designed for merchant-side integrations where payment operations are initiated and tracked from the merchant system.

Integration Flow

A typical integration flow consists of the following steps:

  1. Authenticate API requests using X-Api-Key-Id, X-Signature, and X-Timestamp.
  2. Create a payin or payout order.
  3. For host-to-host card payin integrations, submit card data for the created order.
  4. Retrieve order details when needed by ID, reference ID, or filtered list.
  5. Receive final order status notifications through webhooks.
  6. Reconcile available funds using the Balances endpoint.

Authentication

Most API requests require the following headers:

  • X-Api-Key-Id identifies the API key used for the merchant integration.
  • X-Signature contains the request signature generated from the HTTP method, path, raw request body, and timestamp.
  • X-Timestamp contains the Unix epoch timestamp in seconds.

For requests without a body, the signature base string uses an empty request body value.

Request Signature AuthenticationLearn how to generate and verify request signatures.›

Payin Orders

Payin endpoints are used to create and track incoming payment orders.

For host-to-host card integrations, the merchant first creates a payin order and then submits card data for the created order.

Create Payin OrderCreate an incoming payin order.›

Submit Payin Card DataSubmit card data for host-to-host payin processing.›

Payin Order RetrievalRetrieve payin orders by ID, reference ID, or filtered list.›

Payout Orders

Payout endpoints are used to create outgoing payment orders to an external destination account.

After a payout order is created, the merchant can retrieve its state by order ID, by merchant reference ID, or through a filtered paginated list.

Create Payout OrderCreate an outgoing payout order.›

Payout Order RetrievalRetrieve payout orders by ID, reference ID, or filtered list.›

Webhooks and Balances

Webhook notifications are sent when a payin or payout order reaches a final status.

Final statuses currently include SUCCESS, FAILED, and CLOSED.

Webhook requests are sent as POST requests with an application/json payload and an X-Signature header. The merchant webhook endpoint should return any 2xx HTTP status to confirm successful delivery.

The Balances endpoint returns merchant balance data grouped by currency, including wallet-level balance data and gate-level balance information.

WebhooksReview webhook payloads, headers, and delivery expectations.›

BalancesRetrieve wallet-level and gate-level balance information.›