Sign in

v1

latestOpenAPI 3.0.02026-07-267331140.7 KB
Card Management

List all Cards

get/api/v1/cards

Query parameters

exclude_voidedboolean

Exclude voided cards from the response

status_codestring

Filter cards by status code

Response

The list of cards for a user

idstring required
cardTokenstring required
lastFourDigitsstring required
activatedAtstring date-time nullable required
virtualboolean required
statusCode1000 | 1001 | 1004 | 1005 | 1006 | 1007 | 1008 | 1009 | 1041 | 1043 | 1054 | 1154 | 1062 | 1199 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
statusNamestring 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