Yedpay API Documentation

Description (Balance Company Transaction)

Show balance information with history movements of the transactions. (GET)

Queries

In order to search Transactions you can add in the url the follow parameters.

* company_id - id of the company,
* currency - currency of the transaction
* sale - total charge of the sale
* charge - charge fee of the transaction
* balance - Balance of the transaction
* total_balance - Total Balance after the transaction
* id_transaction - id of the transaction
* transaction_type - type of the transaction

Operators

* "=" - the result is equal to
* ">" - the result is bigger than
* "<" - the result is less than

Example:

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

Export to file

Can use the same query to export the result into a file adding the parameter export

* export - type of file to export the query (csv, xlsx)

Example:

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

End Point

https://api.yedpay.com/v1/balance/{{company_id}}/transactions?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 Transaction Balance's Information Success or Fail
2	data	Array	Include All Transaction Balance's Information (company_id, currency, total_balance, etc..)

Success Response - data

Success Response - data
#	Name	Type	Description
1	id	String	Id of the Balance
2	company_id	String	Id of the Company
3	currency	String	Currency of the Transaction
4	sale	String	Sale of the Transaction
5	charge	String	Charge of the Transaction
6	balance	String	Balance of the Transaction
7	total_balance	String	Total Balance of the Company
8	total_available_balance	String	Total Available Balance of the Company (2 Decimal Places)
9	id_transaction	String	Id of the Transaction
10	transaction_type	String	Type of the Transaction
11	created_at	String	Created Date of the Balance
12	updated_at	String	Updated Date of the Balance

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "JwoMPpKy",
                        "company_id": "JwoMPpKy",
                        "currency": "HKD",
                        "sale": "5.00",
                        "charge": "0.13",
                        "balance": "4.87",
                        "total_balance": "17.4781",
                        "total_available_balance": "17.47",
                        "sale_float": 5,
                        "charge_float": 0.13,
                        "balance_float": 4.87,
                        "total_balance_float": 17.4781,
                        "total_available_balance_float": 17.47,
                        "id_transaction": "b6oY95oz",
                        "transaction_type": "sale",
                        "created_at": "2017-10-10 17:06:25",
                        "updated_at": "2017-10-10 17:06:25"
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 1,
                        "count": 1,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }

Example Error Response

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