Yedpay API Documentation

Description (Create Fixed Code)

Create a Fixed Code by Fixed Code API. Only allowed by Owner. (Support: 1 - Alipay, 8 - WeChat Pay) (POST)

End Point

https://api-h2h-staging.yedpay.com/v1/fixedcode/stores/{{store_id}}/barcodes

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
2	Content-Type	application/x-www-form-urlencoded	x-www-form-urlencoded

Body

Body
#	Name	Type	Description
1	name	String	Name of the Fixed Code
2	subtitle_name	String	(optional) Subtitle of the Fixed Code
3	amount	Float	(optional) Amount of the Fixed Code (mandatory if is_fixed_amount = 1)
4	gateway	Integer	(optional) Id of the Gateway used to Generate the transaction (Support: 1 - Alipay, 8 - WeChat Pay)
5	wallet	String	(optional) Alipay Wallet to create the transaction (CN, HK) * Mandatory and Only for Alipay
6	is_fixed_amount	Boolean	The Code is Fixed Amount or Not
7	can_handle_notify	Boolean	(optional) Can handle notify

Response

Response
#	Name	Type	Description
1	success	Boolean	Create resource Success or Fail
2	data	Array	Include all fixed code's information (id, company_id, store_id, name, etc.)

Success Response - data

Success Response - data
#	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": {
                    "id": "BbBbBbBbBbBbBbBb",
                    "code": "DdDdDdDdDdDdDdDd",
                    "company_id": "XxXxXxXxXxXxXxXxXx",
                    "store_id": "YyYyYyYyYyYyYyYyYy",
                    "name": "fixedCode2",
                    "subtitle_name": "",
                    "amount": "0.10",
                    "gateway": 1,
                    "wallet": "CN",
                    "available_gateway": "1,8",
                    "is_fixed_amount": false,
                    "status": "Active",
                    "_links": {
                        "checkout": {
                            "zh": "https://qr-h2h-staging.yedpay.com/payment/zh/DdDdDdDdDdDdDdDd",
                            "en": "https://qr-h2h-staging.yedpay.com/payment/en/DdDdDdDdDdDdDdDd"
                        },
                        "qrcode": {
                            "zh": "https://api-h2h-staging.yedpay.com/v1/qr/yedpay/zh/DdDdDdDdDdDdDdDd",
                            "en": "https://api-h2h-staging.yedpay.com/v1/qr/yedpay/en/DdDdDdDdDdDdDdDd"
                        }
                    }
                }
            }

Example Error Response

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