Retrieve a setup token

Returns a readable representation of temporarily vaulted payment source associated with the setup token id.

get/v3/vault/setup-tokens/{id}

Request

Base URL
https://api-m.paypal.com
Auth
OAuth 2
Client credentials
Token URL/v1/oauth2/token
Scopeshttps://uri.paypal.com/services/vault/payment-tokens/read
TypeScript
https://skmtc.dev/paypal/apis/payments/docs/v3/vault/setup-tokens/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

ID of the setup token.

Found requested setup-token, returned a payment method associated with the token.

idstring

The PayPal-generated ID for the vault token.

status'CREATED' | 'PAYER_ACTION_REQUIRED' | 'APPROVED' | 'VAULTED' | 'TOKENIZED'

The status of the payment token.

No recorded changes to this operation across all 1 revision of this API.