Cards

Learn how to create, update, manage, and issue cards.

Real Quick: The card schema shown below is not the card schema attached to the API, the API POST's a basic schema during the alpha but will be more fleshed out like the schema shown below as more time passes by and we reach the Beta.

To fetch or display full credit card number and other details like expiry or cvv, the userUniqueId needs to be passed in the body and partner will get everything in the response.

Card Schema

Card Schema

view-card-detail

{
  "created": String,
  "cvv": String,
  "exp_month": String,
  "exp_year": String,
  "last_four": String,
  "pan": String,
  "spend_limit": Integer,
  "spend_limit_duration": String,
  "state": String,
  "token": String,
  "type": String,
}

View card Detail

POSThttps://api.kaped.io/partner/view-card-detail

Authorization

bearerAuth

Header parameters

Body

application/json

userUniqueIdstring

Response

200

Successful Response

Request

JavaScriptCurlPython

const response = await fetch('https://api.kaped.io/partner/view-card-detail', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userUniqueId": ""
    }),
});
const data = await response.json();

created	An ISO 8601 timestamp (yyyy-MM-ddThh:mm:ssZ) for when the card was created.
cvv (Enterprise)	Three digit CVV printed on the back of the card. Only available in Production for customers who have verified PCI compliance. Available in Sandbox for all users.
exp_month (Enterprise)	Two digit (MM) expiry month. Only available in Production for customers who have verified PCI compliance. Available in Sandbox for all users.
exp_year (Enterprise)	Four digit (yyyy) expiry year. Only available in Production for customers who have verified PCI compliance. Available in Sandbox for all users.
last_four	Last four digits of the card number.
pan (Enterprise)	Sixteen digit card number. Only available in Production for customers who have verified PCI compliance. Available in Sandbox for all users.
spend_limit	Amount (in cents) to limit approved authorizations. Purchase requests above the spend limit will be declined (refunds and credits will be approved). By default, this is not checked for customers using Auth Stream Access (ASA). Contact [e-mail] if spend limit functionality is required.
state	CLOSED, OPEN, PAUSED, PENDING_ACTIVATION, PENDING_FULFILLMENT.
token	Globally unique identifier for the card.
type	VIRTUAL, PHYSICAL, MERCHANT_LOCKED (deprecated), SINGLE_USE (deprecated).

Request

{
  "userUniqueId": "63612057-249f-4751-8cbd-6a6542244623"
}

Get transaction list

To display all transactions associated with a single card in any particular month, make an API call with the useruniqueid and month for the requested transactions or statements to the single-card endpoint

single-card

GEThttps://api.kaped.io/partner/single-card

Authorization

bearerAuth

Query parameters

Header parameters

Response

200

Successful response

Request

JavaScriptCurlPython

const response = await fetch('https://api.kaped.io/partner/single-card?userUniqueId=text&month=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text"
    },
});
const data = await response.json();

Get list of active cards

To retrieve a full list of active cards, make an API call to the active-card endpoint with the correct API key and Bearer Token

active-card

GEThttps://api.kaped.io/partner/active-card

Authorization

bearerAuth

Header parameters

Response

200

Successful response

Request

JavaScriptCurlPython

const response = await fetch('https://api.kaped.io/partner/active-card', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text"
    },
});
const data = await response.json();