THthredd
Cards

Complete a Card Replacement - Idempotent

patch/api/v1/cards/{publicToken}/complete-replacement

Request

  • Base URL
    https://cardsapi-uat-pub.globalprocessing.net
  • URL
    https://cardsapi-uat-pub.globalprocessing.net/api/v1/cards/{publicToken}/complete-replacement
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://uatists.globalprocessing.net/connect/token scopes: readWrite

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

No Content

Changes

No recorded changes to this operation across all 2 revisions of this API.