Description (Company's Fixed Code List)
Show the list of the Fixed Code related with the Company. (GET)Can include the parameter store to get the store information.
Example:
https://api.yedpay.com/v1/fixedcode/companies/{{company_id}}/barcodes?include=store
End Point
https://api.yedpay.com/v1/fixedcode/companies/{{company_id}}/barcodes
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 | Request fixed code list Success or Fail |
2 | data | Array | Include all fixed code's information (id, company_id, store_id, name, etc.) |
3 | meta | Array | Include all Pagination's Information (total, count, total_pages, etc..) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String | Id of the Fixed Code |
2 | code | String | Code of the Fixed Code |
3 | company_id | String | Company Id of the Fixed Code |
4 | store_id | String | Store Id of the Fixed Code |
5 | name | String | Name of the Fixed Code |
6 | subtitle_name | String | Subtitle of the Fixed Code |
7 | amount | Float | Amount of the Fixed Code |
8 | gateway | Integer | Id of the Gateway used to Generate the transaction |
9 | wallet | String | Wallet of the Gateway (Only for Alipay) |
10 | available_gateway | String | Id of the Gateway used to Generate the transaction |
11 | is_fixed_amount | Boolean | The Code is Fixed Amount or Not |
12 | status | String | Status of the Fixed Code |
13 | _links | Array | Include Chinese and English Links for: - checkout - qrcode |
Example Success Response
{ "success": true, "data": [ { "id": "AaAaAaAaAaAaAaAa", "code": "CcCcCcCcCcCcCcCc", "company_id": "XxXxXxXxXxXxXxXxXx", "store_id": "YyYyYyYyYyYyYyYyYy", "name": "fixedCode1", "subtitle_name": "", "amount": "0.10", "gateway": 8, "wallet": "", "available_gateway": "1,8", "is_fixed_amount": false, "status": "Active", "_links": { "checkout": { "zh": "https://qr.yedpay.com/payment/zh/CcCcCcCcCcCcCcCc", "en": "https://qr.yedpay.com/payment/en/CcCcCcCcCcCcCcCc" }, "qrcode": { "zh": "https://api.yedpay.com/v1/qr/yedpay/zh/DdDdDdDdDdDdDdDd", "en": "https://api.yedpay.com/v1/qr/yedpay/en/DdDdDdDdDdDdDdDd" } } }, { "id": "BbBbBbBbBbBbBbBb", "code": "DdDdDdDdDdDdDdDd", "company_id": "XxXxXxXxXxXxXxXxXx", "store_id": "YyYyYyYyYyYyYyYyYy", "name": "fixedCode2", "subtitle_name": "", "amount": "0.10", "gateway": 1, "wallet": "CN", "available_gateway": "1,8", "is_fixed_amount": false, "status": "Active", "_links": { "checkout": { "zh": "https://qr.yedpay.com/payment/zh/DdDdDdDdDdDdDdDd", "en": "https://qr.yedpay.com/payment/en/DdDdDdDdDdDdDdDd" }, "qrcode": { "zh": "https://api.yedpay.com/v1/qr/yedpay/zh/DdDdDdDdDdDdDdDd", "en": "https://api.yedpay.com/v1/qr/yedpay/en/DdDdDdDdDdDdDdDd" } } } ], "meta": { "pagination": { "total": 2, "count": 2, "per_page": 40, "current_page": 1, "total_pages": 1, "links": [] } } }
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
v1.62.0-20231122 © The Payment Cards Group Limited. All rights reserved.