Account Service


http://webservices.gr8pay.net/v2/account.svc

The Accounts webservice is used for managing all the user identities within the system. It provides access to the functionality needed for managing accounts, from login, log off, reset password and more.

Login Method

The login function is used for login into the app – besides the ability to send the user name password combo, it enables more info to be sent during login, for a more secure login (like – app token, device id etc.)

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
EmailNostring“6224A847-4867-41EE-851D-36CC8BA1B”
usernameNostring
PasswordNostring
Options
Account.LoginOptionsArray
userroleYesstring
appNameNostring
applicationTokenNostring
deviceIdNostring
pushTokenNostring
setCookieNoboolean

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString
C#JavaScriptPHP

DecodeLoginCookie Method

When using the login service to login, the service will return an Encodedcookie – in using the cookie and the token, you will be able to create an auto login function, so that users don’t need to login every time they enter  the app .

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
applicationTokenNostring“6224A847-4867-41EE-851D-36CC8BA1B”
CookieNostring

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString


C#JavaScriptPHP


DeviceActivate Method

With the activation code and the device ID you can use this method to activate the device. Access to the device can be revoked if needs be, through the admin panel.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
deviceIdNostring“6224A847-4867-41EE-851D-36CC8BA1B”
activationCodeNostring

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString


C#JavaScriptPHP


DeviceSendActivationCode Method

When a device is registered to the system, an activation process can be added to utilize the service to send the original registered device ID. The service will then return an activation code – which, will be sent via SMS to the user’s phone number as listed on registration.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
deviceIdNostring“6224A847-4867-41EE-851D-36CC8BA1B”

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString


C#JavaScriptPHP


LogOff Method

The service will log the user out of the app.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
“6224A847-4867-41EE-851D-36CC8BA1B”

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString


C#JavaScriptPHP


RegisterDevice Method

Register device service gives you the ability to register the user’s device and then to limit the user’s connectivity when needed.

You will be able to control the devices from the Devices tab under merchants/wallet

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
deviceIdNostring“6224A847-4867-41EE-851D-36CC8BA1B”
phoneNumberNostring

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString


C#JavaScriptPHP


ResetPassword Method

From time to time, users forget passwords. The service will reset the password to a temporary password and will generate an email to the user’s email address with instructions on how to change the password.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
EmailNostring“6224A847-4867-41EE-851D-36CC8BA1B”

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString


C#JavaScriptPHP


UpdatePassword Method

The login function is used for login into the app – besides the ability to send the user name password combo, it enables more info to be sent during login, for a more secure login (like – app token, device id etc.)

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
oldPasswordNostring“6224A847-4867-41EE-851D-36CC8BA1B”
newPasswordNostring

Response Fields


Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString


C#JavaScriptPHP


Using the old password, the user can change an existing password to a new one, as long as it complies with the password rules.

UpdatePincode Method

With the user’s password, the user can change the pin.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
PasswordNoString“6224A847-4867-41EE-851D-36CC8BA1B”
newPincodeNoString

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString


C#JavaScriptPHP