Get Balance History

This API is used to view available balance history in PayEngine Platform.

Balance History

GET https://<PayEngine-host>/api/payouts/:merchant_id/:currency_code/balancehistory

Path Parameters

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

Query Parameters

Name	Type	Description
event_from_date	date	Event - From Date (YYYY-MM-DD)
event_to_date	date	Event - To Date (YYYY-MM-DD)
event	string	Possible values: Settlement/Fee/Disbursement/Adjustment

Response Body

200

Field Definitions

Field Name	Type	Description
data	array	List of events resulting in changes to the available balance. By default (if event date range not specified), available balance history would be displayed for last one month. Data to be returned in the descending order of event date-time.
data[i].merchant_id	string	Merchant ID
data[i].event_date	date	Event Date (YYYY-MM-DD)
data[i].event	string	Event (Settlement/Fee/Payout/ Adjustment)
data[i].currency_code	string	Currency code using ISO 4217 format. e.g. USD
data[i].opening_balance	string	Opening Available Balance (+ or -)
data[i].balance_change	string	Change to Available balance (+ or -)
data[i]closing.balance	string	Closing Available Balance (+ or -)
data[i].notes	string	This would be present in case of Event = Adjustment explaining the reason for adjustment
data[i].adjustment_user	string	name of the user responsible for making the adjustment
data[i].adjustment_user	string	name of the user responsible for making the adjustment
data[i].adjustment_user	string	name of the user responsible for making the adjustment
data[i].adjustment_user	string	name of the user responsible for making the adjustment
data[I].adjustment_user	string	name of the user responsible for making the adjustment

Sample Request

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

--header 'Authorization: Basic <API_KEY>'

Sample Response

{
     "data": 
    [
        {
          merchant_id:"2be66e67-88a7-4e04-985d-0a1cfb0a648c",
          event_date:"2024-12-02"
          event:"Adjustment"
          currency_code:"USD",
          opening_balance:"+1000",
          balance_change:"-300"
          closing_balance:"+700"
          notes:"Card Network Assessment Fee"
          adjustment_user:"Mark Brown"
        },
        {
          merchant_id:"2be66e67-88a7-4e04-985d-0a1cfb0a648c",
          event_date:"2024-12-01"
          currency_code:"USD",
          opening_balance:"+500",
          balance_change:"+500"
          closing_balance:"+1000"
          event:"Settlement"
          notes:""
          adjustment_user:""
        }
     ]
 }