Query Client Payment Instruments

post

https://connect.digits.com/v1/organization/clients/payment-instruments/query

Find client payment instruments by Digits-assigned or caller-assigned IDs.

Body Params

QueryClientPaymentInstrumentsRequest finds client-scoped payment instruments by Digits-assigned or caller-assigned IDs.

Filters combine to narrow the result set: the client organization returns all payment instruments in that
organization, the client entity narrows to instruments owned by that entity, and ids/external_ids narrow to
specific instruments. Within ids or external_ids, multiple values are a union (match any).

clientOrganizationExternalId

string

Client organization's caller-assigned ID.

clientOrganizationId

string

Client organization's Digits-assigned ID.

clientEntityExternalId

string

Client entity's caller-assigned ID.

clientEntityId

string

Client entity's Digits-assigned ID.

ids

array of strings

Payment instruments' Digits-assigned IDs to match. Provide EITHER ids or external_ids, not both.

ids

externalIds

array of strings

Payment instruments' caller-assigned IDs to match. Provide EITHER ids or external_ids, not both.

externalIds

limit

int32

The number of items to return per request. Default and max size is 100.

cursor

string

Cursor for pagination.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200OK

defaultDefault error response