paymentTokens

List payment tokens with filtering and pagination

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.

get/api/v1/payment_tokens

Request

  • Base URL: https://dev-api.truemed.com
  • URL: https://dev-api.truemed.com/api/v1/payment_tokens
  • Auth: API key in header x-truemed-api-key

Query parameters

pageinteger

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

page_sizeinteger

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

emailstring

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

namestring

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

card_expires_beforestring

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

lmn_expires_beforestring date

Filter payment tokens whose lmn_expires_at is on or before this date (YYYY-MM-DD format, e.g., '2024-06-15'), including tokens whose LMN has already expired.

Response

Successful response

Changes

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