Search & list instruments

get

https://api.staging.payrails.io/payment/instruments

Fetch a list of payment instruments for the given query parameters.

Query Params

includeHolderReference

boolean

Defaults to false

Boolean indicating if the holder reference should be included in the response.

filter[holderReference]

string

Filter for a list of instruments by holder reference.

filter[holderId]

string

Filter for a list of instruments by holder id.

filter[status]

string

Filter for a list of instruments by latest instruments status.

filter[onlyWithTokens]

boolean

Filter for a list of instruments only ones with tokens.

filter[tokenType]

string

Filter for a list of instruments by token type.

filter[tokenStatus]

string

Filter for a list of instruments by token status.

filter[futureUsage]

string

Filter for a list of instruments by future usage.

filter[bin]

string

Filter for a list of instruments by BIN.

filter[suffix]

string

Filter for a list of instruments by suffix.

filter[network]

string

Filter for a list of instruments by card network.

filter[issuer]

string

Filter for a list of instruments by issuer.

filter[issuerCountry]

string

Filter for a list of instruments by country name.

filter[paymentMethodType]

string

Filter for a list of instruments by payment method.

filter[createdAt]

string

Filter by createdAt.

page[cursor]

string

Search collection items from that cursor.

page[after]

string

Search collection items after that cursor.

page[before]

string

Search collection items before that cursor.

page[size]

int32

Length of the collection to search.

Responses

Language

Credentials

Bearer

JWT

Response

Choose an example:

application/json

200Success.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

429Too Many Requests.