Immersve Docs
GithubX

Card Inquiry Updated

post{listenerUrl}/inquiry-updated

Triggered when a Card Inquiry is updated throughout its lifecycle.

Inquiries are used to perform pre-payment checks. Depending on the type, the inquiries purpose can be to validate there are no active blocks on a card or cardholder, or to check their available balance.

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:inquiry-updated
  • payloadobject
    • eventobjectrequired
      • typestringrequired

        The inquiry lifecycle event which triggered the webhook event.

        This set is non-exhaustive and may grow over time, so consumers should tolerate unrecognised values. Current values are inquiry-accepted and inquiry-declined.

      • createdAtstring<date-time>required

        ISO 8601 timestamp of when the event occurred.

    • inquiryobjectrequired
      • idstringrequired

        Inquiry identifier.

      • typestringrequired

        The type of inquiry.

        This set is non-exhaustive and may grow over time, so consumers should tolerate unrecognised values. The current values are account-status-inquiry and balance-inquiry.

        Balance inquiries are not currently supported and are always declined with the result code transaction-not-permitted-to-cardholder.

      • livenessstringrequired
        Allowed values:livetest

        The resource liveness mode.

      • resultobjectrequired
        • acceptedbooleanrequired

          Indicates whether the inquiry was accepted.

        • codestringrequired

          The result code for the inquiry.

        • messagestring

          A human-readable description of the result.

      • merchantobject
        • idstring

          The merchant identifier from the payment network.

        • namestring

          The merchant's name.

        • citystring

          The merchant's city name.

        • countryCodestring

          The merchant's ISO-3166-1 Alpha-2 country code.

        • terminalIdstring

          The merchant's payment terminal identifier.

        • categoryCodestring

          The merchant's ISO-18245 category code.

      • cardobjectrequired
        • idstringrequired

          Card identifier.

      • cardholderobjectrequired
        • idstringrequired

          Cardholder account identifier.

  • 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