ChangePin
Jump to navigation
Jump to search
Description
Set the new PIN for user.
The new pin value should respect the following regular expression: "^[0-9]{4,4}$".
This method only can be used by logged user.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- pinType (int, required)
- Define the kind of pin the request wants to change.
- pin (int, required)
- Current user pin
- newPin (String, required)
- The new value for the pin.
Returns
Returns a JSON object containing true for successful.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": true
}
Exceptions
- InvalidCharPinException
- InvalidPinTypeException
- AuthenticationRequiredException
- UserPinNotRegisteredException
- UserPinIsDisabledException
- UserParentalPinValueNoMatchException
- UserPurchasePinValueNoMatchException
Caching
This method is not cached.
Known issues
- None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |