Maybe you want to have a single page documentation and use sidebar navigation for navigating inside the page. So this sample layouts are for you. Even maybe you'd like to use top navigation bar for navigating between your pages.

  • GetRequest

    The systems allows to transfer money between users. In case one user needs help, he may send a transfer request to another user. This method allows to get full info about exact request

    Request - Filters

    Parameter Mandatory Type Description
    requestId No int ID of the required request

    Response - Parameters

    Parameter Type Description
    Amount decimal Amount which was requested
    ConfirmDate dateTime Date on which the request was confirmed
    CurrencyISOCode string Request's currency ISO
    ID int ID of the request
    IsApproved boolean Defines whether request was approved (true), not approved yet (false) or declined (false)
    IsPush boolean Defines if the balance request is originated by a request from the receiving account or by the transferring account - True = No original request
    RequestDate dateTime Date on which the amount was requested
    SourceAccountID int ID of the customer which has sent a request (either for push or pull of funds) according to this request
    SourceAccountName string Name of the customer which has sent this request
    SourceText string Comment which has been left when the request has been approved/declined
    TargetAccountID int ID of the customer which has received the request
    TargetAccountName string Name of the customer which has received the request
    TargetText string Comment which has been left when the request has been sent

    Examples

    Request

    {
      "requestId": int
    }

    Response

    {
      "d": {
        "Amount": decimal,
        "ConfirmDate": dateTime,
        "CurrencyISOCode": "string",
        "ID": int,
        "IsApproved": boolean,
        "IsPush": boolean,
        "RequestDate": dateTime,
        "SourceAccountID": int,
        "SourceAccountName": "string",
        "SourceText": "string",
        "TargetAccountID": int,
        "TargetAccountName": "string",
        "TargetText": "string"
      }
    }
  • GetRequests

    The systems allows to transfer money between users. In case one user needs help, he may send a transfer request to another user. This method allows to get a list of requests, which match specified parameters.
    It returns results by pages and assumes that all pages have similar size. For example, in case you'll set page 1 with page size 20, you'll receive items at positions from 20 to 40, but in case you'll set page 1 with page size 5, you'll receive items at positions from 5 to 10, not depending on what results you received before.

    Request - Filters

    Parameter Mandatory Type Description
    filters No This block contains products' filters
    CurrencyIso No string Define which currency requests should be returned for. Should contain currency ISO
    StoredPaymentMethodID No int The ID given to the payment method once it was saved to the system.
    sortAndPage No This block contains sort and page filters
    PageNumber No int Set page number here. Minimum value is 1
    PageSize No int Set amount of items per page here

    Response - Parameters

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

    Parameter Type Description
    Amount decimal Amount which was requested
    ConfirmDate dateTime Date on which the request was confirmed
    CurrencyISOCode string Request's currency ISO
    ID int ID of the request
    IsApproved boolean Defines whether request was approved (true), not approved yet (false) or declined (false)
    IsPush boolean Defines if the balance request is originated by a request from the receiving account or by the transferring account - True = No original request
    RequestDate dateTime Date on which the amount was requested
    SourceAccountID int ID of the customer which has sent a request
    SourceAccountName string Name of the customer which has sent a request
    SourceText string Comment which has been left when the request has been approved/declined
    TargetAccountID int ID of the customer which has received the request
    TargetAccountName string Name of the customer which has received the request
    TargetText string Comment which has been left when the request has been sent

    Examples

    Request

    {
      "filters": {
        "CurrencyIso": "string",
        "StoredPaymentMethodID": int
      },
      "sortAndPage": {
        "PageNumber": int,
        "PageSize": int
      }
    }

    Response

    {
      "d": [
        {
          "Amount": decimal,
          "ConfirmDate": dateTime,
          "CurrencyISOCode": "string",
          "ID": int,
          "IsApproved": boolean,
          "IsPush": boolean,
          "RequestDate": dateTime,
          "SourceAccountID": int,
          "SourceAccountName": "string",
          "SourceText": "string",
          "TargetAccountID": int,
          "TargetAccountName": "string",
          "TargetText": "string"
        },
        ...
      ]
    }
  • GetRows

    This method allows to get a list of transactions, which match specified parameters.
    It returns results by pages and assumes that all pages have similar size. For example, in case you'll set page 1 with page size 20, you'll receive items at positions from 20 to 40, but in case you'll set page 1 with page size 5, you'll receive items at positions from 5 to 10, not depending on what results you received before.

    Request - Filters

    Parameter Mandatory Type Description
    filters No This block contains products' filters
    CurrencyIso No string Define which currency the amount should be transferred in. Should contain currency ISO
    StoredPaymentMethodID No int The ID of the payment method to be used for topup.
    sortAndPage No This block contains sort and page filters
    PageNumber No int Set page number here. Minimum value is 1
    PageSize No int Set amount of items per page here

    Response - Parameters

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

    Parameter Type Description
    Amount decimal Transaction's amount
    CurrencyIso string Transaction's currency ISO
    ID int ID of the transaction
    InsertDate dateTime Date when the transaction was performed
    IsPending boolean Defines whether transaction has been processed
    SourceID int ID of the source which has sent money according to this transaction
    SourceType string Type of the source which has sent money according to this transaction
    Text string Comment for this transaction
    Total decimal remaining funds after transaction

    Examples

    Request

    {
      "filters": {
        "CurrencyIso": "string",
        "StoredPaymentMethodID": int
      },
      "sortAndPage": {
        "PageNumber": int,
        "PageSize": int
      }
    }

    Response

    {
      "d": [
        {
          "Amount": decimal,
          "CurrencyIso": "string",
          "ID": int,
          "InsertDate": dateTime,
          "IsPending": boolean,
          "SourceID": int,
          "SourceType": "string",
          "Text": "string",
          "Total": decimal
        },
        ...
      ]
    }
  • GetTotal

    The system allows users to store money using different currencies. This method allows to get a list of user's balances, which match specified parameters. The first item in the list is user's current balance, others are previous balance's states. Be aware: in case user didn't have anything on the specified currency balance yet, an empty array will be returned.

    Request - Filters

    Parameter Mandatory Type Description
    currencyIsoCode No string Define which currency the amount should be transferred in. Should contain currency ISO

    Response - Parameters

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

    Parameter Type Description
    CurrencyIso string Balance's currency ISO
    Current decimal Current amount for this balance
    Expected decimal Expected amount for this balance (current amount and pending amount together)
    Pending decimal Pending amount for this balance (not confirmed transfers, etc.)

    Examples

    Request

    {
      "currencyIsoCode": "string"
    }

    Response

    {
      "d": [
        {
          "CurrencyIso": "string",
          "Current": decimal,
          "Expected": decimal,
          "Pending": decimal
        },
        ...
      ]
    }
  • ReplyRequest

    The systems allows to transfer money between users. In case one user needs help, he may send a transfer request to another user. This method allows to approve or decline such requests.

    Request - Filters

    Parameter Mandatory Type Description
    requestId No int ID of the request which has to be replied
    approve No boolean Define whether request has to be approved (true) or declined (false)
    pinCode No string Current user's PIN code
    text No string Comment for the reply

    Response - Parameters

    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

    {
      "requestId": int,
      "approve": boolean,
      "pinCode": "string",
      "text": "string"
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • RequestAmount

    The systems allows to transfer money between users. This method allows one user to ask another user to send him money.

    Request - Filters

    Parameter Mandatory Type Description
    destAcocuntId No string ID of the customer which current user wants to ask for help
    amount No decimal Define the amount current user wants to ask for
    currencyIso No string Define which currency the amount should be transferred in. Should contain currency ISO
    text No string Comment for the request

    Response - Parameters

    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

    {
      "destAcocuntId": "string",
      "amount": decimal,
      "currencyIso": "string",
      "text": "string"
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • TransferAmount

    The systems allows to transfer money between users. This method allows to send money to another user without receiving transfer request.

    Request - Filters

    Parameter Mandatory Type Description
    destAcocuntId No string ID of the customer which the amount has to be transferred to
    amount No decimal Define the amount which has to be transferred
    currencyIso No string Define which currency the amount should be transferred in. Should contain currency ISO
    pinCode No string Current user's PIN code
    text No string Comment for the transfer

    Response - Parameters

    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

    {
      "destAcocuntId": "string",
      "amount": decimal,
      "currencyIso": "string",
      "pinCode": "string",
      "text": "string"
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }