v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Cards

Create a new physical card

Asynchronously create a physical card. The response will include a resource to allow the client to check the status of the request.

post/accounts/{accountId}/physical-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'
printedNamestring required

Name to be printed on the card. Maximum of 27 alphanumeric characters (including full stop, hyphen, apostrophe, caret and space). Please add business name to this field if you wish to have it on the card.

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"
  },
  "shippingAddress": {
    "addressLine1": "Floor 10",
    "addressLine2": "80 George Street",
    "postTown": "EDINBURGH",
    "postCode": "EH2 3BU",
    "country": "GB"
  },
  "printedName": "Joe Bloggs"
}

Response

Create physical card request received successfully

taskUrlstring required

Url of card task resource

taskIdstring required

ID of card task

metaDataobject

Meta data associated with async task response