Yedpay API Documentation

Description (Company Bank Account List)

Show the list of all Bank Account related with the company. (GET)

Can include bank_info of the bank account

Queries

In order to search Bank Account you can add in the url the follow parameters

* id - id of the Bank Account
* is_default - 0|1 Default Bank Account
* include - to include other model(BankInfo)

Example:

https://api.yedpay.com/v1/companies/{{company_id}}/accounts?id=xxxxxxxxx&is_default=1&include=bank_info

End Point

https://api.yedpay.com/v1/companies/{{company_id}}/accounts

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	Request Barcode List Success or Fail
2	data	Array	Include all Barcode Information (barcode_id, value, name, etc..)
3	meta	Array	Include all Pagination's Information (total, count, total_pages, etc..)

Success Response - data

Success Response - data
#	Name	Type	Description
1	id	String	Id of the Bank Account
2	company_id	String	Id of the Company
3	name	String	Name of Bank
4	holder	String	Holder of the Bank Account
5	currency	String	Currency of the Bank Account
6	code	String	Code of the Bank Account
7	branch	String	Branch of the Bank Account
8	number	String	Number of the Bank Account
9	is_default	Boolean	Whether this Account is Default Bank Account
10	created_at	String	Created Date
11	updated_at	String	Updated Date

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "6RrNyowb",
                        "company_id": "1Oo8arkR",
                        "name": "xxxx",
                        "holder": "xxx",
                        "currency": "HKD",
                        "code": "xxx",
                        "branch": "xxx",
                        "number": "xxxxxxxxxx",
                        "is_default": true,
                        "created_at": "2017-09-01 17:10:51",
                        "updated_at": "2017-09-01 17:10:51"
                    }
                ],
                "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
            }