Application Identity


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


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.

GetContent

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.

Request Filters


ParameterMandatoryTypeDescription
contentNameNostringName of the content file which has to be loaded.

Response – Parameters


ParameterTypeDescription
d (root element)stringRequired content file text


C#JavaScriptPHP


GetIdentityDetails

This service allows to get all identity information so that it could be presented on the client’s side.

Request Filters


ParameterMandatoryTypeDescription
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.

Response Parameters


ParameterTypeDescription
BrandNamestringBrand name for current identity/startup
CompanyNamestringCompany name for current identity
CopyRightTextstringCopyright text for current identity
DomainNamestringDomain name for current identity
IsActivebooleanDefines whether current identity is active
NamestringName for current identity
ThemestringTheme for current identity
URLDevCenterstringThe URL for the Developers management portal under the specific identity
URLMerchantCPstringThe URL for the Merchant management portal under the specific identity
URLProcessstringThe URL used to process transaction under the specific identity
URLWalletstringThe URL for the Wallet/User management portal under the specific identity
URLWebsitestringWebsite URL for current identity


C#JavaScriptPHP


GetMerchantGroups

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.

Request Filters


ParameterMandatoryTypeDescription
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.

Response Parameters

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.


ParameterTypeDescription
KeyintMerchant group ID
ValuestringMerchant group Name


C#JavaScriptPHP


GetSupportedCurrencies

App identity allows to control supported currencies. This service gives ability to get supported currencies for the current identity.

Request Filters


ParameterMandatoryTypeDescription
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.

Response Parameters


ParameterTypeDescription
d (root element)ArrayOfstringArray which contains ISO codes for all currencies supported by current identity

Examples


C#JavaScriptPHP


GetSupportedPaymentMethods

App identity allows to control supported payment methods. This service gives ability to get supported payment methods for the current identity.

Response Parameters


ParameterTypeDescription
d (root element)ArrayOfintArray which contains IDs for all payment methods’ types supported by current identity


C#JavaScriptPHP


Log

This method allows to send info about errors, or any other events occurred on the client’s side to the server side.

Request Filters


ParameterMandatoryTypeDescription
severityIdNointThe ID for the level of severity for the issue at hand
messageNostringLog issue title
longMessageNostringLog issue description

Response Parameters


ParameterTypeDescription
This method is void and has an empty response body


C#JavaScriptPHP


SendContactEmail

This service allows to send emails directly to the app identity owner.

Request Filters


ParameterMandatoryTypeDescription
fromNostringSender’s email
subjectNostringEmail’s subject
bodyNostringEmail’s text (body)

Response Parameters


ParameterTypeDescription
This method is void and has an empty response body


C#JavaScriptPHP