Sign in
Confirmation Tokens

Retrieve Confirmation Token

Retrieves a token's payment method and billing details — never the underlying payment credential. Public and rate-limited: the account_id query param must match the account the token was minted for. A bearer credential with payment:basic:read on that account also receives the collected billing address.

get/confirmation_tokens/{id}

Query parameters

account_idstring required

The account (biz_) the token was minted for.

Response

confirmation token retrieved

created_atstring required

When the token was created, as an ISO 8601 timestamp.

expires_atstring required

When the token expires, as an ISO 8601 timestamp. Tokens are single-use and short-lived.

idstring required
objectstring required

Always confirmation_token.

setup_future_usagestring nullable required

Save-consent state the element displayed at collection: off_session, on_session, or null. Confirm may vault only if attested here.

status'pending' | 'consumed' | 'expired' required

pending until it is used, then consumed; expired once its short lifetime elapses. Only a pending token can be charged.

Example response

{
  "billing_address": {
    "city": "Austin",
    "country": "US",
    "line1": "1114 Bouldin Ave",
    "line2": "Unit B",
    "name": "Dana Whitfield",
    "postal_code": "78704",
    "state": "TX"
  },
  "billing_details": {
    "country": "AR",
    "email": "marcus@shinetime.example",
    "name": "Buyer Name",
    "postal_code": "C1043"
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "expires_at": "2026-01-01T12:00:00.000Z",
  "id": "ctok_xxxxxxxxxxxxxx",
  "object": "confirmation_token",
  "payment_method_preview": {
    "bank_debit": {
      "brand": "visa",
      "fingerprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "last4": "4242"
    },
    "card": {
      "brand": "visa",
      "fingerprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "last4": "4242"
    },
    "category": "saved",
    "display_name": "Visa •••• 4242",
    "id": "payt_xxxxxxxxxxxxxx",
    "saved": {
      "brand": "visa",
      "fingerprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "last4": "4242"
    },
    "type": "card",
    "wallet": {
      "brand": "visa",
      "fingerprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "last4": "4242"
    }
  },
  "setup_future_usage": "off_session",
  "status": "pending"
}

Changes

Changed in 2 of the 74 revisions of this API.3

  • 73dd0533cd812See the full diff
    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 1b5d50d094791See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 74 revisions, 1 has no diff computed.