A card is a payment instrument that enables users to conduct transactions at merchant locations.

Endpoints

MethodUrl
POST /cards
GET /cards
GET /cards/customer/:id
GET /card/:id (Hide card details)
GET /card/:id (Show card details)
PUT [/card/:id/pin][ref:change-card-pin]
PUT /card/:id

Card Object

{
  "_id": "61d7004261f2a5ebf1e18a63",
  "business": "61d4150b00c7cdd1184ef455",
  "customer": {
    "_id": "61d6baf144b3a74b6b258630",
    "business": "61d57b7ebc8deefb4330f5b4",
    "type": "individual",
    "name": "Farouk Bakre",
    "status": "active",
    "individual": {
      "firstName": "Farouk",
      "lastName": "Bakre",
      "identity": {
        "type": "BVN",
        "number": "23456543",
        "_id": "61d6baf144b3a74b6b258632"
      },
      "_id": "61d6baf144b3a74b6b258631"
    },
    "billingAddress": {
      "line1": "Ikeja, Lagos",
      "line2": "",
      "city": "Lagos",
      "state": "Lagos",
      "country": "Nigeria",
      "postalCode": "100001",
      "_id": "61d6baf144b3a74b6b258633"
    },
  },
  "account": {
    "_id": "61d7004261f2a5ebf1e18a61",
    "business": "61d4150b00c7cdd1184ef455",
    "type": "wallet",
    "currency": "NGN",
    "accountName": "SUDO / FAROUK BAKRE",
    "bankCode": "999240",
    "accountType": "Current",
    "accountNumber": "8016813168",
    "currentBalance": 0,
    "availableBalance": 0,
    "provider": "SafeHaven",
    "providerReference": "61d70040240846001ebeb8ff",
    "referenceCode": "subacc_1641480256224",
    "isDefault": true,
  },
  "fundingSource": {
    "_id": "61d4150b00c7cdd1184ef459",
    "business": "61d4150b00c7cdd1184ef455",
    "type": "default",
    "status": "active",
    "jitGateway": null,
    "isDefault": true,
  },
  "type": "physical",
  "brand": "Verve",
  "currency": "NGN",
  "maskedPan": "506100******2989",
  "expiryMonth": "01",
  "expiryYear": "2025",
  "status": "active",
  "spendingControls": {
    "channels": {
      "atm": true,
      "pos": true,
      "web": true,
      "mobile": true,
      "_id": "61d7004261f2a5ebf1e18a65"
    },
    "allowedCategories": [],
    "blockedCategories": [],
    "spendingLimits": [
      {
        "amount": 10000000,
        "interval": "daily",
        "categories": [],
        "_id": "61d7004261f2a5ebf1e18a66"
      }
    ],
    "_id": "61d7004261f2a5ebf1e18a64"
  },
}