Sign in
Cards servicing

List all cards

Returns all cards associated with partner.

get/v1/cards

Query parameters

filter[business_id]string

Filter the results by the ID of the business associated with the card.

filter[person_id]string

Filter the results by the ID of the person associated with the card.

filter[person_uid]string

Filter the results by the ID of the person associated with the card.

filter[account_id]string

Filter on account id

filter[account_uid]string

Filter on account id

filter[status]string

Filter the results by the card status

filter[type]string

Filter the results by the card type.

filter[masked_pan]string

Filter the results by the card's masked PAN.

filter[line_1]string

Filter the cards by the value of their address line 1.

filter[sia_account_number]string

Filter the results by the SIA account number.

page[number]integer

The number of results pages to return.

page[size]integer

The size of each page in the response.

Response

Successful result of the operation

idstring

ID of the card.

status'ACTIVE' | 'ACTIVATION_BLOCKED_BY_SOLARIS' | 'BLOCKED' | 'BLOCKED_BY_SOLARIS' | 'CLOSED' | 'CLOSED_BY_SOLARIS' | 'COUNTERFEIT_CARD' | 'FRAUD' | 'INACTIVE' | 'LOST' | 'NEVER_RECEIVED' | 'PROCESSING' | 'STOLEN'

The current status of the card.

referencestring

Unique reference number for the card.

type'MASTERCARD_DEBIT' | 'MASTERCARD_BUSINESS_DEBIT' | 'VIRTUAL_MASTERCARD_DEBIT' | 'VIRTUAL_MASTERCARD_BUSINESS_DEBIT' | 'VIRTUAL_MASTERCARD_FREELANCE_DEBIT' | 'VISA_DEBIT' | 'VISA_BUSINESS_DEBIT' | 'VIRTUAL_VISA_DEBIT' | 'VIRTUAL_VISA_BUSINESS_DEBIT' | 'VIRTUAL_VISA_FREELANCE_DEBIT' | 'VISA_CREDIT' | 'VIRTUAL_VISA_CREDIT' | 'VISA_BUSINESS_CREDIT' | 'VIRTUAL_VISA_BUSINESS_CREDIT'

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

expiration_datestring

The expiration date of the card.

new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

person_idstring

ID of the cardholder person resource.

account_idstring

ID of the account to which the card is tied.

business_idstring

(For business cards) ID of the business with which the card is associated.

creation_datestring

Date when the latest plastic card for this card resource was created.

sia_account_numberstring

The SIA account number for the card.

Example response

[
  {
    "id": "8febdba4912a747808ccc6f95f82bbb4",
    "reference": "87285d83-ab15-4906-af87-5763801d9e43",
    "expiration_date": "2020-12-30",
    "person_id": "5af2ea4271038d5c53e68ccbf4fe43b3cper",
    "account_id": "a5844f601567db9b59b3531245a58e96cacc",
    "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
    "representation": {
      "line_1": "SLY STALLONE",
      "line_2": "BUSINESS NAME",
      "masked_pan": "537458******4567",
      "formatted_expiration_date": "09/22"
    },
    "creation_date": "2022-05-01",
    "sia_account_number": "500001650679"
  }
]