WorldFirst DocsWorldFirst Docs

Receive OTP notification

When the 3DS OTP API notification preference is enabled, WorldFirst notifies you of the details about 3DS OTP API .

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Request parameters

assetId String  REQUIRED

The unique identifier of a card.

cardNoLast4 String  REQUIRED

The last four digits of the card number.

This parameter has a fixed length of 4 characters.

More information:

  • Maximum length: 4 characters

merchantName String  

The merchant name.

passcode String  REQUIRED

A one-time password used for identity verification.

cardBrand String  

The card brand.

Valid value is: MASTERCARD

message String  

The additional information associated with the transaction.

tradeAmount Amount  

The transaction amount of an order.

Show child parameters

challengeTime String  

The time when the transaction verification challenge is initiated.

This is a 13-digit timestamp parameter, for example: 1729180800000

challengeExpiryTime String  REQUIRED

The time when the transaction verification challenge is expired.

This is a 13-digit timestamp parameter, for example: 1729180800000

Response parameters

result Result  REQUIRED

The result of the API call.

Respond to WorldFirst with this parameter to acknowledge the reception of the status change notification.

Show child parameters
API Explorer

Request

Request Body

Response

Response Body

Result processing logic

After receiving the result notification, you must send a response to acknowledge receipt.

Note: You must sign the message before making the response. For more information, see Sign a request and validate the signature and the Response header.

If you do not acknowledge receipt, WorldFirst will retry sending the result according to the following rules:

  • WorldFirst retries sending the notification up to 7 times.
  • Intervals between notifications: 2 min, 10 min, 10 min, 1 h, 2 h, 6 h, and 15 h.

result.resultCode

CodeValueMessageFurther action
SUCCESSSSuccess
PROCESS_FAILFA general business failure occurred. Do not retry.

Human intervention is usually needed. Contact our Technical Support Team to resolve the issue.

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

The service might be down, please retry later. If the issue persists, contact our Technical Support Team.