Card Block Created

post{listenerUrl}/card-block-created

Triggered when a card is blocked/frozen.

Request

Header Parameters

X-Delivery-Idstring
Unique message id plus delivery attempt.
X-Key-Idstring
ID of the public key used to validate the signature.
X-Signaturestring
Base64-encoded RSA SHA-256 signature of {deliveryId}:{keyId}:{requestBody}.

Body application/json

topicstring
Allowed values:card-block-created
payloadobject
- blockIdstring
  Identifier of the block.
- cardIdstring
  Identifier of the card being blocked.
- cardholderAccountIdstring
  The Immersve cardholder's account id.
- unfreezeAllowedboolean
  Indicates whether the card can be unfrozen with the unfreeze endpoint
- reasonstring
  Reason the card was blocked. See Card Block Reasons for what each reason means.
messageIdstring
listenerIdstring
listenerAccountIdstring
deliveryAttemptnumber
createdAtstring
The notification message creation timestamp.
sentAtstring
The delivery attempt timestamp.
keyIdstring
The public key id for validating the signature. Public keys can be found at https://api.immersve.com/.well-known/jwks.json and matched using the "kid" attribute.
issuerstring

Example

Example Request

{
  "topic": "card-block-created",
  "payload": {
    "blockId": "af2d8ce3c7c691a45dc6c0172f66a184",
    "cardId": "0485464bedfde163eace0ece2e3e2d75",
    "cardholderAccountId": "992b1b0f0cb8cca355c70ce08150a20d",
    "unfreezeAllowed": true,
    "reason": "cvv"
  },
  "messageId": "msg-1234",
  "listenerId": "listener-1234",
  "listenerAccountId": "partner-account-1",
  "deliveryAttempt": 1,
  "createdAt": "2025-09-29T10:11:12Z",
  "sentAt": "2025-09-29T10:11:13Z",
  "keyId": "9ce69d31277108d46d2cb19fa772705e",
  "issuer": "api.immersve.com"
}