PayPM Platform API
​string · required​string · required​string · enum · required​string · enum · required​string · uuid​string · date-time​string​string
​string · uuid · required​string · minLength: 6 · maxLength: 6 · required​string · required​string · required​boolean​string​string · date-time
​string · required​string · required​string · required​string · minLength: 6 · maxLength: 6 · required​string · required​boolean · enum · required​boolean · enum · required​string · required​string · email​string​string​integer​string​object
​string · required​string · required​string · minLength: 6 · maxLength: 6 · required​string​string​string​integer​string​object
​string · required​string · required​string · required​string · minLength: 6 · maxLength: 6 · required
Request an OTP code
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/auth/otp/issue
Request an OTP code › Request Body
phonebusinessEntityIdDeployment id from Partner Console / Plane B. Sandbox demo id is heritagepay.
channelEnum values:
sms
purposeEnum values:
register
login
reset_pin
Request an OTP code › Responses
OTP challenge created. This is not proof that an SMS was delivered.
otpChallengeIdexpiresAtchannelmaskedPhoneExchange an OTP code for a short-lived otpToken
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/auth/otp/verify
Exchange an OTP code for a short-lived otpToken › Request Body
otpChallengeIdcodephonebusinessEntityIdExchange an OTP code for a short-lived otpToken › Responses
OTP verified.
verifiedotpTokenexpiresAtRegister an end-user and issue tokens
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/auth/register
Register an end-user and issue tokens › Request Body
phonebusinessEntityIdfullNamepinotpTokentermsAcceptedEnum values:
privacyAcceptedEnum values:
legalAcceptanceVersionemailRegister an end-user and issue tokens › Responses
User registered and wallet provisioning status returned.
accessTokenrefreshTokenexpiresInendUserIdwalletProvisioningPIN login
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/auth/login
PIN login › Request Body
phonebusinessEntityIdpinotpTokenPIN login › Responses
200
Access and refresh tokens.
accessTokenrefreshTokenexpiresInendUserIdwalletProvisioningReset PIN using an OTP-authorized token
POST
https://sandbox-heritagepay-api.paypm.net/api/v1
/auth/pin/reset
Reset PIN using an OTP-authorized token › Request Body
phonebusinessEntityIdotpTokenpinReset PIN using an OTP-authorized token › Responses
200
PIN reset and tokens issued.
No data returned