Yedpay API Documentation

Description (Update Account)

Update information of the selected bank account. (PUT)

End Point

https://api.yedpay.com/v1/accounts/{{bank_account_id}}

Variable

Variable
#	Name	Type	Description
1	bank_account_id	String	Bank Account's ID

Request Header

Request Header
#	Key	Value	Description
1	Authorization	Bearer {{access_token}}	Login Token
2	Content-Type	application/x-www-form-urlencoded	x-www-form-urlencoded

Body

Body
#	Name	Type	Description
1	code	String	Bank account's code
2	branch	String	Bank account's branch
3	number	String	Bank account's number
4	currency	String	Bank account's currency
5	name	String	Bank account's name
6	holder	String	Bank account's Holder Name in Upper Case
7	is_default	Boolean	(true\|1 or false\|0) status default of the bank account

Response

Response
#	Name	Type	Description
1	success	Boolean	Update selected bank account's Information Success or Fail
2	data	Array	Include selected bank account's Information (id, company_iD, holder 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	DateTime of this Account was created "YYYY-mm-dd h:i:s"
11	updated_at	String	Last modification DateTime of this Account "YYYY-mm-dd h:i:s"

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": "2018-03-06 13:38:48", 
                        "updated_at": "2018-03-08 14:09:58"
                    }
                ]
            }

Example Error Response

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