Payment: Overview

What is a Payment?

This section introduces core API methods and status flows for handling payments, including intent creation, authorisation, capture (manual or auto), and cancellation, with support for multiple payment methods

Terminology

Entity	Description
Intent	A container that groups one or more payments representing a user's intention to pay.
Payment	A single transaction representing the movement of funds, typically authorised and captured separately. Auto-capturing is supported if configured.
Capturing Delay	The maximum allowable time between a successful authorisation and the point by which the payment must be captured. If capture is not initiated within this window, the authorisation may expire or require cancellation.
Authorization	The process of verifying and reserving the required amount on the payer’s account, without transferring funds until a capture is performed.
Capturing	The action of finalising an authorised payment by transferring the reserved funds from the payer’s account to the recipient.
Cancellation	The process of voiding an authorised payment before it is captured, ensuring that no funds are withdrawn from the payer’s account.
Auto-Capturing	A configuration that triggers the capture of funds automatically immediately after authorisation, without requiring a separate capture request.

High-Level Payment Process

Endpoint	Short Name
`POST /api/v1/intents`	Initiate the creation of a  new intent with payments
`PATCH /api/v1/payments/{id}`	Initiates a payment status change. Possible values include: CAPTURED, CANCELLED
`GET /api/v1/payments/{id}`	Retrieve the payment details and its current status
`GET /api/v1/payments`	Get the list of payments by a Payment Instrument Fingerprint

Auto-Capture Applicability

Auto-Capture refers to the automatic process of capturing a previously authorised payment without requiring an explicit capture request from the client.

When Auto-Capture is enabled, the system automatically finalises the authorised payment by transitioning it to a captured (settled) state based on predefined configuration. This simplifies integration and ensures that payments are processed quickly and efficiently without additional API interaction.

Key Characteristics

Eliminates the need for a separate API call to capture payments.
Capture typically occurs immediately after authorisation but may be delayed (e.g. at end-of-day or after a defined interval), depending on configuration.
Ideal for merchants who do not require order fulfilment checks prior to settlement.
Reduces the window for cancellation, since the transaction quickly proceeds beyond the Authorised state.

Cancellation Behaviour

Transactions can only be cancelled while they remain in the Authorized state or any earlier stage.
If Auto-Capture is enabled, the transaction will automatically transition to the Captured state shortly after authorisation — effectively bypassing the opportunity to cancel unless action is taken immediately.

If the cancellation window is missed and the transaction reaches the Captured state, a refund must be initiated instead. Refunds are processed as separate operations and may be subject to different rules, processing times, and reconciliation procedures compared to authorisation cancellations.

⚠️
Important:
Merchants who require a manual review or cancellation window after authorisation should either disable Auto-Capture or use delayed capture settings, where supported.

Supported Payment Methods and Their Codes

List of supported payment methods is available on the link Supported Payment Methods

Payment Structure

Attribute	Description
`ID`	Unique identifier of the payment generated by the platform.
`Status`	Current state of the payment (e.g. `ACCEPTED`, `AUTHORISED`, ...)
`PartnerReferencePaymentId`	Optional external reference provided by the partner for tracking or reconciliation purposes.
`SubmittedAmount`	The amount and currency submitted by the payer in the original transaction request.
`AuthorizedAmount`	The amount and currency successfully authorised (can differ due to FX or fees).
`ExchangeRate`	The FX rate used for currency conversion if applicable.
`ExchangeSource`	Indicates the origin FX Rate Data Source used
`PaymentMethodInstanceDetails`	Identifier of the specific payment method instance used.
`PartnerInfo`	Details of a partner that was entrusted .... .
`ClientInfo`	Admin and Settlement Account IDs
`SettlementAccountDetals`	ID of the account where the funds will eventually be settled.
`PayerInfo`	Object containing the payer’s personal and contact details, including name, phone, email, and locale information.
`BillingAddressInfo`	Object containing the billing address details of the payer, used for verification or compliance checks.

Payment Status Model

Download high-resolution Payment Status Model

The following table summarizes the statuses a payment may go through:

Status	Description
ACCEPTED	You submitted a payment request. We verified and accept it, and it has been queued for sending for authorization or capturing (depending on your settings) on our side.
AUTHORIZATION_REQUESTED	We forwarded your authorisation request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending.
AUTHORIZED	The payment method has authorised the requested amount on the payer’s account. Following authorisation, the funds may either be captured through a capture request or released via a cancellation request.
CAPTURE_ REQUEST_ACCEPTED	After successful authorization, you submitted a capture request. We verified and accept it, and it has been queued for processing.
CAPTURE_ REQUESTED	We forwarded your capturing request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending.
CAPTURED	The payment method has captured the authorized amount on the payer’s account.
DECLINED	The payment may be declined during authorisation (e.g. insufficient funds or account issues) or during capture (e.g. expired authorisation or policy violations).
EXPIRED	The authorisation period has expired — the time window between authorisation and capture or cancellation elapsed without action.
CANCELLATION_ REQUEST_ACEPTED	After successful authorization, you submitted a cancellation request. We verified and accept it, and it has been queued for processing
CANCELLATION_ REQUESTED	We forwarded your cancellation request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending.
CANCELLED	The payment method has released the authorized amount on the payer’s account and cancelled the payment.
ERROR	The payment failed due to a technical issue; a retry may be required.