---
title: "Retrieve information about Card-on-Files"
method: GET
path: "/payment-instruments"
tags: ["Payment Instrument Tokenization"]
---

# Retrieve information about Card-on-Files

`GET /payment-instruments`

## Request

- Base URL: `https://sandbox.comcarde.com/v1`
- URL: `https://sandbox.comcarde.com/v1/payment-instruments`
- Auth: HTTP bearer

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 parameters

- `customerId` string
- `tokens` string[]
- `showPanLeadingChars` boolean

## Response `200`

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

- ResponseMapObfuscatedCard: Map of Card-on-Files, keyed by their multi-use token.
  - `id` string: The ID of this request. If you can include these when querying the outcome of individual requests, we can track down the root cause faster.
  - `results` object: Map of obfuscated cards keyed by multi-use token

## Other responses

- `400`: Bad request - the request was in an invalid format or contained invalid information. If have any questions about why you are receiving these responses, please raise a ticket with support on the BR-DGE Support Portal at <https://comcarde.atlassian.net/servicedesk/customer/portals> with the `id` from the response so we track down the individual requests on our end.
- `401`: Unauthorized request.
- `500`: An internal server error occurred upstream while processing the request. If you have any questions about why you are receiving these responses, please raise a ticket with support on the BR-DGE Support Portal at <https://comcarde.atlassian.net/servicedesk/customer/portals> with the `id` from the response so we track down the individual requests on our end.

---

[API](https://skmtc.dev/br-dge/apis/br-dge-payment-instrument-rest-api.md) - [All operations](https://skmtc.dev/br-dge/apis/br-dge-payment-instrument-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/br-dge/apis/br-dge-payment-instrument-rest-api/revisions/700277cae488?raw)
