Yedpay

Description (Show Company's QR Code List)

Show the Company's QR Code List (Fixed Code and EMV Code) (GET)

Queries

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

  • * store_id - Store ID (search only)
  • * name - QR Code Name
  • * amount - QR Code Amount
  • * status - QR Code Status

Example:

https://api.yedpay.com/v1/companies/{{company_id}}/qr-codes?store_id=xxxx&sort=-amount

End Point

https://api.yedpay.com/v1/companies/{{company_id}}/qr-codes

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

Response

Response
# Name Type Description
1 success Boolean Show Company's QR Code List Success or Fail
2 data Array Include all Company's QR Code List Information (company_id etc...)
3 meta Array Include all Pagination's Information (total, count, total_pages, etc..)

Success Response - data

Success Response - data
# Name Type Description
1 type String Type of the QR Code
2 id String ID of the EMV Code / Fixed Code
3 attribute Array Include all Code releated Information

Emv Code

Emv Code
# Name Type Description
1 id String Unique identifier of the EMV Code
2 company_id String Unique identifier of the company
3 store_id String Unique identifier of the store
4 store_name String Name of the store
5 name String Name of the EMV Code
6 amount Float Amount of the EMV Code
(Fixed amount EMV Code if the amount is not 0)
7 support_gateway String the EMV Code's support gateways
(1: Alipay, 8: Wechat Pay, 10: UnionPay QR)
8 value String Value of the EMV Code
9 status Integer status of the EMV Code
(0: Disabled 1: Enabled)
10 _links Array Include Links for:
- checkout
- qrcode
11 created_at String Datetime when the EMV Code was created
12 updated_at String Datetime when the EMV Code was updated lastly

Fixed Code

Fixed Code
# 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": [
            {
                "type": "emv_code",
                "id": "3PG7YQKYPENKDXJRVE",
                "attributes": {
                    "company_id": "G2R98WZXVYMK5EV3PN",
                    "store_id": "9302L8KR97LZEPRYJ7",
                    "store_name": "test store name",
                    "name": "test emv code name",
                    "amount": "0.00",
                    "support_gateway": "1,8,10",
                    "value": "xxx",
                    "status": 1,
                    "created_at": 2022-08-11 07:18:29,
                    "updated_at": 2022-08-11 07:18:29,
                    "_links": {
                        "checkout": "xxx",
                        "qrcode": "xxx"
                    }
                }
            },
            {
                "type": "fixed_code",
                "id": "2NMJVPOMJGPO70RL8W",
                "attributes": {
                    "code": "xxxxxx",
                    "company_id": "42NMJVPOMPMO70RL8W",
                    "store_id": "M49E60Z7X7GZ17G5DN",
                    "name": "test fixed Code",
                    "subtitle_name": "test subtitle",
                    "amount": "0.00",
                    "gateway": 1,
                    "wallet": "CN",
                    "available_gateway": "1,8",
                    "is_fixed_amount": false,
                    "status": "Active",
                    "_links": {
                        "checkout": {
                            "zh": "xxx",
                            "en": "xxx"
                        },
                        "qrcode": {
                            "zh": "xxx",
                            "en": "xxx"
                        }
                    }
                }
            }
        ],
        "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.59.0-20220801 © The Payment Cards Group Limited. All rights reserved.