Immersve Docs
GithubX

Card Canceled

post{listenerUrl}/card-canceled

Triggered when a card is canceled for a cardholder.

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-canceled
  • payloadobject
    • cardholderAccountIdstring

      The Immersve cardholder's account id.

    • cardIdstring

      Identifier of the card.

    • cancelReasonstring
      Allowed values:provisioning-faileduser-requestedexternal-provider-failedexpiredreissued

      Reason why the card was cancelled

  • 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