v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB

Cards

Update Card Status - Idempotent

patch/api/v1/cards/{publicToken}/status

Path parameters

publicTokenstring required

Request body

cardStatusCode'00' | '04' | '05' | '41' | '43' | '46' | '54' | '57' | '59' | '62' | '63' | '70' | '83' | '98' | '99' | 'G1' | 'G2' | 'G3' | 'G4' | 'G5' | 'G6' | 'G7' | 'G8' | 'G9' nullable

The new status of the card (two character alphanumeric card status code).

statusstring nullable

The new status of the card (string description).

updatedBystring nullable

The user updating the card status.

descriptionstring nullable

The reason for the card status update.

validityDatestring date-time nullable

The date when the status will be valid. Format YYYY-MM.

Example request

{
  "status": "Active",
  "description": "Card reported lost by customer"
}

Response

Success

statusstring nullable

The status of the card (string description).

cardStatusCode'00' | '04' | '05' | '41' | '43' | '46' | '54' | '57' | '59' | '62' | '63' | '70' | '83' | '98' | '99' | 'G1' | 'G2' | 'G3' | 'G4' | 'G5' | 'G6' | 'G7' | 'G8' | 'G9' nullable

The status code of the card (two character alphanumeric card status code).

updatedstring nullable

Date of last update. Format DD-MM-YYYY.

updatedBystring nullable

Optional field describing the user or service which made the last update.

descriptionstring nullable

Optional field describing the reason for the update.

Example response

{
  "status": "Active",
  "cardStatusCode": "00",
  "updated": "01/01/2022",
  "updatedBy": "Fred",
  "description": "Card reported as lost."
}