Skip to main content
POST
/
cards
Error
A valid request URL is required to generate request examples
{
  "status": "00",
  "message": "Card created successfully",
  "data": {
    "card_id": "1",
    "card_status": "ACTIVE",
    "customer_id": "1",
    "product_id": "1",
    "account_number": "1234567890",
    "card_scheme": "VISA",
    "card_type": "VIRTUAL",
    "card_mode": "DEBIT",
    "card_currency": "NGN",
    "card_holder_name": "John Doe",
    "card_number": "1234",
    "card_cvv2": "123",
    "card_default_pin": "1234",
    "card_token": "1234567890",
    "card_expiry": {
      "month": "01",
      "year": "2024"
    },
    "card_address": {
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "country": "US"
    },
    "custom_properties": [
      {
        "id": "1",
        "description": "custom_property",
        "type": "string",
        "value": "custom_property"
      }
    ]
  }
}
{
  "status": "01",
  "error_code": "MISSING_FIELD",
  "message": "The field is missing",
  "data": {}
}
{
  "status": "02",
  "message": "The authentication failed",
  "data": {}
}
{
  "status": "03",
  "message": "You are not allowed to perform this operation",
  "data": {}
}
{
  "status": "05",
  "message": "An unknown error occurred",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
connection-id
string

Connection ID for the target bank

​
idempotency-key
string
required

Unique key to ensure idempotency of the request

​
signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Body

application/json
​
card_status
enum<string>
required

The status of the card

Available options:
ACTIVE,
INACTIVE,
BLOCKED,
LOST,
STOLEN
Example:

"ACTIVE"

​
card_holder_name
string
required

The name of the card holder

Example:

"John Doe"

​
card_default_pin
string
required

The default PIN of the card, encrypted with the client secret

Example:

"1234"

​
card_expiry
object
required
​
product_id
string

The unique identifier for the product

Example:

"1"

​
card_type
enum<string>

The type of the card

Available options:
VIRTUAL,
PHYSICAL,
OTHER
Example:

"VIRTUAL"

​
card_mode
enum<string>

The mode of the card

Available options:
DEBIT,
CREDIT,
PREPAID,
OTHER
Example:

"DEBIT"

​
card_currency
enum<string>

The currency of the card

Available options:
NGN
Example:

"NGN"

​
card_address
object
​
custom_properties
object[]

Response

Card created successfully

​
status
string
required
Example:

"00"

​
message
string
required
Example:

"Card created successfully"

​
data
object
required