Get Hold Status

Method: GET
Endpoint: BASE_URL/merchant/payment/hold/status/
queryParams: externalId or transactionId

Example GET request with external id

Method: GET
URL: BASE_URL/merchant/payment/hold/status/?externalId=123
Header:

Authorization: Bearer <ACCESS_TOKEN>

Response

{
  "result": {
    "transactionId": "d1be13da-4355-4b27-956d-d83b87e013f1",
    "status": "cancelled",
    "cancelTime": "2025-02-03 11:13:42",
    "payedAt": null,
    "amount": 10,
    "serviceId": "d1be13da-4355-4b27-956d-d83b87e013f1"
  }
}

Result statuses

paid - success transaction
cancelled - cancelled transaction
hold - hold transaction, can be charged if hold time have not been expired
created

Error response structure

{
  "error": {
    "code": "hold_not_found",
    "message": "hold_not_found"
  }
}

Error codes

hold_not_found
hold_time_expired
invalid_amount
field_not_valid
gateway_not_working
field_required
transaction_not_found