Yedpay API Documentation

Description (Balance Company Information)

Show the Balance of the company. (GET)

End Point

https://api-h2h-staging.yedpay.com/v1/balance/{{company_id}}?currency=HKD

Variable

Variable
#	Name	Type	Description
1	company_id	String	Company's ID

Request Header

Request Header
#	Key	Value	Description
1	Authorization	Bearer {{access_token}}	Login Token

Body

Body
#	Name	Type	Description

Response

Response
#	Name	Type	Description
1	success	Boolean	Show Company's Balance Success or Fail
2	data	Array	Include Balance Information (company_id, currency, total_balance, etc..)

Success Response - data

Table Information
#	Name	Type	Description
1	company_id	String	Id of the Company
2	currency	String	Currency of the Balance
3	total_balance	String	Total Balance of the Company
4	total_available_balance	String	Total Available Balance of the Company (2 Decimal Places)
5	available_balance	String	Withdrawable Balance
6	ledger_balance	String	Pending transaction amount that is not added to available_balance. i.e. authorized
7	locked_balance	String	The system is processing some transactions that hold the amount
8	holding_balance	String	The amount is hold to transaction settlement date
9	total_balance_float	Float	Total Balance of the Company
10	total_available_balance_float	Float	Total Available Balance of the Company (2 Decimal Places)
11	available_balance_float	Float	Withdrawable Balance
12	ledger_balance_float	Float	Pending transaction amount that is not added to available_balance. i.e. authorized
13	locked_balance_float	Float	The system is processing some transactions that hold the amount
14	holding_balance_float	Float	The amount is hold to transaction settlement date

Example Success Response

            {
                "success": true,
                "data": {
                    "company_id": "JwoMPpKy",
                    "currency": "HKD",
                    "total_balance": "17.4781",
                    "total_available_balance": "17.47",
                    "available_balance": "17.47",
                    "ledger_balance": "0.00",
                    "locked_balance": "0.00",
                    "holding_balance": "0.00",
                    "total_balance_float": 17.4781,
                    "total_available_balance_float": 17.47,
                    "available_balance_float": 17.47,
                    "ledger_balance_float": 0,
                    "locked_balance_float": 0,
                    "holding_balance_float": 0
                }
            }

Example Error Response

            {
                "success": false,
                "message": "Unauthenticated.",
                "status": 500
            }