Yedpay

Description (Balance Company Information)

Show the Balance of the company. (GET)

End Point

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

Variable

# Name Type Description
1 company_id String Company's ID

Request Header

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

Body

# Name Type Description

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

# 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 total_balance_float Float Total Balance of the Company
6 total_available_balance_float Float Total Available Balance of the Company (2 Decimal Places)

Example Success Response

            {
                "success": true,
                "data": {
                    "company_id": "JwoMPpKy",
                    "currency": "HKD",
                    "total_balance": "17.4781",
                    "total_available_balance": "17.47",
                    "total_balance_float": 17.4781,
                    "total_available_balance_float": 17.47,
                }
            }
        

Example Error Response

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

v1.30.0-20191113 © The Payment Cards Group Limited. All rights reserved.