Yedpay API Documentation

Description (Capture Pre-Authorization)

Captures a pre-authorization, converting it to a completed payment. (PUT)

End Point

https://api.yedpay.com/v1/authorization/{{authorization_id}}/capture

Variable

Variable
#	Name	Type	Description
1	authorization_id	String	Encode authorization_id, ID from Company Authorization List

Body

Body
#	Name	Type	Description
1	amount	Numberic String	Transaction Amount (Maximum 2 decimal places)
2	currency	String(3)	Transaction Currency (Default HKD)

Request Header

Request Header
#	Key	Value	Description
1	Authorization	API-KEY {{api_key}}	API Key

Response

Table Information
#	Name	Type	Description
1	success	Boolean	The request is received without error.
2	data	Object	Include pre-authorization information

Success Response - data

Example Response

            {
                "success": true,
                "data": {
                    "id": "46G9X0RP",
                    "company_id": "1LPYQDLY",
                    "company_name": "xxxx Test",
                    "store_id": "ER1MYWLZ",
                    "store_name": "(Online store) xxxx",
                    "user_id": "XL8GJ2L8",
                    "gateway_id": 12,
                    "gateway_sub_id": 1,
                    "gateway_sub_name": "VISA Online",
                    "gateway_code": "12_1",
                    "authorization_id": "175998480249501",
                    "reference_id": "R2DVSRJN2N4GBQ65",
                    "custom_id": "test1759984767",
                    "wallet": "OVERSEAS",
                    "currency": "HKD",
                    "amount": "123.00",
                    "charge": "1.00",
                    "captured": "121.00",
                    "remaining_amount": "2.00",
                    "extra_parameters": "",
                    "status": "captured",
                    "auth_service_type": "pre_auth",
                    "should_auto_capture": false,
                    "authorized_at": "2025-10-09 12:40:05",
                    "auto_capture_at": "",
                    "scheduled_capture_time": "",
                    "captured_at": "2025-10-09 12:44:25",
                    "expired_at": "2025-11-06 12:40:02",
                    "cancelled_at": "",
                    "created_at": "2025-10-09 12:40:02",
                    "updated_at": "2025-10-09 12:45:00"
                }
            }

Example Error Response

            {
                "success": false,
                "message": "This action is unauthorized",
                "status": 403
            }