Get Balance

This API is used to retrieve the current available balance in Platform Platform.

GET https://<Platform-host>/api/payouts/:partnerId/balance

Path Parameters

Name	Type	Description
partner_id*	string	Partner ID

Query Parameters

Name	Type	Description
merchant_id	string	Merchant ID
currency_code	string	Currency code using ISO 4217 format. e.g. USD

Response Body

200

Field Definitions

Field Name	Type	Description
data	array	List of merchants and their available balances
data[i].merchant_id	string	Merchant ID
data[i].merchantname	string	Merchant Name
data[i].currency_code	string	Currency code using ISO 4217 format. e.g. USD
data[i].balance	string	Current Available Balance

Sample Request

curl --location --request GET '<API_HOST>/api/payouts/2be66e67-88a7-4e04-985d-0a1cfb0a648c/USD/balance' \

--header 'Authorization: Basic <API_KEY>'

Sample Response

 {
     "data": 
    [
        {
          "merchant_id":"1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
          "merchant_name":"Test Merchant 1"
          "currency_code":"USD",
          "balance":"7500.50"
        },
        {
         "merchant_id":"1ab6b433-d60f-1227-a0fa-181c3c6de5cb",
          "merchant_name":"Test Merchant 2"
          "currency_code":"USD",
          "balance":"2700.50"
        }
     ]
 }