Getting Started

Sections

Create Intention

Header Parameters

Authorizationstring

You can get your secret key from your Dashboard

Content-Typestring

Body Parameters

amountnumber Required

The total transaction amount, expressed in cents.

currencystring Required

The currency in which the transaction is processed. This must match the currency of the selected Integration ID.

payment_methodsarray Required

The Integration ID(s) used to process the payment. Values can be provided as integers (e.g., 1256) or as names enclosed in quotes (e.g., "card"). The status (Live/Test) of the provided ID(s) should match the status of the secret key used for authentication.

itemsarray
billing_dataobject
extrasobject

A set of additional custom parameters provided by the merchant. These values are returned in callbacks under the payment key claims object.

special_referencestring

A unique reference associated with the transaction or order, returned in the transaction callback under merchant_order_id.

expirationnumber
notification_urlstring

A callback URL that receives a POST request with full transaction details after the transaction succeeds or fails. Supported with all payment methods.

⚠️ Important Note

The endpoint used in the notification URL will receive the transaction callback (transaction details) and the card token (for pay with saved card features)

redirection_urlstring

A URL to which the customer is redirected after the transaction completes, with transaction details included as query parameters.

⚠️ Important Note

Supported for Card and Wallet payment methods only.

Response

201
Object

Payment Intention created successfully

Response Attributes

payment_keysarray
intention_order_idnumber
idstring
intention_detailobject
client_secretstring
payment_methodsarray
special_referencestring
extrasobject
confirmedboolean
statusstring
createdstring
card_detailstring
card_tokensarray
objectstring
Was this section helpful?

Base URL

Production:

Sandbox:

Language Box

POST

/

Select
1

Response

Was this section helpful?