Skip to main content
GET
List Card Products

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

form
enum<string>

The format of the card PHYSICAL or VIRTUAL.

Available options:
PHYSICAL,
VIRTUAL
card_brand
enum<string>

The brand of a card product

Available options:
MASTERCARD,
VISA
sort_by
enum<string>[]

Specifies the sort order for the returned card products.

Available options:
creation_time:asc,
creation_time:desc,
card_brand:asc,
card_brand:desc,
card_category:asc,
card_category:desc,
card_type:asc,
card_type:desc,
form:asc,
form:desc,
name:asc,
name:desc,
start_date:asc,
start_date:desc,
end_date:asc,
end_date:desc,
active:asc,
active:desc

Response

List of available Card Products

card_products
object[]
required

Array of Card Products

next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"