Initiate Payment Intent

post

https://{brand_domain}/api/v1/payments

Initiates a new payment session by creating a payment intent. Returns a secure, white-labeled checkout URL
where customers can choose from the brand's active payment methods (such as Mobile Financial Services (MFS) e.g., bKash, Nagad, Rocket).
Validates callback URLs against transport safety regulations, truncates customer PII properties to fit database constraints,
and resolves/creates customer profile bindings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

string

required

Positive numeric string representing the transaction volume (2 decimal places).

currency

string

required

3-letter ISO currency code. Must be registered and supported by the platform (e.g. BDT, USD).

callback_url

uri

Webhook payload URL where transaction completion callbacks are POSTed. Must use HTTP or HTTPS.

redirect_url

uri

Redirection target URL where the user is returned after a successful checkout session.

cancel_url

uri

Redirection target URL where the user is returned if they cancel the payment session.

customer_email

string

Customer email address. Used for identity verification and mapping.

customer_name

string

Customer full name (max 150 characters).

customer_phone

string

Customer phone number (max 30 characters).

reference

string

Internal order reference or invoice identifier.

gateway

string

Request routing through a specific payment gateway slug (optional).

metadata

object

Key-value map for merchant custom details.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Payment session initiated successfully.

422Validation failed (e.g. invalid amount format, unsupported currency, or invalid URL schemes).

500Payment processing/initiation failed on the server.