Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26336777.7 KB

Get details of a setup method

get/setup-method/{setupMethodId}

Path parameters

setupMethodIdstring required

Unique identifier of the setup method

Response

Setup Method details retrieved successfully

setupMethodIdstring

Unique identifier of the setup method

customerIdstring

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

currencystring

Three letter abbreviation of the currency

paymentMethodsstring[]

List of payment methods enabled for setup.

💡 If a selected payment method is unavailable, the system will automatically fallback to card payments to ensure a smooth checkout experience.

storeFrontIdstring

The unique identifier for your storefront

callbackUrlstring

The URL we will callback to once the setup is complete

metadataobject

A collection of key-value pairs that were provided when the object was created

status'CREATED' | 'SUCCESS' | 'FAILED'

The status of the setup method

pmIdstring

Unique identifier of the payment method if setup is completed

intentIdstring

Unique identifier of the successful payment intent created while setting up the payment method token. Present only when amount is passed during setup creation.

receiptIdstring

Your identifier for the order. Present only when provided during setup method creation.

Example response

{
  "setupMethodId": "sm_sK8d3Jq1tZxPjYVhRQW2rf",
  "customerId": "cus_Tfd3Jq1tZxPjYVhRQW2r3",
  "currency": "USD",
  "paymentMethods": [
    "CARD",
    "GOOGLE_PAY",
    "APPLE_PAY"
  ],
  "storeFrontId": "sf_sK8d3Jq1tZxPjYVhRQW2rf",
  "callbackUrl": "https://example.com/callback",
  "metadata": {
    "orderId": "12345",
    "customerNote": "Setup for recurring payments"
  },
  "status": "CREATED",
  "pmId": "pmt_ftoeKIYGC3f43frT",
  "intentId": "in_ftoeKIYGC3f43frX",
  "receiptId": "recp_123311"
}