v1

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

Channel Manager Replace card

Replace a card, with a reason STOLEN, DAMAGED, LOST, RENEW

post/channel-managers/cards/{cardId}/replace

Path parameters

cardIdstring required

The ID of the card

Request body

reason'STOLEN' | 'DAMAGED' | 'LOST' | 'RENEW' required

The reason for replacing the card. Can be one of DAMAGED (physical only), LOST, STOLEN, RENEW

externalRefstring

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

expirystring

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. If no expiry is selected, the standard product expiry date will be set

Example request

{
  "reason": "STOLEN",
  "expiry": "2026-12",
  "shippingAddress": {
    "addressLine1": "Floor 10",
    "addressLine2": "80 George Street",
    "postTown": "EDINBURGH",
    "postCode": "EH2 3BU",
    "country": "GB"
  }
}

Response

Card replaced successfully

idstring required

Card identifier. Maximum of 10 alphanumeric characters.

cvv2string required

Card CVV2 number.

panstring required

Full card PAN.

createdDatestring date-time required

The creation date of the card

externalRefstring required

Client reference for the newly created card.

expirystring required

An ISO 8601 date with year & month components only

maxLimitstring required

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

managementTokenstring

Card Management Token required for API users for additional security when managing sensitive card data

Example response

{
  "createdDate": "2019-01-29T11:01:54.826+0000",
  "expiry": "2018-12",
  "maxLimit": "4000.00"
}