Skip to main content
POST
/
partner-connect
/
transactions
/
purchase
Error
A valid request URL is required to generate request examples
{
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "locked",
  "amountAuthorized": 100,
  "currency": "USD",
  "authorizationExpiry": "2023-11-07T05:31:56Z",
  "cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "refId": "CT6KQDDEC2"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Requires the cardId, transaction details (amount, currency, description), and the otpToken in the request body.

​
cardId
string<uuid>
required

Identifier of the card to be used for the transaction.

​
amount
number<float>
required

Requested transaction amount.

Required range: x >= 0.01Must be a multiple of 0.01
Example:

100

​
currency
string
required

Currency code (ISO 4217) of the transaction amount.

Required string length: 3
Example:

"USD"

​
description
string
required

Description of the transaction (e.g., store details).

Example:

"Order #123"

​
otpToken
string
required

The verification code for authorizing the transaction.

Example:

"123456"

Response

Transaction successfully authorized. Funds are locked on the cardholder's account, awaiting capture or release. The response contains the transactionId and authorization details.

​
transactionId
string<uuid>
required

A unique identifier (UUID) for this specific transaction authorization. Store this ID securely, as it's required to capture or release the funds.

​
status
enum<string>
required

The current status of the transaction, which will be locked after successful authorization.

Available options:
locked,
captured,
void,
refunded
​
amountAuthorized
number<float>
required

The actual amount authorized for the transaction, formatted to 2 decimal places.

Required range: x >= 0.01Must be a multiple of 0.01
Example:

100

​
currency
string
required

Currency code (ISO 4217) of the authorized amount.

Required string length: 3
Example:

"USD"

​
authorizationExpiry
string<date-time>
required

The timestamp (ISO 8601 format) when this authorization will automatically expire if it is not captured or released.

​
cardId
string<uuid>

The unique identifier (UUID) assigned to the successfully bound card. Store this cardId securely, as it is required to reference this card in all subsequent transaction requests (/verify, /purchase, etc.).

​
refId
string

A unique transaction identifier provided for the client’s reference. It can be used to track or correlate transactions

Example:

"CT6KQDDEC2"