Access1

Address Document Verification8

Agentic Commerce Protocol1

AML Screening2

Apple Pay3

Applicants4

Bacs Direct Debit1

Balances2

Business details2

Card metadata1

Card testing5

Cardholder access tokens1

Cardholders4

Cards11

Compliance requests2

Control groups4

Control profiles7

Controls5

Customers4

Digital cards1

Disputes12

Face Authentication7

Financial actions1

Flow3

Forex1

Forward6

Google Pay4

Hosted Payments Page2

ID Document Verification8

Identity Verification9

Instruments5

Inventory15

Issuing disputes6

Network Tokens4

Onboarding6

Onboarding Simulator5

Out-of-band authentication simulator1

Payment Context2

Payment instruments4

Payment Links2

Payment Methods1

Payment Setups4

Payments11

Payout schedules2

platforms4

Platforms4

Reports3

Representatives2

Standalone5

Standalone Account Updater1

Tokens2

Transactions2

Transfers2

Workflows21

Payment instruments

Query payment instruments

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.

get/accounts/entities/{id}/payment-instruments

Request

Base URL
https://{prefix}.api.sandbox.checkout.com
Auth
- OAuth 2
  Client credentials
  Token URLstring
  Scopesaccounts
- or 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.

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.

Example:verified

Response

_linksobject

Example response

{
  "data": [
    {
      "id": "ppi_qn4nis4k3ykpzzu7cvtuvhqqga",
      "status": "verified",
      "instrument_id": "src_wmlfc3zyhqzehihu7giusaaawu",
      "label": "Peter's Personal Account",
      "currency": "GBP"
    }
  ]
}

Changes

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