International Service


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

As a global system we provide you with all the tools you need to make sure your app is global too – use this webservice to get the latest currency rates and additional data without the need of using additional 3rd party providers or hard coding the data into your app.

GetCurrencyRates

As services can be used in different territories this method is designed to return currencies’ conversation rates available in the system to maintain the same rates on both admincash and the apps (websites) connected to it.

Request – Filters

ParameterMandatoryTypeDescription
This method has an empty body as it doesn't require any input parameters.

Response Parameters

As a response this method returns an array which contains objects with info about currency rates. Each object includes parameters represented in the table below.

ParameterTypeDescription
KeystringDefines which currencies' rate this item describes - will return the currency 3 letter ISO
ValuedecimalRate for current currency


C#JavaScriptPHP


GetSkills

This service call will return the list of skills that can be associated with a customer.

Request – Filters

ParameterMandatoryTypeDescription
This method has an empty body as it doesn't require any input parameters.

Response Parameters

As a response this method returns an array which contains objects with info about skills. Each object includes parameters represented in the table below.

ParameterTypeDescription
KeystringDefines which skill this item describes
ValuestringReturns the name of the skill


C#JavaScriptPHP


GetInterests

This service call will return the list of Interests that can be associated with a customer.

Request – Filters

ParameterMandatoryTypeDescription
This method has an empty body as it doesn't require any input parameters.

Response Parameters

As a response this method returns an array which contains objects with info about skills. Each object includes parameters represented in the table below.

ParameterTypeDescription
KeystringDefines which skill this item describes
ValuestringReturns the name of the skill


C#JavaScriptPHP


GetIndustries

This service call will return the list of Industries that can be associated with a customer.

Request – Filters

ParameterMandatoryTypeDescription
This method has an empty body as it doesn't require any input parameters.

Response Parameters

As a response this method returns an array which contains objects with info about skills. Each object includes parameters represented in the table below.

ParameterTypeDescription
KeystringDefines which skill this item describes
ValuestringReturns the name of the skill


C#JavaScriptPHP


GetErrorCodes

This service returns all reply codes and their data to allow customization of responses on the client’s side.

Request – Filters

ParameterMandatoryTypeDescription
languageNostringDefine language which error data should be returned with. Should contain language ISO
groupsNoArrayOfstringDefine errors of which groups should be returned

Response Parameters

As a response this method returns an array which contains objects with info about matching errors. Each object includes parameters represented in the table below.

ParameterTypeDescription
CodeintResult code
IsSuccessbooleanDefines whether service call was processed successfully or not
KeystringResult key ("Success", "Error", etc.)
MessagestringResult message


C#JavaScriptPHP


GetStaticData

This method returns all counties, Canada states, USA states and languages available in the system. Common practice is to call this service once and store the data locally for further usage during the current session.

Request – Filters

ParameterMandatoryTypeDescription
This method has an empty body as it doesn't require any input parameters.

Response Parameters

ParameterTypeDescription
CanadaStatesArrayContains a list of objects with Canada states' data. Each object has three fields (Icon, Key, Name). Check detailed fields' descriptions below
IconstringIcon for the current item
KeystringState's ISO
NamestringState's name
CountriesArrayContains a list of objects with countries' data. Each object has three fields (Icon, Key, Name). Check detailed fields' descriptions below
IconstringIcon for the current item
KeystringCountry's ISO
NamestringCountry's name
LanguagesArrayContains a list of objects with languages' data. Each object has three fields (Icon, Key, Name). Check detailed fields' descriptions below
IconstringIcon for the current item
KeystringLanguage's ISO
NamestringLanguage's name
UsaStatesArrayContains a list of objects with USA states' data. Each object has three fields (Icon, Key, Name). Check detailed fields' descriptions below
IconstringIcon for the current item
KeystringState's ISO
NamestringState's name


C#JavaScriptPHP