Yedpay API Documentation

Description (Show EMV Code)

Show the EMV Code of the company (GET)

End Point

https://api-h2h-staging.yedpay.com/v1/emv-codes/{{emv_code_id}}

Variable

Variable
#	Name	Type	Description
1	emv_code_id	String	EMV Code'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 EMV Code Success or Fail
2	data	Array	Include all EMV Code Information (company_id 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	company_name	String	Name of the company
4	store_id	String	Unique identifier of the store
5	store_name	String	Name of the store
6	user_id	String	Unique identifier of the user
7	name	String	Name of the EMV Code
8	amount	Float	Amount of the EMV Code (Fixed amount EMV Code if the amount is not 0)
9	currency	String	Currency used for the EMV Code (HKD)
10	value	String	Value of the EMV Code
11	status	Integer	status of the EMV Code (0: Disabled 1: Enabled)
12	_links	Array	Include Links for: - checkout - qrcode
13	created_at	String	Datetime when the EMV Code was created
14	updated_at	String	Datetime when the EMV Code was updated lastly

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "0L7X53LG",
                    "company_id": "ER11EGRZ",
                    "store_id": "8LW4M16E",
                    "store_name": "test store name",
                    "name": "test emv code name",
                    "amount": "0.00",
                    "support_gateway": "1,8,10",
                    "value": "xxx",
                    "status": 1,
                    "created_at": 2026-01-26 11:21:55,
                    "updated_at": 2026-01-26 11:21:55,
                    "_links": {
                        "checkout": "xxx",
                        "qrcode": "xxx"
                    }
                }
            }

Example Error Response

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