v1

latestOpenAPI 3.1.02026-07-26490367.2 KB

Create Card

Create, map or replace cards for a specific customer.

post/cards

Request body

customerIdstring required

The customer _id.

fundingSourceIdstring

The funding source _id. Required if you wish to map card to an existing funding source.

type'physical' | 'virtual' required

The card type.

brand'Verve' | 'AfriGo' | 'MasterCard' | 'Visa'

The card brand.

numberstring

The card PAN (Verve or AfriGo) or Card ID (Visa). Required if type is physical.

enable2FAboolean

Enable 2FA for the card, this enables the card to receive OTP for web and mobile transactions.

currency'NGN' | 'USD' required

The currency type.

issuerCountry'NGA' | 'USA'

3 Digits Issuer Country. NGA for Nigeria and USA for United States. Defaults to NGA.

status'active' | 'inactive' required

The initial card status.

metadatastring json

The metadata object to attach to the card. Stored in key-value pair

bankCodestring

The bank code of existing account. Required if you wish to map card to existing account.

accountNumberstring

The account number of existing account. Required if you wish to map card to existing account.

replacementForstring

The _id of the current card you wish to replace. Required for card replacement.

replacementReason'lost' | 'stolen'

The reason for replacement. Required for card replacement.

debitAccountIdstring

Debit account _id. Required for all virtual cards and giftcards.

amountinteger

Funding amount. Required for mastercard.

sendPINSMSboolean

Send default PIN to customer phone number via SMS.

expirationDatestring

Card expiry date. Applies to Visa cards only. Format MMM-YYYY example AUG-2025. All cards are subject to maximum of 3 years validity.

Response

Card created successfully.

statusCodeinteger

Status code of the response. 200 indicates a successful request.

messagestring

Human-readable description of the result.