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_token string provided by the payment_token_updated webhook.

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`](/api-reference/payment-tokens/update-payment-token)) to avoid the failure scenarios outlined in our [subscriptions guide](/guides/subscriptions/subsequent-billing-periods). ## Request Notes **Path Params:** - **payment_token** (Required): The `payment_token` string provided by the [`payment_token_updated`](/api-reference/payment-tokens/payment-token-updated-webhook) webhook.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Path parameters

payment_tokenstringRequired

The payment token to get details for

Response

Successful response

created_atstring

ISO 8601 formatted date and time the payment_token was created at.

customer_emailstring

The email address for the customer associated with this payment_token.

customer_namestring

The first and last name of the customer associated with this payment_token.

payment_tokenstring

The payment token identifier.

lmn_expires_atstring or null

ISO 8601 formatted date when the earliest LMN associated with this payment token expires. Null if no verified LMN exists. Partners should prompt users to re-qualify before this date.

payment_methodslist of objects or null

An optional array of payment_method objects.

1	import requests
2
3	url = "https://dev-api.truemed.com/api/v1/payment_tokens/payment_token"
4
5	headers = {"x-truemed-api-key": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"created_at": "2024-05-10T09:15:30Z",
3	"customer_email": "jane.doe@example.com",
4	"customer_name": "Jane Doe",
5	"payment_token": "pt_1Hh1X2AbCdEfGhIjKlMnOpQr",
6	"lmn_expires_at": "2025-04-30",
7	"payment_methods": [
8	{
9	"expiration": "11/2026",
10	"last4": "4242",
11	"payment_method_updated_at": "2024-04-20T14:22:00Z"
12	}
13	]
14	}

Request Notes

Authentication

Path parameters

Response

Errors

Request Notes