Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Channel Manager Card

Channel Manager Create card

Create a new virtual card

post/channel-managers/accounts/{accountId}/cards

Path parameters

accountIdstring required

The account which card funds will be raised from.

Request body

limitnumber double required

Total card authorisation limit.

expirystring 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.

productCodestring required

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

externalRefstring required

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

cancellationDatestring

Date for card to be cancelled on

frequencyUsage'SINGLE_USE' | 'MULTI_USE'

Example request

{
  "expiry": "2018-12",
  "constraints": {
    "authorisation": {
      "spend": [
        {
          "currency": "GBP"
        }
      ]
    }
  },
  "cancellationDate": "2025-01-01",
  "authorisationWindow": {
    "startDate": "2025-01-01",
    "endDate": "2025-01-01"
  },
  "holder": {
    "title": "Mr",
    "firstName": "Joe",
    "lastName": "Bloggs",
    "billingAddress": {
      "addressLine1": "Floor 10",
      "addressLine2": "80 George Street",
      "postTown": "EDINBURGH",
      "postCode": "EH2 3BU",
      "country": "GB"
    },
    "dateOfBirth": "2001-01-01",
    "mobileNumber": "+447123456000",
    "email": "cardholder@example.com"
  }
}

Response

Virtual card created successfully

idstring required

Card identifier. Maximum of 10 alphanumeric characters.

panstring required

Full card PAN.

maskedPanstring

Masked card PAN.

cvv2string required

Card CVV2 number.

externalRefstring required

Client reference for the newly created card.

createdDatestring date-time required

The creation date of the card

maxLimitstring required

Maximum Limit which can be set on this card and is the maximum lifetime spend the card can have

frequencyUsage'SINGLE_USE' | 'MULTI_USE' required

Card frequency usage

shareLinkstring

Link that can be used by client to share secure details. Will only be returned when shareDetails method is RETURN in request body.

Example response

{
  "createdDate": "2019-01-29T11:01:54.826+0000",
  "maxLimit": "4000.00",
  "frequencyUsage": "MULTI_USE"
}