Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Instruments

Search & list instruments

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

get/payment/instruments

Query parameters

includeHolderReferenceboolean

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
Example:[2026-04-01T00:00:00Z,2026-05-01T00:00:00Z)

Filter by createdAt field using interval notation.

1973-02-03T04:32:11.596Z - exact date value

(1973-02-03T04:32:11.596Z - after the date excluding it

[1973-02-03T04:32:11.596Z - after the date including it

1973-02-03T04:32:11.596Z) - before the date excluding it

1973-02-03T04:32:11.596Z] - before the date including it

(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z) - between two dates excluding both

(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z] - between two dates excluding on the left

[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z) - between two dates excluding on the right

[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z] - between two dates including both.

page[cursor]string

Cursor for paging results.

Search collection items from that cursor.

page[after]string

Cursor for paging results.

Search collection items after that cursor.

page[before]string

Cursor for paging results.

Search collection items before that cursor.

page[size]integer

Length of the collection to search.

Response

Success.

Example response

{
  "paging": {
    "next": "?createdAtOrAfter=2022-02-11+00%3A00%3A00&createdAtOrBefore=2022-02-11+20%3A17%3A52.885&limit=50&pagingIdBefore=payment-acceptance%2Fa43c3080-7357-582b-bed3-7f68606c708b"
  },
  "results": [
    {
      "data": {
        "bin": "416598",
        "binLookup": {
          "bin": "416598"
        }
      }
    }
  ]
}