Description (Retrieve Pre-Authorization with Transaction)
Returns a list of pre-authorizations with optional filtering. (GET)
End Point
https://api.yedpay.com/v1/companies/{{company_id}}/authorizations/{{authorization_id}}?include=transactions
Variable
| # | Name | Type | Description |
|---|---|---|---|
| 1 | company_id | String | Company's ID |
| 2 | authorization_id | String | Encoded Authorization ID |
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
| # | 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",
"transactions": [
{
"id": "4LZ14J76",
"user_id": "XL8GJ2L8",
"company_id": "1LPYQDLY",
"store_id": "ER1MYWLZ",
"gateway_id": 12,
"gateway_sub_id": 1,
"gateway_sub_name": "VISA Online",
"gateway_code": "12_1",
"barcode_id": "",
"payment_link_id": "",
"status": "captured",
"amount": "121.00",
"currency": "HKD",
"charge": "5.74",
"refunded": "0.00",
"refund_charge": "0.00",
"net": "115.26",
"tips": "0.00",
"forex": 1,
"paid_at": "2025-10-09 12:44:25",
"can_settle_after": "2025-10-11 23:45:00",
"is_balance_settled": false,
"settled_at": "",
"transaction_id": "175998497763820",
"reference_id": "CST4ZC62DHQ6RG75",
"payer": "",
"buyer_id": "",
"wallet_type": "OVERSEAS",
"extra_parameters": "",
"custom_id": "test1759984767-1",
"fixed_id": "",
"refunded_at": "",
"created_at": "2025-10-09 12:42:57",
"updated_at": "2025-10-09 12:44:25",
"promotion_id": "",
"payment_account_reference": "KgQCGSb1F9wKcn5fcsrZSJIvZaH4T",
"expired_at": "2025-11-06 12:40:02",
"remarks": "Paid by Online Payment - ID JRJW237L",
"pax_allow_refund": true,
"auth_service_type": "pre_auth",
"issuer_country": "NL",
"topup_remarks": "",
"authorization_yedpay_id": "175998480249501"
}
]
}
}
Other Retrieve request example
Returns a list of pre-authorizations with optional filtering. (GET)
End Point
GET {base_url}/companies/{{company_id}}/authorizations?authorization_id=xxxxxxxxxxxxxxxxxxx&include=transactions
GET {base_url}/companies/{{company_id}}/authorizations?include=transactions
GET {base_url}/companies/{{company_id}}/transactions?transaction_id=174539719051181&include=authorization
v1.92.8-20260429 © The Payment Cards Group Limited. All rights reserved.