Yedpay

Description (Show EMV Code List)

Show all of the EMV Code List (GET)

Can include the follow parameters separated by comma "," adding the parameter "include" in the url to get more information:

  • * company - provides the company info
  • * store - provides the store info

Example:

https://api.yedpay.com/v1/emv-codes?include=company

End Point

https://api.yedpay.com/v1/emv-codes

Request Header

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

Response

Response
# Name Type Description
1 success Boolean Show EMV Code List Success or Fail
2 data Array Include all EMV 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 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

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "M49E60Z7X8RZ17G5DN",
                        "company_id": "MJ86QYO373NZEP3RG5",
                        "store_id": "PWN67LK109JZQX540E",
                        "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 08:05:16,
                        "updated_at": 2022-08-11 08:05:16,
                        "_links": {
                            "checkout": "xxx",
                            "qrcode": "xxx"
                        }
                    },
                    {
                        "id": "MJ86QYO3105ZEP3RG5",
                        "company_id": "R87P15K5W8EO4E6LW9",
                        "store_id": "03QYVJKQ481ON8LM51",
                        "store_name": "test store name",
                        "name": "test emv code name",
                        "amount": "10.00",
                        "support_gateway": "1,8,10",
                        "value": "xxx",
                        "status": 1,
                        "created_at": 2022-08-11 08:05:16,
                        "updated_at": 2022-08-11 08:05:16,
                        "_links": {
                            "checkout": "xxx",
                            "qrcode": "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.