Replace Card - Field Descriptions
The following page details each of the fields received in the response when using the Replace 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 |
|---|---|---|---|---|---|
| moveBalance | If true then the balance will move to the new card. | 4 | 5 | Boolean | No |
| moveLimitAccumulators | If true then the limit accumulators will move to the new card. | 4 | 5 | Boolean | No |
| moveChildCards | If true then the child cards associated with the card will move to the new card. | 4 | 5 | Boolean | No |
| moveExpiryDate | If true, then move the same expiry date to the new card. | 4 | 5 | Boolean | No |
| expiryDate | 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. | 0 | 7 | date-time | No |
| freetext1 | Additional fulfilment data used for transferring extra information to the card manufacturer. | 0 | 50 | String | No |
| freetext2 | Additional fulfilment data used for transferring extra information to the card manufacturer. | 0 | 50 | String | No |
Response Fields
The following table describes fields that included in the response after successfully replacing a card.
| Field | Description |
|---|---|
| publicToken | The public token for the replaced card. |
| customerReference | The external customer reference for the card. |
| embossName | The name embossed on the card. |
| maskedPan | The masked PAN for the card created. |
| startDate | The start date of the card in yyyy-MM-dd format. |
| expiryDate | The expiry date of the card in yyyy-MM-dd format. |
Updated 6 months ago