Yedpay

Description (Create EMV Code)

Create the EMV Code of the store (POST)

End Point

https://api.yedpay.com/v1/stores/{{store_id}}/emv-codes

Variable

Variable
# Name Type Description
1 store_id String Store's ID

Request Header

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

Body

Body
# Name Type Description
1 gateways Array (optional) Id of gateway(s) (1: Alipay, 8: Wechat Pay, 10: UnionPay QR)
2 amount Float (optional) Amount of the EMV Code (Fixed amount EMV Code if the amount is not 0, support)
(The following are examples of valid Amounts: "98.73", "98" and "98.". The following are NOT valid Amounts: "98,73" and "3 705".)
(Max Amount: 10000)
3 currency String (optional) Currency of the EMV Code (Default: HKD)
4 name String (255) (option) name of the EMV Code

Response

Response
# Name Type Description
1 success Boolean Create EMV Code Success or Fail
2 message String Detail message of the response

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": "M49E60Z703LO17G5DN",
                    "company_id": "MJ86QYO3YV2KEP3RG5",
                    "store_id": "3590G4Z0YE1O76QXV8",
                    "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-11-28 13:20:12,
                    "updated_at": 2022-11-28 13:20:12,
                    "_links": {
                        "checkout": "xxx",
                        "qrcode": "xxx"
                    }
                }
            }

Example Error Response

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

v1.61.4-20221124 © The Payment Cards Group Limited. All rights reserved.