Retrieve Payment Token
Get data back for a given payment_token.
This endpoint returns details about the payment_token specified in the URL path.
This endpoint can be used to populate information on a user facing dashboard,
such as the last 4 of the card(s) on file and the expiration dates.
Partners should store expiration dates of cards on file and preemptively encourage
users to update their payment methods (using a call to
update_payment_token) to avoid the failure scenarios
outlined in our subscriptions guide.
Request Notes
Path Params:
- payment_token (Required): The
payment_tokenstring provided by thepayment_token_updatedwebhook.
Authentication
Sales channel API key for merchant server-to-server authentication
Path parameters
Response
ISO 8601 formatted date and time the payment_token was created at.
The email address for the customer associated with this payment_token.
The first and last name of the customer associated with this payment_token.
ISO 8601 formatted date when this payment token’s HSA/FSA coverage ends (inclusive, UTC). Counts letters earned on the token’s own sessions and letters its customer earned on this sales channel, matching the date the Payment Token Updated webhook reports for the same token. Null if the customer holds no verified LMN. Prompt the customer to requalify before this date.
An optional array of payment_method objects.