Sign in

v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB
Cards

Convert Card - Idempotent

patch/api/v1/cards/{publicToken}/card-type

Path parameters

publicTokenstring required

Request body

cardType'Physical' | 'Virtual' | 'MasterVirtual' required

The new form factor for the card.

moveExpiryDateboolean nullable

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

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

Example request

{
  "cardType": "Virtual"
}

Response

Success

cardType'Physical' | 'Virtual' | 'MasterVirtual'

Type of card converted to

expiryDatestring date-time nullable

Expiry date set on the converted card. Format YYYY-MM.

Example response

{
  "cardType": "Physical"
}