Skip to main content
GET
/
setup-method
/
{setupMethodId}
cURL
curl --request GET \
  --url https://api.xpaycheckout.com/setup-method/{setupMethodId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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"
}
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

Your unique identifier for the customer

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:
["CARD", "GOOGLE_PAY", "APPLE_PAY"]
ā€‹
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:
{
  "orderId": "12345",
  "customerNote": "Setup for recurring payments"
}
ā€‹
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"

āŒ˜I