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 managment interface (folder created during setup). Used in cases designed text needs to be placed on a website or a mobile app.

    Request - Filters

    Parameter Mandatory Type Description
    contentName No string Name of the content file which has to be loaded.

    Response - Parameters

    Parameter Type Description
    d (root element) string Required content file text

    Examples

    Request

    {
      "contentName": "string"
    }

    Response

    {
      "d": "string"
    }
  • GetIdentityDetails

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

    Request - Filters

    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.

    Response - Parameters

    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

    Examples

    Request

    
      

    Response

    {
      "d": {
        "BrandName": "string",
        "CompanyName": "string",
        "CopyRightText": "string",
        "DomainName": "string",
        "IsActive": boolean,
        "Name": "string",
        "Theme": "string",
        "URLDevCenter": "string",
        "URLMerchantCP": "string",
        "URLProcess": "string",
        "URLWallet": "string",
        "URLWebsite": "string"
      }
    }
  • 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

    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.

    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.

    Parameter Type Description
    Key int Merchant group ID
    Value string Merchant group Name

    Examples

    Request

    
      

    Response

      {
      "d": [
        {
          "Key": int,
          "Value": "string"
        },
        ...
      ]
    }
  • GetSupportedCurrencies

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

    Request - Filters

    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.

    Response - Parameters

    Parameter Type Description
    d (root element) ArrayOfstring Array which contains ISO codes for all currencies supported by current identity

    Examples

    Request

    
      

    Response

    {
      "d": [ArrayOfstring]
    }
  • GetSupportedPaymentMethods

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

    Request - Filters

    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 payment methods 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

    Parameter Type Description
    d (root element) ArrayOfint Array which contains IDs for all payment methods' types supported by current identity

    Examples

    Request

    
      

    Response

    {
      "d": [ArrayOfint]
    }
  • 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

    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

    Response - Parameters

    Parameter Type Description
    This method is void and has an empty response body

    Examples

    Request

    {
      "severityId": int,
      "message": "string",
      "longMessage": "string"
    }

    Response

    {
      "d": null
    }
  • SendContactEmail

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

    Request - Filters

    Parameter Mandatory Type Description
    from No string Sender's email
    subject No string Email's subject
    body No string Email's text (body)

    Response - Parameters

    Parameter Type Description
    This method is void and has an empty response body

    Examples

    Request

    {
      "from": "string",
      "subject": "string",
      "body": "string"
    }

    Response

    {
      "d": null
    }