Confirmation Tokens

Retrieve Confirmation Token

Changed on

Retrieves a confirmation token's payment method and billing details, never the underlying payment credential, to display what the buyer chose or check that the token is still usable. Requires no authentication and is rate-limited.

get/confirmation_tokens/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/confirmation_tokens/{id}
  • Auth: one of:
    • none
    • HTTP bearer

Query parameters

account_idstring required

The account the token was minted for, prefixed biz_. It must match the token's account.

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

  • c771dc00bca6Revision changes
    • warning

      added the new card_present enum value to the / response property for the response status

  • 73dd0533cd81Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      added the required property to the response with the status