Skip to main content

Partner API (v1)

Download OpenAPI specification:Download

MerchantApi

CreatePaymentIntent

Request Body schema: application/json
required
request_id
string or null

A unique identifier for the request, which can be used for idempotency.

amount
integer <int64>
currency
string or null

Three-letter ISO currency code, in lowercase. Must be a supported currency.

description
string or null

An arbitrary string attached to the object. Often useful for displaying to users.

object or null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

receipt_email
string or null

Email address that the receipt for the resulting payment will be sent to.

success_url
string or null
callback_url
string or null

Responses

Request samples

Content type
application/json
{
  • "request_id": "string",
  • "amount": 0,
  • "currency": "string",
  • "description": "string",
  • "metadata": {
    },
  • "receipt_email": "string",
  • "success_url": "string",
  • "callback_url": "string"
}

Response samples

Content type
application/json
{
  • "transaction_id": "string",
  • "confirm_url": "string",
  • "payment_page_url": "string"
}

GetPaymentIntent

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "request_id": "string",
  • "amount": 0,
  • "currency": "string",
  • "description": "string",
  • "metadata": {
    },
  • "status": "string"
}