​
Overview

Use the card creation endpoint after you complete authentication and card program setup. Go to Create Card when you are ready to issue a card.

​
What you will usually need

  • institutionToken
  • institutionId
  • cardProgramId
  • Cardholder details
  • Any required encrypted payload values

​
Create card request parameters

Send these parameters in the JSON body when you call POST /institutions/cards.
​
cardProgram
string
required
The preconfigured card setup to issue this card from.This setup already exists in the system and defines how a card should behave. When creating a new card, you choose which setup to issue it from.
​
referenceCode
string
required
Your own unique tracking number for this card request.Use this value to find or trace the request later.
​
pan
string
The card number to use.Only provide this if your setup allows you to bring your own card number. If not, leave it out and the system will create one.
​
pinEnabled
boolean
required
Set this to true if the card should support PIN transactions.
​
defaultPIN
object
required
The card’s starting PIN, sent in a protected format.Do not send the actual PIN as plain text.See Encrypting PIN for the full encryption flow.
​
defaultPIN.encryptedData
string
required
The protected PIN value.
​
defaultPIN.publicKeyFingerprint
string
required
The key label that tells the system which key was used to protect the PIN.
​
account
object
required
The bank account that should be linked to the card.
​
account.currency
string
required
The account currency, for example NGN.
​
account.bankCode
string
The bank code for the linked account.If you do not provide it, the system may take it from the card setup.
​
account.type
string
required
The type of account linked to the card.Allowed values are 00, 10, 20, and 30.
​
account.number
string
required
The account number to link to the card.
​
customer
object
required
The person who will own or use the card.
​
customer.firstName
string
required
The cardholder’s first name.
​
customer.middleName
string
The cardholder’s middle name, if available.
​
customer.lastName
string
required
The cardholder’s last name.
​
customer.emailAddress
string
required
The cardholder’s email address.
​
customer.phoneNumber
string
required
The cardholder’s phone number.
​
customer.honorific
string
The cardholder’s title, for example Mr, Mrs, or Ms.
​
customer.gender
string
The cardholder’s gender.
​
customer.dateOfBirth
string
required
The cardholder’s date of birth.
​
customer.address
object
required
The cardholder’s address.
​
customer.address.line1
string
required
The first address line.
​
customer.address.line2
string
The second address line, if available.
​
customer.address.city
string
required
The address city.
​
customer.address.state
string
required
The address state or region.
​
customer.address.country
string
required
The address country.
​
customer.address.postalCode
string
required
The postal or ZIP code.
​
status
string
The starting status of the card.Allowed values are active, inactive, suspended, and expired.
​
seqNumber
string
The card’s sequence number.If you do not provide it, the system takes it from the card setup.
​
enroll2FA
boolean
Set this to true if the card should be enrolled for extra cardholder verification.
​
embossingName
string
required
The name to print or display on the card.
​
startDate
string
required
The date the card should become valid.
​
expiryDate
string
required
The date the card should expire.
​
printCard
boolean
Set this to true if a physical card should be printed.