Create a new virtual card

post

https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/{accountId}/cards

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

The account which card funds will be raised from.

Body Params

limit

double

required

≥ 1

Total card authorisation limit.

expiry

string

required

ISO 8601 date with year & month components only. The supplied value must be in the future (cannot be the current month) and is inclusive of the specified month.

productCode

string

required

Identifies the type of card to create (GBP consumer, GBP business, etc). Modulr will supply a list of possible values.

externalRef

string

required

length between 1 and 50

Client reference for the newly created card. Maximum of 50 alphanumeric characters (including underscore, hyphen and space).

constraints

object

Constraints

authentication

object

Authentication. Required by default, optional for Virtual Business Travel Cards only

cancellationDate

string

Date for card to be cancelled on

customFields

array of objects

length between 0 and 20

Custom fields of card

customFields

authorisationWindow

object

Authorisation Windows allow the card holder to add a period of time where the card can ONLY be used, if an Authorisation Window set then transactions outside this window will decline. ISO 8601 date with year, month & day components only.

frequencyUsage

string

enum

Allowed:

holder

object

CardHolder

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

201Virtual card created successfully

400Invalid request