Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get OTP

Allows fetching recent OTP issued to a customer. For now, OTP is issued for redeeming points/coupons and customer registration. If there is more than one valid OTP available for the customer, this API fetches the recently issued OTP.

get/otp

Query parameters

identifierName'mobile' | 'email' | 'wechat' | 'externalId' | 'cardnumber' | 'cardExternalId' required

Pass any of the registered identifier type of the customer.

identifierValuestring required

Specify the value of the specified identifierType.

source'INSTORE' | 'WECHAT' | 'MARTJACK' | 'WEB_ENGAGE' | 'ECOMMERCE' | 'JD' | 'TAOBAO' | 'TMALL' | 'FACEBOOK' | 'WEBSITE' | 'OTHERS' required

Source on which the customer's identifier name is registered. Use OTHERS for any other source listed here.

accountIdstring

For a source with multiple accounts (such as MARTJACK, WECHAT), pass the respective account ID.

thresholdinteger

Validity of the OTP (in seconds) that you want to fetch.

scope'COUPON' | 'POINTS' | 'REGISTRATION' | 'USERGROUP' | 'SUBSCRIPTION' required

Specify the scope of the issued OTP. Use COUPON or POINTS for the respective redemption. GENERIC for any other purpose.

Response

200

orgIdinteger
userIdinteger
codestring
validUptostring

Example response

{
  "orgId": 966,
  "userId": 313302314,
  "code": "538AD87",
  "validUpto": "2017-08-07T21:44:20+05:30"
}