List payment instruments

get

https://api.sandbox.layer1.com/platform/v1/payment-instruments

Retrieves a paginated list of payment instruments across all contacts. Supports advanced search using Lucene-like query syntax for filtering by instrument properties and associated contact information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Lucene-style query for filtering payment instruments. Supported fields: searchTerm (free text search in instrument name, description, wallet address, contact name, description, e.g., searchTerm:ethereum), paymentMethods (payment method type: CRYPTO, BANK_ACCOUNT, e.g., paymentMethods:CRYPTO), currency (currency of the instrument, e.g., currency:EUR), verificationStatuses (verification status: UNVERIFIED, VERIFICATION_REQUESTED, VERIFIED, e.g., verificationStatuses:VERIFIED), entityTypes (entity types: INDIVIDUAL, COMPANY, e.g., entityTypes:INDIVIDUAL).

pageNumber

integer

≥ 0

Defaults to 0

Zero-based page index (0..N)

pageSize

integer

≥ 1

Defaults to 20

The size of the page to be returned

sort

array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Payment instruments retrieved successfully

400Invalid query parameters

401Unauthorized

403Forbidden

404Not Found

409Conflict

428Precondition Required