editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=This method is used to check the value of pin sent to the platform. For both situation, Parental PIN en Purchase PIN, this method can check if t..."
{{Api_Method_Spec|
Description=This method is used to check the value of pin sent to the platform. For both situation, Parental PIN en Purchase PIN, this method can check if the value of PIN is correct.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=pinType
|ParamType= UserPinType
|ParamRequired=required
|ParamDescription=Define the type of pin.
}}
{{Api_Parameter|
ParamName=pin
|ParamType=int
|ParamRequired=required
|ParamDescription=The value of pin
}}
|Returns=
Returns a JSON object containing true for successful.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: <span style="color: #219;">true</span>
}
|Exceptions=
* [[UserParentalPinValueNoMatchException]]
* [[UserPurchasePinValueNoMatchException]]
* [[AuthenticationRequiredException]]
* [[InvalidPinTypeException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=This method is used to check the value of pin sent to the platform. For both situation, Parental PIN en Purchase PIN, this method can check if the value of PIN is correct.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=pinType
|ParamType= UserPinType
|ParamRequired=required
|ParamDescription=Define the type of pin.
}}
{{Api_Parameter|
ParamName=pin
|ParamType=int
|ParamRequired=required
|ParamDescription=The value of pin
}}
|Returns=
Returns a JSON object containing true for successful.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: <span style="color: #219;">true</span>
}
|Exceptions=
* [[UserParentalPinValueNoMatchException]]
* [[UserPurchasePinValueNoMatchException]]
* [[AuthenticationRequiredException]]
* [[InvalidPinTypeException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
