---
title: "Query payment instruments"
method: GET
path: "/accounts/entities/{id}/payment-instruments"
tags: ["Payment instruments"]
---

# Query payment instruments

`GET /accounts/entities/{id}/payment-instruments`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/payment-instruments`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `accounts`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/accounts/entities/:id/payment-instruments/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetch all of the payment instruments for a sub-entity. You can filter by `status` to identify `verified` instruments that are ready to be used for Payouts.

## Query parameters

- `status` 'pending' | 'verified' | 'unverified': The status of your sub-entity's payment instrument. The status indicates the instrument's stage of verification, and whether it can be used for payouts.

## Response `200`

OK

- PlatformsPaymentInstrumentQuery
  - `data` PlatformsPaymentInstrumentRead[]
    - `id` string: The ID of the sub-entity's payment instrument.
    - `status` 'pending' | 'verified' | 'unverified': The status of your sub-entity's payment instrument. The status indicates the instrument's stage of verification, and whether it can be used for payouts.
    - `instrument_id` string: The payment instrument's ID. Only available once the instrument status is `verified`.
    - `label` string, required: A reference that you can use to identify the payment instrument
    - `type` 'bank_account' | 'card_token', required: The instrument type
    - `currency` string, ISO 4217, required: The account's currency, as a 3-letter ISO currency code
    - `_links` object
  - `_links` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)