NEnestechops
ledger-card accounts

Create a corporate card.

Changed on

Creates a card account for the business. KYB/KYC is submitted to the card provider as part of this call; the card itself is only issued (and the initial funding amount debited) once KYC is approved - see the returned status. A business may have at most one card account pending KYC at a time, and is subject to a lifetime limit on the total number of card accounts it may ever create (see the 409 response).

post/ledger/card-accounts

Request

Request body

accountIdstring uuid required

The MAIN account to fund the card from.

displayNamestring required

A label for the card.

cardPackageIdstring

Card package/provider ID (see GET /card-packages) to create the card against. Defaults to the ledger's configured default card provider (currently onb-cards) when omitted.

cardBrand'VISA' | 'MASTERCARD' | 'VERVE'
initialFundingAmountnumber required
dailyLimitnumber
transactionLimitnumber
whitelistedMccsstring[]
blacklistedMccsstring[]
contactlessPaymentEnabledboolean

Example request

{
  "cardPackageId": "onb-cards"
}

Response

Card account created (typically PENDING_KYC)

idstring uuid required

Unique card account ID.

accountIdstring uuid required

The MAIN account this card is funded from.

currencystring required
status'PENDING_KYC' | 'PENDING_PROVISIONING' | 'ACTIVE' | 'FROZEN' | 'TERMINATED' | 'KYC_REJECTED' | 'CREATION_FAILED' required

Lifecycle of a card account. PENDING_KYC and PENDING_PROVISIONING are transient - a card only starts moving money once it reaches ACTIVE. KYC_REJECTED and CREATION_FAILED are terminal with no funds ever moved (the dedicated ledger account is only created once KYC is approved).

balancenumber required

The card's live spendable balance.

failureReasonstring

Populated when status is KYC_REJECTED or CREATION_FAILED.

createdDatestring date-time required

Example response

{
  "currency": "USD"
}

Changes