Refunds Bank Transfer API

These HTTP endpoints used by an external bank-transfer system to read and update outgoing refund / withdrawal requests.
These endpoints are intended for trusted internal integrations only! you need to enable 'Unprotected Accounting API' inside
[Domain Enabled Modules]
field.

Call Query_Refunds_API_Queue_json to get Refund (doc) payment rows that should be handled by the external bank-transfer system.
By default, this endpoint returns rows from refund documents whose authorization status is:
2 = Ready to execute

Request

The request may include an optional Status parameter.
Parameter Required Description
Status No Optional queue filter.
Use execution failed to query failed refunds.
Use sent awaiting result to query refunds already sent to the bank and waiting for final result.
Any other value, or an empty value, returns refunds ready to execute.

Successful Response

The response contains a Queue array with refund item rows. 
{
  "ResponseCode":0,
  "ResponseMsgEng":"Success",
  "Queue":[
    {
      "RefundNumber":67393,
      "RowIndex":1,
      "RefundMethod":2,
      "PaymentDate":"2026-04-01",
      "TotalAmount":150.00,
      "Currency":"ILS",
      "BankCode":"",
      "BranchSwift":"TCCLGB3L",
      "Account":"GB31TCCL04140459442098",
      "BankTransferPaymentFormat":1,
      "RegRefundToCountry":"הממלכה המאוחדת (בריטניה)",
      "RegBankName":"",
      "RegBankAddress":"",
      "RegAccountOwnerAsContactPerson":"אריאל שמואל הקר",
      "FromInternalAccount":95,
      "FromInternalAccountName":"קראנסיי קלאוד"
    }
  ]
}

No Results

{
  "ResponseCode":2,
  "ResponseMsgEng":"No Results \/ Data"
}

Feedback Hyper

Call Update_Refunds_API_Queue_json to Update the bank-transfer authorization status of refund documents after the external system processes them.
The endpoint accepts an array named docs. Only refund documents currently in status 2, 3, or 5 can be updated.

Request Fields

JSON Field Required Description
docs Yes Array of refund documents to update.
RefundNumber Yes Refund document number in Hyper.
AuthorizationStatus Yes New status to write back.
2 = Ready to execute
3 = Sent - awaiting result
4 = Executed successfully
5 = Execution failed
AuthorizationTextDesc No Free text returned by the bank-transfer system, such as external request ID, bank reference, or error message.

Example Request

{
  "docs": [
    {
      "RefundNumber": 23451,
      "AuthorizationStatus": 3,
      "AuthorizationTextDesc": "Sent to bank API. External request id: BNK-778899"
    },
    {
      "RefundNumber": 23452,
      "AuthorizationStatus": 4,
      "AuthorizationTextDesc": "Executed successfully. Bank reference: TRX-445566"
    },
    {
      "RefundNumber": 23453,
      "AuthorizationStatus": 5,
      "AuthorizationTextDesc": "Execution failed: beneficiary account rejected"
    }
  ]
}

Successful Response

{
  "ResponseCode":0,
  "ResponseMsgEng":"Success",
  "Skipped": [23453]
}

Error Example

{
  "ResponseCode": 14,
  "ResponseMsgEng": "docs array does not contain valid refund numbers"
}