v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB

Cards

Replace a Card

post/api/v1/cards/{publicToken}/replace

Path parameters

publicTokenstring required

Request body

moveBalanceboolean nullable

If true then the balance will move to the new card.

moveLimitAccumulatorsboolean nullable

If true then the limit accumulators will move to the new card.

moveChildCardsboolean nullable

If true then the child cards associated with the card will move to the new card.

moveExpiryDateboolean nullable

Optional field - if true, then move the same expiry date to the new card.

expiryDatestring date-time nullable

Optional field - if provided, card is set to the new Expiry Date. Otherwise default from program is used. Should not be set when MoveExpiryDate is true. Format YYYY-MM.

freetext1string nullable

Additional fulfilment data used for transferring extra information to the card manufacturer.

freetext2string nullable

Additional fulfilment data used for transferring extra information to the card manufacturer.

Example request

{
  "moveBalance": true,
  "moveLimitAccumulators": true
}

Response

Success

publicTokenstring nullable

Public token of the newly created card.

customerReferencestring nullable

Customer Reference (Account number)

embossNamestring nullable

Embossed name of card

maskedPanstring nullable

Masked PAN

startDatestring nullable

Start Date (yyyy-MM-dd)

expiryDatestring nullable

Expiry Date (yyyy-MM-dd)

Example response

{
  "publicToken": "5678901234",
  "customerReference": "sales",
  "embossName": "Joseph Bloggs",
  "maskedPan": "123456******3456",
  "startDate": "2022-06-06",
  "expiryDate": "2025-06-06"
}