Application identity is our identifier for the apps running using our backend system – From the management interface you will define the set of permission you wish to give your apps and the Application identity service will give you the ability to access the data using the service.
This service allows to get an html file that is placed in the content folder listed in the “identity setup” in the management interface (folder created during setup). Used in cases designed text needs to be placed on a website or a mobile app.
Parameter | Mandatory | Type | Description |
---|---|---|---|
contentName | No | string | Name of the content file which has to be loaded. |
Parameter | Type | Description |
---|---|---|
d (root element) | string | Required content file text |
1 2 3 4 5 6 7 8 9 | var client = new RestClient("https://webservices.gr8pay.com/v2/appidentity.svc/GetContent"); 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.AddParameter("application/json", "{rn "contentName": "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 | var settings = { "url": "https://webservices.gr8pay.com/v2/appidentity.svc/GetContent", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5" }, "data": JSON.stringify({"contentName":"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 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/appidentity.svc/GetContent", 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 "contentName": "string"rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
This service allows to get all identity information so that it could be presented on the client’s side.
Parameter | Mandatory | Type | Description |
---|---|---|---|
This method has an empty body as it doesn’t require any input parameters. It takes application token from the request’s header automatically and this way detects details for which app identity have to be returned. Check Headers topic to get more info on how to add application token to request’s headers. |
Parameter | Type | Description |
---|---|---|
BrandName | string | Brand name for current identity/startup |
CompanyName | string | Company name for current identity |
CopyRightText | string | Copyright text for current identity |
DomainName | string | Domain name for current identity |
IsActive | boolean | Defines whether current identity is active |
Name | string | Name for current identity |
Theme | string | Theme for current identity |
URLDevCenter | string | The URL for the Developers management portal under the specific identity |
URLMerchantCP | string | The URL for the Merchant management portal under the specific identity |
URLProcess | string | The URL used to process transaction under the specific identity |
URLWallet | string | The URL for the Wallet/User management portal under the specific identity |
URLWebsite | string | Website URL for current identity |
1 2 3 4 5 6 7 8 9 | var client = new RestClient("https://webservices.gr8pay.com/v2/appidentity.svc/GetIdentityDetails"); 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.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 | var settings = { "url": "https://webservices.gr8pay.com/v2/appidentity.svc/GetIdentityDetails", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5" }, }; $.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 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/appidentity.svc/GetIdentityDetails", 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" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
Identity can be limited to a certain group of merchants. This service allows to know which groups are relevant to the identity to enable the developer to filter other services by relevant groups.
Parameter | Mandatory | Type | Description |
---|---|---|---|
This method has an empty body as it doesn’t require any input parameters. It takes application token from the request’s header automatically and this way detects merchant groups for which app identity have to be returned. Check Headers topic to get more info on how to add application token to request’s headers. |
As a response this method returns an array which contains objects with info about applicable merchant groups. Each object includes parameters represented in the table below.
Parameter | Type | Description |
---|---|---|
Key | int | Merchant group ID |
Value | string | Merchant group Name |
1 2 3 4 5 6 7 8 9 | var client = new RestClient("https://webservices.gr8pay.com/v2/appidentity.svc/GetMerchantGroups"); 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.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 | var settings = { "url": "https://webservices.gr8pay.com/v2/appidentity.svc/GetMerchantGroups", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5" }, }; $.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 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/appidentity.svc/GetMerchantGroups", 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" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
App identity allows to control supported currencies. This service gives ability to get supported currencies for the current identity.
Parameter | Mandatory | Type | Description |
---|---|---|---|
This method has an empty body as it doesn’t require any input parameters. It takes application token from the request’s header automatically and this way detects supported currencies for which app identity have to be returned. Check Headers topic to get more info on how to add application token to request’s headers. |
Parameter | Type | Description |
---|---|---|
d (root element) | ArrayOfstring | Array which contains ISO codes for all currencies supported by current identity |
1 2 3 4 5 6 7 8 9 | var client = new RestClient("https://webservices.gr8pay.com/v2/appidentity.svc/GetSupportedCurrencies"); 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.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 | var settings = { "url": "https://webservices.gr8pay.com/v2/appidentity.svc/GetSupportedCurrencies", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5" }, }; $.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 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/appidentity.svc/GetSupportedCurrencies", 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" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
App identity allows to control supported payment methods. This service gives ability to get supported payment methods for the current identity.
Parameter | Type | Description |
---|---|---|
d (root element) | ArrayOfint | Array which contains IDs for all payment methods’ types supported by current identity |
1 2 3 4 5 6 7 8 9 | var client = new RestClient("https://webservices.gr8pay.com/v2/appidentity.svc/GetSupportedPaymentMethods"); 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.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 | var settings = { "url": "https://webservices.gr8pay.com/v2/appidentity.svc/GetSupportedPaymentMethods", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5" }, }; $.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 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/appidentity.svc/GetSupportedPaymentMethods", 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" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
This method allows to send info about errors, or any other events occurred on the client’s side to the server side.
Parameter | Mandatory | Type | Description |
---|---|---|---|
severityId | No | int | The ID for the level of severity for the issue at hand |
message | No | string | Log issue title |
longMessage | No | string | Log issue description |
Parameter | Type | Description |
---|---|---|
This method is void and has an empty response body |
1 2 3 4 5 6 7 8 9 | var client = new RestClient("https://webservices.gr8pay.com/v2/appidentity.svc/Log"); 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.AddParameter("application/json", "{rn "severityId": int,rn "message": "string",rn "longMessage": "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 | var settings = { "url": "https://webservices.gr8pay.com/v2/appidentity.svc/Log", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5" }, "data": "{rn "severityId": int,rn "message": "string",rn "longMessage": "string"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 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/appidentity.svc/Log", 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 "severityId": int,rn "message": "string",rn "longMessage": "string"rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
This service allows to send emails directly to the app identity owner.
Parameter | Mandatory | Type | Description |
---|---|---|---|
from | No | string | Sender’s email |
subject | No | string | Email’s subject |
body | No | string | Email’s text (body) |
Parameter | Type | Description |
---|---|---|
This method is void and has an empty response body |
1 2 3 4 5 6 7 8 9 | var client = new RestClient("https://webservices.gr8pay.com/v2/appidentity.svc/SendContactEmail"); 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.AddParameter("application/json", "{rn "from": "string",rn "subject": "string",rn "body": "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 | var settings = { "url": "https://webservices.gr8pay.com/v2/appidentity.svc/SendContactEmail", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5" }, "data": JSON.stringify({"from":"string","subject":"string","body":"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 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/appidentity.svc/SendContactEmail", 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 "from": "string",rn "subject": "string",rn "body": "string"rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |