Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26336777.7 KB

Charge a payment using a tokenized payment method

post/payments/charge-tokenised-pm

Headers

Idempotency-Keystring

A unique key for making the request idempotent. Must match pattern: ^[a-zA-Z0-9\-_:\.]+$. See Idempotent Requests for more details.

Request body

pmIdstring required

Unique identifier of the payment method to charge

customerIdstring required

The unique identifier for the customer, generated via the create-customer API

currencystring required

Three letter abbreviation of the currency

amountinteger required

The amount in lowest count unit (e.g., cents for USD)

receiptIdstring

Your identifier of the order

storeFrontIdstring

Unique identifier of the storefront

metadataobject

A collection of key-value pairs that can be attached to an object for storing additional structured information

Example request

{
  "pmId": "pmt_ftoeKIYGC3f43frT",
  "customerId": "cus_Tfd3Jq1tZxPjYVhRQW2r3",
  "currency": "USD",
  "amount": 1000,
  "receiptId": "order123",
  "storeFrontId": "sf_sadfsdfsdf213dsaf",
  "metadata": {
    "orderId": "12345",
    "customerNote": "Charge for recurring payments"
  }
}

Response

Payment charged successfully

intentIdstring

Unique identifier of the payment intent

statusstring

The status of the payment intent. Refer payment intent status

errorCodestring

Error code if the operation was not successful

Example response

{
  "intentId": "in_dHd3Jq1tZxPjYVhRQW2r3",
  "status": "SUCCESS",
  "errorCode": "card_declined"
}