Skip to main content
Weavr API
Managed cards

Create a prepaid card

POST/managed_cards#prepaid

Create a card with its own balance. Fund it by transferring money onto the card, then spend from that balance.

The card is created as a virtual card for the logged-in consumer or corporate identity. Its balance is in one currency, fixed when it is created. It can spend only the funds transferred onto it.

Prerequisites

The identity must have completed due diligence before it can create cards; otherwise the request fails with OWNER_IDENTITY_NOT_VERIFIED. The Managed Card Profile referenced by profileId must be active and support the requested currency.

This operation requires a stepped-up access token. Step up before calling it by issuing a challenge through Step-up.

Fields

Profile and mode

profileId selects the Managed Card Profile configured in the Multi Portal, which determines the behavior, limits, and restrictions applied to the card. Set mode to PREPAID_MODE.

Balance

currency fixes the card's balance currency and can't be changed afterwards. It must be one of the currencies enabled on the profile, or the request fails with CURRENCY_NOT_SUPPORTED_BY_PROFILE. A new card starts with a zero balance. You can transfer funds to and from the card; its available balance is what it can spend. Spend limits aren't supported for prepaid cards.

Names

nameOnCard is the cardholder name and may be checked by merchants for online purchases. It is printed on the card if the card is later upgraded to physical, as is the optional nameOnCardLine2. Both are capped at 27 characters here, but the limit that actually applies to a printed card depends on the chosen card design and is confirmed by Weavr during physical card setup. friendlyName is a label for your own use and isn't printed or shared with merchants.

Address

billingAddress is the cardholder's billing address and may be verified by merchants for online purchases. It is unrelated to where a physical card is delivered. The delivery address is supplied when the card is upgraded to physical.

Linking a user

Set userId to link the card to an authorized user. The linked user's authentication details are then used for actions performed on the card, such as 3DS authentication and manual provisioning to a digital wallet. Linking is also a prerequisite for bulk physical delivery.

Renewal

renewalType controls what happens as the card approaches expiry. RENEW reissues the card with the same card number and a new expiry date and CVV; NO_RENEW lets it expire and be destroyed.

Digital wallets and external data

digitalWallets controls whether the card can be tokenized and push-provisioned into a digital wallet, and which artwork is used. externalData holds up to 10 name/value pairs of your own. Weavr stores them against the card and can surface them in reports and filters, but never acts on them.

Next steps

The card is usable as a virtual card as soon as it is created. To issue plastic for it, see Request a physical card for individual delivery or for bulk delivery.

Request

Available on
SandboxProduction

Header parameters

Request body

*
application/json
{}
PrepaidModeCardRequestPrepaidModeCardRequest · object · 13 fields

Responses

200OK

Success

Headers
Body
application/json
{}
PrepaidModeCardPrepaidModeCard · object · 2 fields
Response example
{  "mode": "PREPAID_MODE",  "balances": {    "availableBalance": 120000,    "actualBalance": 125000  }}