The customer web service allows the management of all the customer related information. The API allows you to create, delete, and update your customers. You can retrieve individual customers as well as a list of all your customers.
The service will return all of the user’s information – from addresses to private information, such as DOB and more.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
GetCustomer | ApplicationToken | Yes | string | “6224A847-4867-41EE-851D-36CC8BA1B” |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetCustomer"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetCustomer", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetCustomer", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
This is the “Sign up” service – you will use this service to register a new Customer.
The service will enable you to register all of the user’s information along with a shipping address and payment method.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
data | No | Customer.CustomerRegisterData | “6224A847-4867-41EE-851D-36CC8BA1B” | ||
ApplicationToken | No | String | |||
Password | No | String | |||
PinCode | No | String | |||
ShippingAddress | No | Array | |||
AddressLine1 | No | String | |||
AddressLine2 | No | String | |||
City | No | String | |||
CountryIso | No | String | |||
PostalCode | No | String | |||
StateIso | No | String | |||
Comment | No | String | |||
ID | No | String | |||
IsDefault | No | String | |||
Title | No | String | |||
StoredPaymentMethods | No | PaymentMethods.StoredPaymentMethod | |||
AccountValue1 | No | String | |||
AccountValue2 | No | String | |||
BillingAddress | No | ServiceAddress | |||
AddressLine1 | No | String | |||
AddressLine2 | No | String | |||
City | No | String | |||
CountryIso | No | String | |||
PostalCode | No | String | |||
StateIso | No | String | |||
Display | No | String | |||
ExpirationDate | No | dateTime | |||
ID | No | Int | |||
Icon | No | String | |||
IsDefault | No | Boolean | |||
IssuerCountryIsoCode | No | String | |||
Last4Digits | No | String | |||
OwnerName | No | String | |||
PaymentMethodGroupKey | No | String | |||
Title | No | String | |||
Info | No | Customer.CustomerData | |||
AddressLine1 | No | String | |||
AddressLine2 | No | String | |||
City | No | String | |||
CountryIso | No | String | |||
PostalCode | No | String | |||
StateIso | No | String | |||
CellNumber | No | String | |||
CustomerNumber | No | String | |||
DateOfBirth | No | String | |||
EmailAddress | No | String | |||
FirstName | No | String | |||
LastName | No | String | |||
PersonalNumber | No | String | |||
PhoneNumber | No | String | |||
ProfileImage | No | Base64Binary | |||
ProfileImageSize | No | Long | |||
RegistrationDate | No | dateTime |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/RegisterCustomer"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "data": {rn "ApplicationToken": "string",rn "Password": "string",rn "PinCode": "string",rn "ShippingAddresses": [rn {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "Comment": "string",rn "ID": int,rn "IsDefault": boolean,rn "Title": "string"rn },rn ...rn ],rn "StoredPaymentMethods": [rn {rn "AccountValue1": "string",rn "AccountValue2": "string",rn "BillingAddress": {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string"rn },rn "Display": "string",rn "ExpirationDate": dateTime,rn "ID": int,rn "Icon": "string",rn "IsDefault": boolean,rn "IssuerCountryIsoCode": "string",rn "Last4Digits": "string",rn "OwnerName": "string",rn "PaymentMethodGroupKey": "string",rn "PaymentMethodKey": "string",rn "Title": "string"rn },rn ...rn ],rn "Prepaid":{rnrn "Currency":"USD", rn "AccountNum":"5235419760015568", rn "OccupationId": 2 rnrn },rn "info": {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "CellNumber": "string",rn "CustomerNumber": "string",rn "DateOfBirth": dateTime,rn "EmailAddress": "string",rn "UserName": "string",rn "FirstName": "string",rn "LastName": "string",rn "PersonalNumber": "string",rn "PhoneNumber": "string",rn "ProfileImage": base64Binary,rn "ProfileImageSize": long,rn "RegistrationDate": dateTime,rn "Gender": "Male",rn "Industry": null,rn "Education": null,rn "MaritalStatus": null,rn "SignificantOther": null,rn "IsAgreeTerms": true,rn "IsAgreePolicy": truern "Interests": [],rn "Skills": [],rn }rn }rn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/RegisterCustomer", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "data": {rn "ApplicationToken": "string",rn "Password": "string",rn "PinCode": "string",rn "ShippingAddresses": [rn {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "Comment": "string",rn "ID": int,rn "IsDefault": boolean,rn "Title": "string"rn },rn ...rn ],rn "StoredPaymentMethods": [rn {rn "AccountValue1": "string",rn "AccountValue2": "string",rn "BillingAddress": {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string"rn },rn "Display": "string",rn "ExpirationDate": dateTime,rn "ID": int,rn "Icon": "string",rn "IsDefault": boolean,rn "IssuerCountryIsoCode": "string",rn "Last4Digits": "string",rn "OwnerName": "string",rn "PaymentMethodGroupKey": "string",rn "PaymentMethodKey": "string",rn "Title": "string"rn },rn ...rn ],rn "Prepaid":{rnrn "Currency":"USD", rn "AccountNum":"5235419760015568", rn "OccupationId": 2 rnrn },rn "info": {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "CellNumber": "string",rn "CustomerNumber": "string",rn "DateOfBirth": dateTime,rn "EmailAddress": "string",rn "UserName": "string",rn "FirstName": "string",rn "LastName": "string",rn "PersonalNumber": "string",rn "PhoneNumber": "string",rn "ProfileImage": base64Binary,rn "ProfileImageSize": long,rn "RegistrationDate": dateTime,rn "Gender": "Male",rn "Industry": null,rn "Education": null,rn "MaritalStatus": null,rn "SignificantOther": null,rn "IsAgreeTerms": true,rn "IsAgreePolicy": truern "Interests": [],rn "Skills": [],rn }rn }rn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/RegisterCustomer", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "data": {rn "ApplicationToken": "string",rn "Password": "string",rn "PinCode": "string",rn "ShippingAddresses": [rn {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "Comment": "string",rn "ID": int,rn "IsDefault": boolean,rn "Title": "string"rn },rn ...rn ],rn "StoredPaymentMethods": [rn {rn "AccountValue1": "string",rn "AccountValue2": "string",rn "BillingAddress": {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string"rn },rn "Display": "string",rn "ExpirationDate": dateTime,rn "ID": int,rn "Icon": "string",rn "IsDefault": boolean,rn "IssuerCountryIsoCode": "string",rn "Last4Digits": "string",rn "OwnerName": "string",rn "PaymentMethodGroupKey": "string",rn "PaymentMethodKey": "string",rn "Title": "string"rn },rn ...rn ],rn "Prepaid":{rnrn "Currency":"USD", rn "AccountNum":"5235419760015568", rn "OccupationId": 2 rnrn },rn "info": {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "CellNumber": "string",rn "CustomerNumber": "string",rn "DateOfBirth": dateTime,rn "EmailAddress": "string",rn "UserName": "string",rn "FirstName": "string",rn "LastName": "string",rn "PersonalNumber": "string",rn "PhoneNumber": "string",rn "ProfileImage": base64Binary,rn "ProfileImageSize": long,rn "RegistrationDate": dateTime,rn "Gender": "Male",rn "Industry": null,rn "Education": null,rn "MaritalStatus": null,rn "SignificantOther": null,rn "IsAgreeTerms": true,rn "IsAgreePolicy": truern "Interests": [],rn "Skills": [],rn }rn }rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
After a Customer has been successfully registered, any change to the customer’s personal information will be saved using this function.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
info | No | String | “6224A847-4867-41EE-851D-36CC8BA1B” | ||
ServiceAddress | Array | ||||
AddressLine1 | No | String | |||
AddressLine2 | No | String | |||
City | No | String | |||
CountryIso | No | String | |||
PostalCode | No | String | |||
StateIso | No | String | |||
CellNumber | No | String | |||
CustomerNumber | No | String | |||
DateOfBirth | No | String | |||
EmailAddress | No | String | |||
FirstName | No | String | |||
LastName | No | String | |||
PersonalNumber | No | String | |||
PhoneNumber | No | String | |||
ProfileImage | No | base64Binary | |||
ProfileImageSize | No | Long | |||
RegistrationDate | No | dateTime |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/SaveCustomer"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "info": {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "CellNumber": "string",rn "CustomerNumber": "string",rn "DateOfBirth": dateTime,rn "EmailAddress": "string",rn "FirstName": "string",rn "LastName": "string",rn "PersonalNumber": "string",rn "PhoneNumber": "string",rn "IsAgreeTerms": boolean,rn "IsAgreePolicy": boolean,rn "ProfileImage": base64Binary,rn "ProfileImageSize": long,rn "RegistrationDate": dateTimern }rn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/SaveCustomer", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "info": {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "CellNumber": "string",rn "CustomerNumber": "string",rn "DateOfBirth": dateTime,rn "EmailAddress": "string",rn "FirstName": "string",rn "LastName": "string",rn "PersonalNumber": "string",rn "PhoneNumber": "string",rn "IsAgreeTerms": boolean,rn "IsAgreePolicy": boolean,rn "ProfileImage": base64Binary,rn "ProfileImageSize": long,rn "RegistrationDate": dateTimern }rn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/SaveCustomer", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "info": {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "CellNumber": "string",rn "CustomerNumber": "string",rn "DateOfBirth": dateTime,rn "EmailAddress": "string",rn "FirstName": "string",rn "LastName": "string",rn "PersonalNumber": "string",rn "PhoneNumber": "string",rn "IsAgreeTerms": boolean,rn "IsAgreePolicy": boolean,rn "ProfileImage": base64Binary,rn "ProfileImageSize": long,rn "RegistrationDate": dateTimern }rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
The search function will allow you send certain terms, with a definition of the page size and the page number.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
destWalletId | ApplicationToken | No | string | “Bobby” |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/FindFriend"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "searchTerm": "string",rn "sortAndPage": {rn "PageNumber": int,rn "PageSize": intrn }rn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/FindFriend", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "searchTerm": "string",rn "sortAndPage": {rn "PageNumber": int,rn "PageSize": intrn }rn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/FindFriend", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "searchTerm": "string",rn "sortAndPage": {rn "PageNumber": int,rn "PageSize": intrn }rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
By sending the destination wallet ID the source user will send a request to the destination user.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
destWalletId | ApplicationToken | No | string | “Bobby” |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/FriendRequest"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "destWalletId": "string"rn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/FriendRequest", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": JSON.stringify({"destWalletId":"string"}), }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/FriendRequest", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "destWalletId": "string"rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
The service will return all pending friend requests tothe user and will provide the necessary info to reply to the requests.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
GetCustomer | ApplicationToken | Yes | string | “6224A847-4867-41EE-851D-36CC8BA1B” |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetFriendRequests"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "destWalletId": "string"rn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetFriendRequests", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": JSON.stringify({"destWalletId":"string"}), }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetFriendRequests", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "destWalletId": "string"rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
The service will return a list of all of the user’s friends with their information.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
destWalletId | ApplicationToken | No | string | “6224A847-4867-41EE-851D-36CC8BA1B” |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetFriends"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "destWalletId": "string"rn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetFriends", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": JSON.stringify({"destWalletId":"string"}), }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetFriends", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "destWalletId": "string"rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
<<Description to Follow>> – Import your Facebook Friends
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
Info | ApplicationToken | Yes | string | “6224A847-4867-41EE-851D-36CC8BA1B” |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 | PASTE CODE HERE |
1 2 3 |
1 |
1 2 3 | { "accessToken": "string" } |
1 |
Simple, enough this service will help you delete the friend you no longer wish to have.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
destWalletId | No | string | “6224A847-4867-41EE-851D-36CC8BA1B” |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/RemoveFriend"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "destWalletId": "string"rn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/RemoveFriend", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": JSON.stringify({"destWalletId":"string"}), }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/RemoveFriend", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "destWalletId": "string"rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
The combo of “Friend request” / “GetFriendRequests” and “ReplyFriendRequest” give the full management of the friendship cycle.
After sending a friend request to a user the user can decide whether or not to approve the request . This service allows you to send the appropriate response to the request.
FieldName | Mandatory? | Field Type | Description | Sample |
---|---|---|---|---|
destWalletId | No | string | “6224A847-4867-41EE-851D-36CC8BA1B” | |
Approve | No | boolean |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/ReplyFriendRequest"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "destWalletId": "string",rn "approve": booleanrn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/ReplyFriendRequest", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "destWalletId": "string",rn "approve": booleanrn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/ReplyFriendRequest", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "destWalletId": "string",rn "approve": booleanrn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
Relationships are important – we give every user the ability to save a relationship setting for each friend..
Relation types:
FieldName | Mandatory? | Field Type | Description | Sample |
---|---|---|---|---|
destWalletId | No | string | ||
relationTypeKey | No | int |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/SetFriendRelation"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "destWalletId": "string",rn "relationTypeKey": intrn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/SetFriendRelation", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "destWalletId": "string",rn "relationTypeKey": intrn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/SetFriendRelation", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "destWalletId": "string",rn "relationTypeKey": intrn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
This method allows to get full list of positions of the currently logged in user
Parameter | Mandatory | Type | Description |
---|---|---|---|
This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects data for which user has to be returned. Check Headers topic to get more info on how to add credentials token to request's headers. |
Parameter | Type | Description |
---|---|---|
ID | int | This will return the IDs of the positions available for the Customer |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetPositions"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{\r\n \"d\": {\r\n [1,3,6]\r\n }\r\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetPositions", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{\r\n \"d\": {\r\n [1,3,6]\r\n }\r\n}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetPositions", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{\r\n \"d\": {\r\n [1,3,6]\r\n }\r\n}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
This method will return all info of a specific position
Parameter | Mandatory | Type | Description |
---|---|---|---|
ID | Yes | string | ID of the position as it was returned from GetPositions service |
Parameter | Mandatory | Type | Description |
---|---|---|---|
Title | int | The title of the position such as CEO/COO/CMO etc | |
Summary | int | A short description of the position | |
IsCurrent | int | Is the customer still working at that position | |
Company | int | The name of the company the customer works at. | |
CompanySite | int | The website of the company the customer works at | |
StartDate | int | The date the customer started working at the position. | |
EndDate | int | The date the customer stopped working at the position. | |
Industry | int | The industry in which the company belongs to. |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetPosition"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{\r\n \"d\": {\r\n \"Title\":\"Test\",\r\n \"Summary\":\"Test\",\r\n \"IsCurrent\":\"false\",\r\n \"Company\":\"Test\",\r\n \"CompanySite\":\"Test\",\r\n \"StartDate\":\"/Date(1488102159550+0200)/\",\r\n \"EndDate\":\"/Date(1488102159550+0200)/\",\r\n {\"Industry\":{\"ID\":\"3\"}}\r\n }\r\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetPosition", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{\r\n \"d\": {\r\n \"Title\":\"Test\",\r\n \"Summary\":\"Test\",\r\n \"IsCurrent\":\"false\",\r\n \"Company\":\"Test\",\r\n \"CompanySite\":\"Test\",\r\n \"StartDate\":\"/Date(1488102159550+0200)/\",\r\n \"EndDate\":\"/Date(1488102159550+0200)/\",\r\n {\"Industry\":{\"ID\":\"3\"}}\r\n }\r\n}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetPosition", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{\r\n \"d\": {\r\n \"Title\":\"Test\",\r\n \"Summary\":\"Test\",\r\n \"IsCurrent\":\"false\",\r\n \"Company\":\"Test\",\r\n \"CompanySite\":\"Test\",\r\n \"StartDate\":\"/Date(1488102159550+0200)/\",\r\n \"EndDate\":\"/Date(1488102159550+0200)/\",\r\n {\"Industry\":{\"ID\":\"3\"}}\r\n }\r\n}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
1 |
1 2 3 | { "accessToken": "string" } |
1 |
This method allows to get full info about the currently logged in user
Parameter | Mandatory | Type | Description |
---|---|---|---|
Title | int | The title of the position such as CEO/COO/CMO etc | |
Summary | int | A short description of the position | |
IsCurrent | int | Is the customer still working at that position | |
Company | int | The name of the company the customer works at. | |
CompanySite | int | The website of the company the customer works at | |
StartDate | int | The date the customer started working at the position. | |
EndDate | int | The date the customer stopped working at the position. | |
Industry | int | The industry in which the company belongs to. |
Parameter | Type | Description |
---|---|---|
ID | int | This will return the IDs of the positions available for the Customer |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/SetPosition"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{\r\n \"data\":{\r\n \"Title\":\"Test\",\r\n \"Summary\":\"Test\",\r\n \"IsCurrent\":\"false\",\r\n \"Company\":\"Test\",\r\n \"CompanySite\":\"Test\",\r\n \"StartDate\":\"/Date(1488102159550+0200)/\",\r\n \"EndDate\":\"/Date(1488102159550+0200)/\",\r\n {\"Industry\":{\"ID\":\"3\"}}\r\n }\r\n }", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/SetPosition", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{\r\n \"data\":{\r\n \"Title\":\"Test\",\r\n \"Summary\":\"Test\",\r\n \"IsCurrent\":\"false\",\r\n \"Company\":\"Test\",\r\n \"CompanySite\":\"Test\",\r\n \"StartDate\":\"/Date(1488102159550+0200)/\",\r\n \"EndDate\":\"/Date(1488102159550+0200)/\",\r\n {\"Industry\":{\"ID\":\"3\"}}\r\n }\r\n }", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/SetPosition", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{\r\n \"data\":{\r\n \"Title\":\"Test\",\r\n \"Summary\":\"Test\",\r\n \"IsCurrent\":\"false\",\r\n \"Company\":\"Test\",\r\n \"CompanySite\":\"Test\",\r\n \"StartDate\":\"/Date(1488102159550+0200)/\",\r\n \"EndDate\":\"/Date(1488102159550+0200)/\",\r\n {\"Industry\":{\"ID\":\"3\"}}\r\n }\r\n }", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
The service will return the image for the wallet ID
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
walletId | ApplicationToken | No | string | “6224A847-4867-41EE-851D-36CC8BA1B” | |
asRaw | No | boolean |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetImage"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "walletId": "string",rn "asRaw": booleanrn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetImage", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "walletId": "string",rn "asRaw": booleanrn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetImage", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "walletId": "string",rn "asRaw": booleanrn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
Delete a user’s specific shipping address by using the AddressID.
FieldName | Mandatory? | Field Type | Description | Sample |
---|---|---|---|---|
searchTerm | No | string | “Bob” | |
sortAndPage | No | SortAndPage | ||
PageNumber | No | int | ||
PageSize | No | int |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/DeleteShippingAddress"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "addressId": intrn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/DeleteShippingAddress", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "addressId": intrn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/DeleteShippingAddress", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "addressId": intrn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
The service will return the specific shipping address details through the shipping address ID.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
addressId | ApplicationToken | No | Int | “6224A847-4867-41EE-851D-36CC8BA1B” |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetShippingAddress"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "addressId": intrn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetShippingAddress", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "addressId": intrn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetShippingAddress", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "addressId": intrn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
The service will return all of the user’s shipping addresses.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
Info | ApplicationToken | Yes | string | “6224A847-4867-41EE-851D-36CC8BA1B” |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetShippingAddresses"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetShippingAddresses", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetShippingAddresses", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
Managing shipping addresses can have its complexities – when saving a new “Default shipping address” the rest of the addresses are also affected – this service will allow changes to be made to all addresses at the same time.
FieldName | Mandatory? | Field Type | Description | Sample | |
---|---|---|---|---|---|
data | no | array | |||
AddressLine1 | No | String | |||
AddressLine2 | No | String | |||
City | No | String | |||
CountryIso | No | String | |||
PostalCode | No | String | |||
StateIso | No | String | |||
Comment | No | String | |||
ID | No | Int | |||
IsDefault | No | Boolean | |||
Title | No | String |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/SaveShippingAddresses"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "data": [rn {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "Comment": "string",rn "ID": int,rn "IsDefault": boolean,rn "Title": "string"rn },rn ...rn ]rn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/SaveShippingAddresses", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "data": [rn {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "Comment": "string",rn "ID": int,rn "IsDefault": boolean,rn "Title": "string"rn },rn ...rn ]rn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/SaveShippingAddresses", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "data": [rn {rn "AddressLine1": "string",rn "AddressLine2": "string",rn "City": "string",rn "CountryIso": "string",rn "PostalCode": "string",rn "StateIso": "string",rn "Comment": "string",rn "ID": int,rn "IsDefault": boolean,rn "Title": "string"rn },rn ...rn ]rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
This method allows to register a new user in the system which will be defined as a subuser for the already registered user. The subuser will be as any other user in the system but will connected to the main account with a relation type. The subaccount registration process is shorter but the ability to add additional info to the subaccount is available using the “SaveCustomer” service.It also automatically checks whether provided email was registered earlier to avoid creating accounts with similar emails.
Parameter | Mandatory | Type | Description |
---|---|---|---|
Data | No | This block contains registration data | |
ApplicationToken | No | string | Set your application token here |
Password | No | string | User's password |
PinCode | No | string | User's PIN code |
CellNumber | No | string | User's cell phone number |
EmailAddress | No | string | User's email |
FirstName | No | string | User's first name |
LastName | No | string | User's last name |
PersonalNumber | No | string | User's personal number |
PhoneNumber | No | string | User's phone number |
Parameter | Type | Description |
---|---|---|
Code | int | Result code |
IsSuccess | boolean | Defines whether service call was processed successfully or not |
Key | string | Result key ("Success", "Error", etc.) |
Message | string | Result message |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/RegisterCustomerAsSubAccount"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{\r\n \"data\": {\r\n \"ApplicationToken\": \"string\",\r\n \"Password\": \"string\",\r\n \"PinCode\": \"string\",\r\n \"info\": {\r\n \"CellNumber\": \"string\",\r\n \"EmailAddress\": \"string\",\r\n \"FirstName\": \"string\",\r\n \"LastName\": \"string\",\r\n \"PersonalNumber\": \"string\",\r\n \"PhoneNumber\": \"string\",\r\n }\r\n }\r\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/RegisterCustomerAsSubAccount", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{\r\n \"data\": {\r\n \"ApplicationToken\": \"string\",\r\n \"Password\": \"string\",\r\n \"PinCode\": \"string\",\r\n \"info\": {\r\n \"CellNumber\": \"string\",\r\n \"EmailAddress\": \"string\",\r\n \"FirstName\": \"string\",\r\n \"LastName\": \"string\",\r\n \"PersonalNumber\": \"string\",\r\n \"PhoneNumber\": \"string\",\r\n }\r\n }\r\n}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/RegisterCustomerAsSubAccount", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{\r\n \"data\": {\r\n \"ApplicationToken\": \"string\",\r\n \"Password\": \"string\",\r\n \"PinCode\": \"string\",\r\n \"info\": {\r\n \"CellNumber\": \"string\",\r\n \"EmailAddress\": \"string\",\r\n \"FirstName\": \"string\",\r\n \"LastName\": \"string\",\r\n \"PersonalNumber\": \"string\",\r\n \"PhoneNumber\": \"string\",\r\n }\r\n }\r\n}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
This method allows already existing users to log into the system.
Parameter | Mandatory | Type | Description |
---|---|---|---|
childCustomerNumber | Yes | string | Customer ID of the sub account you wish to login on his behalf |
Parameter | Type | Description |
---|---|---|
Code | int | Result code |
IsSuccess | boolean | Defines whether service call was processed successfully or not |
Key | string | Result key ("Success", "Error", etc.) |
Message | string | Result message |
CredentialsHeaderName | string | Name of the header which should hold credentials token. Check headers' topic to get more info |
CredentialsToken | string | User's credentials token, which should be also added to headers. Check headers' topic to get more info |
EncodedCookie | string | *TBD* |
IsDeviceActivated | boolean | Defines whether devices was activated using DeviceActivate method |
IsDeviceBlocked | boolean | Defines whether device was blocked by the system |
IsDeviceRegistered | boolean | Defines whether devices was registered using RegisterDevice method |
IsDeviceRegistrationRequired | boolean | Defines whether registering device with RegisterDevice method is required |
IsFirstLogin | boolean | Defines whether this is first login for the account |
LastLogin | dateTime | Date of the previous login with this account |
VersionUpdateRequired | boolean | Defines whether application has to be updated |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetChildCredentials"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{\r\n \"email\": \"string\",\r\n \"userName\": \"string\",\r\n \"password\": \"string\",\r\n \"options\": {\r\n \"appName\": \"string\",\r\n \"applicationToken\": \"string\",\r\n \"deviceId\": \"string\",\r\n \"pushToken\": \"string\",\r\n \"setCookie\": boolean\r\n }\r\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetChildCredentials", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{\r\n \"email\": \"string\",\r\n \"userName\": \"string\",\r\n \"password\": \"string\",\r\n \"options\": {\r\n \"appName\": \"string\",\r\n \"applicationToken\": \"string\",\r\n \"deviceId\": \"string\",\r\n \"pushToken\": \"string\",\r\n \"setCookie\": boolean\r\n }\r\n}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetChildCredentials", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{\r\n \"email\": \"string\",\r\n \"userName\": \"string\",\r\n \"password\": \"string\",\r\n \"options\": {\r\n \"appName\": \"string\",\r\n \"applicationToken\": \"string\",\r\n \"deviceId\": \"string\",\r\n \"pushToken\": \"string\",\r\n \"setCookie\": boolean\r\n }\r\n}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
This method allows to get the list of all sub accounts for the currently logged in user
Parameter | Mandatory | Type | Description |
---|---|---|---|
This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects data for which user has to be returned. Check Headers topic to get more info on how to add credentials token to request's headers. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
CustomerNumber | No | string | ID of the user |
CustomerName | No | string | User's full name |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/customer.svc/GetManagedAccounts"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{\r\n {\r\n \"d\": {\r\n \"__type\": \"Customer.CustomerData:WebServices\",\r\n {\r\n \"CustomerNumber\": \"6816476\",\r\n \"FullName\": \"John Doe\"\r\n },\r\n {\r\n \"CustomerNumber\": \"6816987\",\r\n \"FullName\": \"John Noe\"\r\n },\r\n {\r\n \"CustomerNumber\": \"6816857\",\r\n \"FullName\": \"John Loee\"\r\n } \r\n }\r\n}\r\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/customer.svc/GetManagedAccounts", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{\r\n {\r\n \"d\": {\r\n \"__type\": \"Customer.CustomerData:WebServices\",\r\n {\r\n \"CustomerNumber\": \"6816476\",\r\n \"FullName\": \"John Doe\"\r\n },\r\n {\r\n \"CustomerNumber\": \"6816987\",\r\n \"FullName\": \"John Noe\"\r\n },\r\n {\r\n \"CustomerNumber\": \"6816857\",\r\n \"FullName\": \"John Loee\"\r\n } \r\n }\r\n}\r\n}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/customer.svc/GetManagedAccounts", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{\r\n {\r\n \"d\": {\r\n \"__type\": \"Customer.CustomerData:WebServices\",\r\n {\r\n \"CustomerNumber\": \"6816476\",\r\n \"FullName\": \"John Doe\"\r\n },\r\n {\r\n \"CustomerNumber\": \"6816987\",\r\n \"FullName\": \"John Noe\"\r\n },\r\n {\r\n \"CustomerNumber\": \"6816857\",\r\n \"FullName\": \"John Loee\"\r\n } \r\n }\r\n}\r\n}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |