Immersve Docs
GithubX

Payment 3DS OTP

post{listenerUrl}/payment-3ds-otp

Triggered when a one-time password (OTP) is generated to authenticate cardholders during a 3D Secure (3DS) transaction. Subscribers should use this event to deliver the OTP to the cardholder in their preferred channel.

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-3ds-otp
  • payloadobject
    • refstring

      A unique reference for the 3DS security challenge. This reference can be used to correlate the challenge to the subsequent Immersve payment resource.

    • verificationCodestring

      The 3DS one-time code to deliver to the cardholder.

    • ttlstring

      Time to live for the OTP in seconds.

    • cardholderIdstring

      The Immersve id for the cardholder associated with the card.

    • cardIdstring

      The Immersve card ID for the card being loaded.

    • cardPanLast4string

      The last four digits of the card PAN.

    • cardProgramIdstring

      The Immersve card program id for the card.

    • merchantNamestring

      The merchant's name.

    • merchantCountryCodestring

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

    • paymentAcquirerAmountstring

      Payment amount represented in the merchant's local currency. The amount will use fiat minor units. For example 978 GBP is £9.78.

    • paymentAcquirerCurrencystring

      The merchant's local currency.

    • deliveryOptionsobject[]min items: 1

      Specifies the method by which the notification should be delivered to the cardholder. Subscriber must send the notification using one of the specified delivery channels.

      Items

      • typestringrequired
        Allowed values:sms

        The delivery channel method.

      • destinationstring

        The delivery destination. E.g: the phone number used for the sms

  • 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

Response

Subscription response

Body application/json

  • deliveryTypestring

    Selected delivery option by the subscriber

  • deliveryDestinationstring

    Destination where the notification was sent to by the subscriber