Skip to main content
POST
Error

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