Skip to main content
GET
/
api
/
v1
/
cards
List all Cards
const url = 'https://api.gnosispay.com/api/v1/cards';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}, body: undefined};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
[
  {
    "id": "<string>",
    "cardToken": "<string>",
    "lastFourDigits": "<string>",
    "activatedAt": "2023-11-07T05:31:56Z",
    "virtual": true,
    "statusCode": 1000,
    "statusName": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
exclude_voided
boolean

Exclude voided cards from the response

​
status_code
string

Filter cards by status code

Response

The list of cards for a user

​
id
string
required
​
cardToken
string
required
​
lastFourDigits
string
required
​
activatedAt
string<date-time> | null
required
​
virtual
boolean
required
​
statusCode
enum<number>
required

Card status code from payment processor. Possible values:

  • 1000: Active
  • 1001: Refer to Issuer
  • 1004: Capture
  • 1005: Declined
  • 1006: Pin Blocked
  • 1007: Declined
  • 1008: Honour with ID
  • 1009: Void
  • 1041: Lost
  • 1043: Stolen
  • 1054: Expired
  • 1154: Expired
  • 1062: Restricted
  • 1199: Void
Available options:
1000,
1001,
1004,
1005,
1006,
1007,
1008,
1009,
1041,
1043,
1054,
1154,
1062,
1199
​
statusName
string
required

Human-readable card status name corresponding to statusCode:

  • "Active": Card is active and can be used
  • "Refer to Issuer": Transaction requires issuer approval
  • "Capture": Card should be captured/retained
  • "Declined": All transactions are declined
  • "Pin Blocked": Card PIN is blocked due to incorrect attempts
  • "Honour with ID": Transaction requires ID verification
  • "Void": Card is voided/cancelled
  • "Lost": Card is reported as lost
  • "Stolen": Card is reported as stolen
  • "Expired": Card has expired
  • "Restricted": Card has restrictions applied
  • "Unknown": Status code not recognized