Skip to main content
GET
cURL
Anti-Polling Warning: Avoid polling this endpoint; use webhooks for real-time updates. See Anti-Polling Policy.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

setupMethodId
string
required

Unique identifier of the setup method

Response

Setup Method details retrieved successfully

setupMethodId
string

Unique identifier of the setup method

Example:

"sm_sK8d3Jq1tZxPjYVhRQW2rf"

customerId
string

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

Example:

"cus_Tfd3Jq1tZxPjYVhRQW2r3"

currency
string

Three letter abbreviation of the currency

Example:

"USD"

paymentMethods
string[]

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.

Example:
storeFrontId
string

The unique identifier for your storefront

Example:

"sf_sK8d3Jq1tZxPjYVhRQW2rf"

callbackUrl
string

The URL we will callback to once the setup is complete

Example:

"https://example.com/callback"

metadata
object

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

Example:
status
enum<string>

The status of the setup method

Available options:
CREATED,
SUCCESS,
FAILED
Example:

"CREATED"

pmId
string

Unique identifier of the payment method if setup is completed

Example:

"pmt_ftoeKIYGC3f43frT"

intentId
string

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

Example:

"in_ftoeKIYGC3f43frX"

receiptId
string

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

Example:

"recp_123311"