GetBalance

This method is used for getting balance of partner

Good to know: Press ">" to see detail.

Request

POST https://{SERVER}/Api/SBR/GetBalance

Request Body

Name	Type	Description
AuthID*	Text	UserID assigned by SBR
ProtocolData*	Object	Data request
Reference*	Text	ID of payment order
StatusType*	Text(1)	Status of request (Default =1)

200: OK Success

{
    // Response
}

401: Unauthorized Invalid username or password. Please try again!

{
    // Response
}

406: Not Acceptable Require signature - Signature incorrect

{
    // Response
}

Good to know: Available = BalAmt - AllowtAmt - FeeAmt - OnlineAmt

Response

Parameters	Data type	Description
Status	Number	Return status of request: 0;Fail;1;Success
ProtocolData	Object	List of orders
CurrencyID	Text(20)	Currency (USD;EUR;JPY;CAD;VND…)
BalAmt	Number	Current balance
AllowAmt	Number	Using balance
FeeAmt	Number	Estimated fee
OnlineAmt	Number	Balance for online transaction
Available	Text(20)	Available balance

Request Example

Get specific balance of 1 CurrencyID

{
  "AuthID": "123",
  "ProtocolData": {
    "CurrencyID": "USD"
  }
}

Get all balances for all CurrencyID

// To get all balances for all CurrencyID, please set "" for CurrencyID
{
  "AuthID": "123",
  "ProtocolData": {
    "CurrencyID": ""
  }
}

Response Example

Success when get balance for Specific CurrencyID

{
  "Status": 1,
  "ProtocolData": [
    {
      "CurrencyID": "USD",
      "BalAmt": 367044.5,
      "AllowAmt": 181184.0,
      "FeeAmt": 0.0,
      "OnlineAmt": 0.0,
      "Available": 185860.5
    }
  ]
}

Success when get balance for All CurrencyID

{
  "Status": 1,
  "ProtocolData": [
    {
      "CurrencyID": "USD",
      "BalAmt": 367044.5,
      "AllowAmt": 181184.0,
      "FeeAmt": 0.0,
      "OnlineAmt": 0.0,
      "Available": 185860.5
    },
    {
      "CurrencyID": "VND",
      "BalAmt": 18483288.0,
      "AllowAmt": 0.0,
      "FeeAmt": 0.0,
      "OnlineAmt": 0.0,
      "Available": 18483288.0
    }
  ]
}

Fail

{
  "Status": 1,
  "ProtocolData": []
}