Payment Updated

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:payment-updated
• payloadobject

  • eventobjectrequired

    • typestringrequired

      Allowed values:auth-acceptedauth-declinedauth-forcedclearing-acceptedclearing-declinedauth-reversal-acceptedauth-reversal-declinedpayment-expiredpayment-failedclearing-reversal-acceptedclearing-reversal-declined

      The payment lifecycle event which triggered the webhook event.

    • createdAtstring<date-time>required

      ISO 8601 timestamp of when the event occurred.

    • declineReasonstring

      The reason the authorization was declined. Only present when the event type is auth-declined. Possible values include insufficient-funds, inactive-card, lost-or-stolen-card, account-restricted, and cardholder-blocked. New values may be added over time, so consumers must tolerate unknown values.

  • paymentobjectrequired

    • idstringrequired

      Payment identifier.

    • createdAtstring<date-time>required

      ISO 8601 timestamp of when the payment was created.

    • pendingbooleanrequired

      Indicates if the payment is still in progress.

    • typestringrequired

      Allowed values:purchaserefundadjustment

      The type of payment.

    • creditDebitIndicatorstringrequired

      Allowed values:creditdebit

      Indicates whether this is a credit or debit payment.

    • statusstringrequired

      Allowed values:holdingclearedcanceled

      The current status of the payment.

    • cashOperationstring

      Indicates that the payment was a cash-based transaction and of which kind. Known values: atm-withdrawal, manual-cash-disbursement. New values may be added; clients must tolerate unknown values.

    • amountobjectrequired

      • valuestringrequired

        Total payment amount in minor units. Fee inclusive.

      • currencystringrequired

        ISO 4217 currency code.

    • feeAmountobjectrequired

      • valuestringrequired

        The fee amount of the payment in minor units.

      • currencystringrequired

        ISO 4217 currency code.

    • feeCompositionobject[]required

      Breakdown of fees applied to the payment.

      Items

      • categorystringrequired

        The category of the fee.

      • ratenumber

        The rate applied for the fee.

      • amountobjectrequired

        • valuestringrequired

          The fee amount in minor units.

        • currencystringrequired

          ISO 4217 currency code.

      • typestringrequired

        Allowed values:variablefixed

        The type of fee.

    • acquirerAmountobjectrequired

      • valuestringrequired

        Payment amount in the acquirer's currency using minor units.

      • currencystringrequired

        ISO 4217 currency code.

    • cardholderobjectrequired

      • idstringrequired

        Cardholder account identifier.

    • cardobjectrequired

      • idstringrequired

        Card identifier.

      • typestring

        Allowed values:virtualphysical

        Whether the card was issued as physical or virtual.

    • cardPresentboolean

      Whether the card was at the point of sale when the payment was authorized, as classified by the payment network. true for a card inserted, swiped, or tapped at a terminal, including a phone or watch tap and a manually keyed card at an attended terminal. false for e-commerce, in-app, mail order, and telephone order payments, and for a merchant charging a card it has stored on file.

    • tokenobject

      Present when the payment was made with a network token instead of the card's own PAN, for example from a digital wallet or a merchant's stored credential. Absent when the card itself was used.

      • requestorstringrequired

        Who the token was issued to: apple-pay, google-pay, merchant for a card the merchant has stored on file, or other for a token requestor Immersve does not name. Clients must tolerate unknown values.

    • networkReferencestring

      The payment network reference identifier for the payment, if applicable.

    • retrievalReferencestring

      The acquirer-generated retrieval reference number for the payment, if supplied by the payment network. The reference stays with the payment through authorization, clearing, and disputes, and can be used to match the payment across systems. Unlike networkReference, which identifies a single network message, the retrieval reference number identifies the payment as a whole.

    • initiatorstring

      The party that initiated the payment, if indicated by the payment network. Clients must tolerate unknown values, and must not read an absent value as cardholder. Values may include the following: cardholder for cardholder-initiated payments, such as an online checkout; merchant for merchant-initiated payments, such as recurring billing, installments, or stored-credential charges.

    • failureReasonstring

      The reason for payment failure, if applicable.

    • relatedPaymentIdstring

      The id of the related payment, if applicable.

    • 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.

    • securityChallengeobject

      • outcomestring

        3DS challenge outcome, if applicable.

      • refstring

        Reference identifier for the 3DS challenge, if applicable.

    • fundingSourcesobject[]

      Array of funding sources used for the payment. Will not be present for custodial payments.

      Items

      • idstring

        Funding source identifier.

      • addressstring

        The blockchain address of the funding source.

      • fundingChannelIdstring

        The funding channel identifier associated with this source.

      • networkstring

        The blockchain network where the funding source resides.

      • tokenobject

        • namestring

          The name of the token used for funding.

        • addressstring

          The smart contract address of the funding token.

        • decimalsinteger

          The number of decimal places supported by the funding token.

• 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