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
# | Name | Type | Description |
---|---|---|---|
1 | store_id | String | Store's ID |
Request Header
# | Key | Value | Description |
---|---|---|---|
1 | Authorization | Bearer {{access_token}} | Login Token |
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
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Create EMV Code Success or Fail |
2 | message | String | Detail message of the response |
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": "8YN319ZP0PDKX2DJ7P", "company_id": "3590G4Z0P3MO76QXV8", "store_id": "7V8GMYOW43JZEJ5NL2", "store_name": "test store name", "name": "test emv code name", "amount": "0.00", "support_gateway": "1,8,10", "value": "xxx", "status": 1, "created_at": 2023-06-03 06:29:09, "updated_at": 2023-06-03 06:29:09, "_links": { "checkout": "xxx", "qrcode": "xxx" } } }
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
v1.61.15-20230523 © The Payment Cards Group Limited. All rights reserved.