List all credit cards registered on this platform

You may have one or multiple credit cards registered on your platform. Use this Tango API endpoint to retrieve all credit cards registered on your platform. This endpoint supports filtering, pagination, and detailed query parameters to help developers manage and audit stored payment methods.

Use case

Acme Health has multiple departments (e.g., Cardiology, Primary Care, Pediatrics) running separate incentive programs. Each department registers its own payment cards, and finance leadership needs visibility into which cards exist, who owns them, whether they’re active, whether they’re close to expiration, which patient programs they're tied to, and whether inactive or unused cards should be disabled. Using the Tango API, Acme Health integrates this endpoint into its system to maintain a secure, compliant, and centralized view of all payment cards funding the incentive programs.

Previously, these were tracked manually in spreadsheets—leading to errors, security risks, and compliance challenges.

Endpoint

Use the following endpoint to list all credit cards that are registered on your platform:

Endpoint	Description
`GET {URI}/creditCards`	List all credit cards registered on this Platform.

Parameters

The following parameters are used with this endpoint. Use paginate below for better payload management:

Query Params	Data type	Description
paginate	boolean	Whether to paginate the results or not. -true:paginate the results. -false: not to paginate the results. False is the default.
prevCursor	string	The cursor to use for the previous page of results. This will be ignored if paginate is false.
nextCursor	string	The cursor to use for the next page of results. This will be ignored if paginate is false.
maxResults	int32	The maximum number of results to return. The default is 10, and the maximum is 200. This will be ignored if paginate is false.
showInactive	string	Show inactive cards (true or false).
accountNumber	string	Specify the account number to be queried.
accountIdentifier	string	Get cards associated with a specific account
customerIdentifier	string	Specify the customer identifier to be queried.
token	string	Credit card token to be queried.
expirationDate	string	Specify the expiration date of the credit card to be queried.
status	string	Get cards with specific status. When set, this option will override the `showInactive` parameter. Show the status as active or inactive.
emailAddress	string	Specify the contact email address to be queried.
fullName	string	Contact person's full name to be queried.
label	string	Label for the credit card to be queried.
lastFourDigits	string	The last four digits of the credit card to be queried.

Examples

The following example shows the payload using this endpoint:

[
  {
  "prevCursor": null,
  "nextCursor": null,
  "prevPageAvailable": false,
  "nextPageAvailable": false,
  "maxResults": 10,
  {
    "customerIdentifier": "string",
    "accountIdentifier": "string",
    "token": "string",
    "label": "string",
    "lastFourDigits": "string",
    "expirationDate": "string",
    "status": "string",
    "createdDate": "2024-02-09T04:41:08.735Z",
    "activationDate": "2024-02-09T04:41:08.735Z",
    "contactInformation": [
      {
        "fullName": "string",
        "emailAddress": "string"
      }
    ],
    "accountNumber": "string"
  }
]

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

Response codes

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

Response code	Meaning
200	The request was successful.
400	The server could not understand the request due to invalid syntax.
401	Authentication is required and has either not been provided or failed.
403	The server understood the request but refuses to authorize it.
404	The server could not find the requested resource. In other words, the URL you’re trying to access doesn’t point to anything that exists on the server.
500	Something went wrong on the server, but the server cannot be more specific about what the exact problem is.
503	The server is currently unable to handle the request due to temporary overload or maintenance.