Get Issuing Plan Card List

get

https://merchant.cop-staging.straitsx.com/api/v1/issuing_plans/{issuing_plan_opaque_id}/cards

Get a list of cards that is under an Issuing Plan. This is on a higher level compared to User's Card List, as an Issuing Plan can have many users/customers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

For PCI DSS certified merchant, please refer to Encrypted SAD to learn more about the encryption algorithm and details.

Path Params

issuing_plan_opaque_id

string

required

Issuing Plan Opaque ID

Query Params

page[size]

string

Defaults to 10

response page size

page[number]

string

Defaults to 1

response page number

sort

string

enum

Defaults to -createdAt

one of=-createdAt, +createdAt. + means ascending, - means descending

Allowed:

status

string

enum

one of=ACTIVE, BLOCKED_BY_FRAUD, INACTIVE, INVALID, LOST, PERM_BLOCK, STOLEN, SUSPENDED
query by card status
For cards in PERM_BLOCK status, the status is permanent and cannot be updated anymore

show_encrypted_card_number

boolean

Defaults to false

Set to true to show the encrypted card number in the response. Requires you to be PCI DSS certified

show_encrypted_cvv

boolean

Defaults to false

Set to true to show the encrypted cvv in the response. Requires you to be PCI DSS certified

has_sku

boolean

No parameter - Returns all cards (default behavior)
true - Returns only cards with SKU
false - Returns only cards without SKU

card_product_opaque_id

string

Filter card list by card product opaque id

customer_name

string

Filters cards by the name of the associated customer

card_opaque_id

string

Filters cards by the card's opaque ID

last_four_digits

string

Filters cards by the last four digits of the card number

Response

Language

Credentials

Bearer

Loading…

Response

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

application/json

200200