Immersve Docs
GithubX

Card Expiry Upcoming

post{listenerUrl}/card-expiry-upcoming

Triggered when a card is approaching its expiry date.

  • Virtual cards: two weeks before expiry.
  • Physical cards: six weeks before expiry.

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-expiry-upcoming
  • payloadobject
    • cardholderAccountIdstring

      The Immersve cardholder's account ID.

    • cardIdstring

      ID of the card.

    • expiresAtstring

      The date and time at which the card expires.

    • cardTypestring
      Allowed values:virtualphysical

      The type of card.

  • 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