Retrieve information about Card-on-Files

get

https://sandbox.comcarde.com/v1/payment-instruments

You can also use this endpoint to query all Card-on-Files for a customer, if a customer identifier was provided when cards were saved.

Note: If multiple query params are provided, ALL will be used to constrain the results returned.

Query Params

customerId

string

length between 1 and 100

Case-sensitive identifier for your customer.

Note: Symbols such as back-ticks and carriage returns are not permitted.

tokens

array of strings

length between 1 and 20

Comma-separated list of multi-use tokens.

This is useful if you track associations between your customers and Card-on-Files yourselves, but still want to access obfuscated card details on demand

tokens

showPanLeadingChars

boolean

The leading six digits of a cards PAN are the issuer identification number (IIN) sometimes referred to as the "bank identification number (BIN)" which may be required for some use cases.

By default this information is not provided, but you can opt-in by setting this flag to true if you specifically need it.

E.g. 1234 56## #### 7890 instead of the default #### #### #### 7890

Responses

401

Unauthorized request.

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Map of obfuscatedCards, keyed by their multi-use token.