BPAPI Methods

BPAPI method VerifyPassword

VerifyPassword

Verifies that the {email} and {password} supplied are valid as credentials.

Authorization required: No

HTTP methods allowed: GET, POST

Syntax: VerifyPassword/{email}/{password}/  Details   Details 

Verifies that the {email} and {password} supplied are valid as credentials.

See also VerifyCredentials.
Returns one of the following access_granted values:
NoAccess
LimitedAccessRegistrationIdUsed: Access is given to a few methods like -Customer/AddProperty/Simple-, -Gateway/AddProperty/Simple- and -RegisterPayment- which uses registrationId as a credential-parameter
FullAccess

Returns in addition the following two values:
1) payment_completion_information: If a customer has been identified and developer_mode has been set this property will give test credit-card numbers that may be used (this functionality is useful if VerifyPassword is called in relation to a WebShop/Register)
2) email: This is useful when access_granted is LimitedAccessRegistrationIdUsed, this will be the email to use in order to get access_granted FullAccess. This information is useful when the users forgets that he has registered with email and password and continues to log in with only his registrationId (valueCode)




Unit-tests: 2 test(s)

Popularity: 52529 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2020-03-30 00:17