Suspend Card Token

post/api/card-tokens/{cardTokenId}/suspend

Suspends a card token with the status active, so it can't be used for payments.

Suspension is asynchronous. The token moves to suspending, and the final status arrives with the Card Token Updated webhook.

Request

Path Parameters

cardTokenIdstringrequired
Card token identifier, as returned by the List Card Tokens endpoint.

Response

Successful operation.

Body application/json

idstringrequired
Card token identifier.
statusstringrequired
Token status after the call. The final status arrives with the Card Token Updated webhook.

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

No Authorization to access resource.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/card-tokens/{cardTokenId}/suspend' \
  --request POST \
  --header 'Authorization: Bearer <access-token>'

curl 'https://api.immersve.com/api/card-tokens/{cardTokenId}/suspend' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

curl 'https://test.immersve.com/api/card-tokens/{cardTokenId}/suspend' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

Example Response

{
  "id": "c7f3e2a1b4d94e8f9a0b1c2d3e4f5a6b",
  "status": "suspending"
}

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}