Convert Card - Field Descriptions
The following page details each of the fields that can be used in the request and received in the response when using the Convert Card endpoint.
Request Fields
The following table describes fields that can be included in the body of the request when converting a card.
| Field | Description | Minimum Length | Maximum Length | Type | Mandatory |
|---|---|---|---|---|---|
| cardType | The new form factor for the card. Currently, you can only convert from virtual to physical card. | 8 | 8 | String | Yes |
| moveExpiryDate | If true, then move the same expiry date to the new card. | 4 | 5 | Boolean | No |
| newExpiryDate | If true, card is set to the new Expiry Date. Otherwise default from program is used. Format YYYY-MM. Should not be set when MoveExpiryDate is true. | 7 | 7 | date-time | No |
| manufacturingDetails | Optional object that contains manufacturing details optional for physical card and not required for virtual cards and MVCs. | ||||
| deliveryMethod | The delivery method for the physical card. | 0 | 21 | String | Yes |
| carrierType | Carrier Product Design reference as used by the card printer. | 0 | 30 | String | Yes |
| language | The language used on the card. | 0 | 2 | String | No |
| thermalLine1 | Free text field which can be used for transferring extra information to be printed on the card. | 0 | 120 | String | No |
| thermalLine2 | Free text field which can be used for transferring extra information to be printed on the card. | 0 | 70 | String | No |
| embossLine4 | Embossed card line 4. Actual maximum length will depend on the card design. | 0 | 27 | String | No |
| vanityName | Can add an additional title to the card holder name (for example "Company Director"). | 0 | 32 | String | No |
| imageDetails | Object that contains details on the card image. | ||||
| imageId | Identifies the card manufacturer's image file that will be printed on the face of the card. | 0 | 16 | String | Yes |
| logoFrontId | Identifies the card manufacturer's logo file that will be printed on the face of the card. | 0 | 30 | String | No |
| logoBackId | Identifies the card manufacturer's logo file that will be printed on the back of the card, if supported. | 0 | 30 | String | No |
Response Fields
The following table describes fields that included in the response after successfully converting a card.
| Field | Description |
|---|---|
| cardType | The new card type for the converted card. |
| expiryDate | The expiry date for the converted card. Format YYYY-MM. |