Description (Settlement List)

Show the list of the settlements requests and status. (GET)

End Point

Request Header

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


# Name Type Description


# Name Type Description
1 success Boolean Request settlement list Success or Fail
2 data Array Include settlement's information (id, currency, amount, etc..)
3 meta Array Include meta's information (total, count, per_page, etc..)

Success Response - data

Success Response - data
# Name Type Description
1 id String Id of the Settlement
2 status String Status of the Settlement
3 company_id String Id of the Company
4 transaction_id String Unique transaction identifier of Yedpay
5 currency String Currency of the Settlement
6 amount String Amount of the Settlement
7 charge String Charge of Settlement
8 settle String Settle of the Settlement
9 settle_fee String Settle Fee of the Settlement
10 total String Total Amount of the Settlement
11 created_at String Created Date of the Settlement
12 updated_at String Updated Date of the Settlement
13 account_name String Name of the Account
14 account_holder_name String Holder Name of the Account
15 account_code String Code of the Account
16 account_branch String Branch of the Account
17 account_number String Number of the Account
18 account_currency String Currency of the Account
19 reason String Reason of Reject Settlement

Example Success Response

                "success": true,
                "data": [
                        "id": "JwoMPpKy",
                        "status": "canceled",
                        "company_id": "qQvy0rl3",
                        "transaction_id": "153138831812345",
                        "currency": "HKD",
                        "amount": "20.00",
                        "charge": "0.00",
                        "settle": "20.00",
                        "settle_fee": "30.00",
                        "total": "50.00",
                        "created_at": "2017-10-24 15:56:47",
                        "updated_at": "2017-10-24 17:10:56",
                        "account_name": "xxxx",
                        "account_holder_name": "xxxx",
                        "account_code": "xxx",
                        "account_branch": "xxx",
                        "account_number": "xxxxxxx",
                        "account_currency": "HKD",
                        "reason": ""
                "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

v1.66.0-20240415 © The Payment Cards Group Limited. All rights reserved.