List Payment Tokens

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

1 { 2 "payment_tokens": [ 3 { 4 "created_at": "2024-06-10T15:22:30Z", 5 "customer_email": "jane.doe@example.com", 6 "customer_name": "Jane Doe", 7 "payment_token": "tok_1A2B3C4D5E6F7G8H9I0J", 8 "lmn_expires_at": "2024-12-31", 9 "payment_methods": [ 10 { 11 "expiration": "11/2025", 12 "last4": "4242", 13 "payment_method_updated_at": "2024-05-01T10:00:00Z" 14 } 15 ] 16 }, 17 { 18 "created_at": "2024-05-20T09:15:00Z", 19 "customer_email": "john.smith@example.com", 20 "customer_name": "John Smith", 21 "payment_token": "tok_0J9I8H7G6F5E4D3C2B1A", 22 "lmn_expires_at": null, 23 "payment_methods": [ 24 { 25 "expiration": "07/2024", 26 "last4": "1234", 27 "payment_method_updated_at": "2024-04-15T08:30:00Z" 28 } 29 ] 30 }, 31 { 32 "created_at": "2024-04-01T12:00:00Z", 33 "customer_email": "alice.williams@example.com", 34 "customer_name": "Alice Williams", 35 "payment_token": "tok_ZYXWVUTSRQPONMLKJIHG", 36 "lmn_expires_at": "2024-08-15", 37 "payment_methods": null 38 } 39 ], 40 "pagination": { 41 "count": 3, 42 "current_page": 1, 43 "last_page": 1, 44 "page_size": 30 45 } 46 }

Lists all payment tokens created with the create_payment_token and create_payment_session endpoints.

This endpoint returns a paginated view of all payment tokens associated with the API key used in the request header, sorted by their created_at date in descending order. Optional search fields are provided to aid in finding the token or tokens associated with a given user.

Lists all payment tokens created with the [`create_payment_token`](/api-reference/payment-tokens/create-payment-token) and [`create_payment_session`](/api-reference/payment-sessions/create-payment-session) endpoints. This endpoint returns a paginated view of all payment tokens associated with the API key used in the request header, sorted by their `created_at` date in descending order. Optional search fields are provided to aid in finding the token or tokens associated with a given user.

Authentication

x-truemed-api-keystring

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

Query parameters

pageintegerOptional

Optional field indicating which page to access. Defaults to 1.

page_sizeintegerOptional

Optional field indicating the number of records per page. Defaults to 30.

emailstringOptional

The email to search for. Partial matches supported, using 'includes' semantics.

namestringOptional

The name to search for. Partial matches supported, using 'includes' semantics.

card_expires_beforestringOptional

Filter payment tokens with cards expiring on or before this month (YYYY-MM format, e.g., ‘2024-06’)

lmn_expires_beforedateOptional

Filter payment tokens with lmns expiring on or before this month (YYYY-MM-DD) format, e.g., ‘2024-06-15’)

Response

Successful response

payment_tokenslist of objects

An array of payment_token objects.

paginationobject or null

A pagination object with information about the current page, page size, total count, and last page.

Authentication

Query parameters

Response

Errors