Skip to main content
GET
/
payment-method-token
/
{paymentMethodTokenId}
cURL
curl --request GET \
  --url https://api.xpaycheckout.com/payment-method-token/{paymentMethodTokenId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "paymentMethodId": "pmt_ftoeKIYGC3f43frT",
  "paymentMethod": "CARD",
  "customerId": "cus_Tfd3Jq1tZxPjYVhRQW2r3",
  "status": "LIVE",
  "createdAt": 1727340330123
}
This API allows you to retrieve the details of a payment method token, including its status and associated information.
To get a list of payment method tokens for a customer, use the /customers/payment-method-token endpoint.

Status Values

The payment method token can have one of the following statuses:
  • LIVE: The payment method token is active and can be used for transactions
  • DELETED: The payment method token has been deleted and cannot be used for transactions

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

paymentMethodTokenId
string
required

Unique identifier of the payment method token

Response

Payment method token details retrieved successfully

paymentMethodId
string
required

Unique identifier of the payment method

Example:

"pmt_ftoeKIYGC3f43frT"

paymentMethod
string
required

Type of payment method

Example:

"CARD"

customerId
string
required

Your unique identifier for the customer

Example:

"cus_Tfd3Jq1tZxPjYVhRQW2r3"

status
enum<string>
required

Status of the payment method token. Please refer to payment method token status for more details.

Available options:
LIVE,
DELETED
Example:

"LIVE"

createdAt
integer
required

Epoch timestamp in milliseconds of when the payment method token was created

Example:

1727340330123