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.

Feel free to check the ChangeLog for additional information and latest updates to the service

  • GetCurrencyRates

    As services can be used in different territoriess 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

    Parameter Mandatory Type Description
    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.

    Parameter Type Description
    Key string Defines which currencies' rate this item describes - will return the currency 3 letter ISO
    Value decimal Rate for current currency

    Examples

    Request

    
        

    Response

    {
      "d": [
        {
          "Key": "string",
          "Value": decimal
        },
        ...
      ]
    }
  • GetErrorCodes

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

    Request - Filters

    Parameter Mandatory Type Description
    language No string Define language which error data should be returned with. Should contain language ISO
    groups No ArrayOfstring Define 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.

    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

    Examples

    Request

    {
      "language": "string",
      "groups": [ArrayOfstring]
    }

    Response

    {
      "d": [
        {
          "Code": int,
          "IsSuccess": boolean,
          "Key": "string",
          "Message": "string",
          "Number": "string"
        },
        ...
      ]
    }
  • 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

    Parameter Mandatory Type Description
    This method has an empty body as it doesn't require any input parameters.

    Response - Parameters

    Parameter Type Description
    CanadaStates Array Contains a list of objects with Canada states' data. Each object has three fields (Icon, Key, Name). Check detailed fields' descriptions below
    Icon string Icon for the current item
    Key string State's ISO
    Name string State's name
    Countries Array Contains a list of objects with countries' data. Each object has three fields (Icon, Key, Name). Check detailed fields' descriptions below
    Icon string Icon for the current item
    Key string Country's ISO
    Name string Country's name
    Languages Array Contains a list of objects with languages' data. Each object has three fields (Icon, Key, Name). Check detailed fields' descriptions below
    Icon string Icon for the current item
    Key string Language's ISO
    Name string Language's name
    UsaStates Array Contains a list of objects with USA states' data. Each object has three fields (Icon, Key, Name). Check detailed fields' descriptions below
    Icon string Icon for the current item
    Key string State's ISO
    Name string State's name

    Examples

    Request

    
        

    Response

    {
      "d": {
        "CanadaStates": [
          {
            "Icon": "string",
            "Key": "string",
            "Name": "string"
          },
          ...
        ],
        "Countries": [
          {
            "Icon": "string",
            "Key": "string",
            "Name": "string"
          },
          ...
        ],
        "Languages": [
          {
            "Icon": "string",
            "Key": "string",
            "Name": "string"
          },
          ...
        ],
        "UsaStates": [
          {
            "Icon": "string",
            "Key": "string",
            "Name": "string"
          },
          ...
        ]
      }
    }