Yedpay API Documentation

Description (Retrieve Pre-Authorization)

Retrieves the details of an existing pre-authorization (API KEY's Store). (GET)

End Point

https://api.yedpay.com/v1/companies/{{company_id}}/authorizations?sort=-created_at

Variable

Variable
#	Name	Type	Description
1	company_id	String	Company's ID

Request Header

Request Header
#	Key	Value	Description
1	Authorization	API-KEY {{api_key}}	API Key
2	Content-Type	application/x-www-form-urlencoded	x-www-form-urlencoded Format

Response

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

Success Response - data

Example Response

            {
                "success": true,
                "data": [
                    {
                        "id": "ELKPZVR8",
                        "company_id": "xxxxxxxx",
                        "company_name": "xxxx Test",
                        "store_id": "xxxx1234",
                        "store_name": "(Online store) cccc",
                        "user_id": "xxxx4321",
                        "gateway_id": 12,
                        "gateway_sub_id": 1,
                        "gateway_sub_name": "VISA Online",
                        "gateway_code": "12_1",
                        "authorization_id": "175790494721432",
                        "reference_id": "K23JZ49T5D4Z8F75",
                        "custom_id": "test1757904918",
                        "wallet": "OVERSEAS",
                        "currency": "HKD",
                        "amount": "376.00",
                        "charge": "1.00",
                        "captured": "0.00",
                        "remaining_amount": "376.00",
                        "extra_parameters": "",
                        "status": "authorized",
                        "auth_service_type": "pre_auth",
                        "should_auto_capture": false,
                        "authorized_at": "2025-09-15 10:55:48",
                        "auto_capture_at": "",
                        "scheduled_capture_time": "",
                        "captured_at": "",
                        "expired_at": "2025-10-13 10:55:47",
                        "cancelled_at": "",
                        "created_at": "2025-09-15 10:55:47",
                        "updated_at": "2025-09-15 10:55:48"
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 1,
                        "count": 1,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }