Skip to main content
WEBHOOK
payoutDepositRfi
{
  "version": "V1.5.2",
  "event_name": "RFI",
  "event_type": "rfi.transaction.action_required",
  "event_id": "4cd4a279-d801-49e3-a3fe-62059ab5724c",
  "source_id": "a561a466-4cef-4b98-bb44-4864610819d8",
  "data": {
    "rfi_id": "a561a466-4cef-4b98-bb44-4864610819d8",
    "rfi_type": "transaction",
    "account_id": "c061dac9-631e-471d-b52a-de31a16a9ab3",
    "create_time": "2025-04-15T11:58:58+08:00",
    "update_time": "2025-04-15T11:58:58+08:00",
    "transaction_type": "payout",
    "ref_reference_id": "9aa46b68-bc19-49fd-8950-bad9a84f98d8"
  }
}

​
Event Types

Event TypeDescription
rfi.transaction.action_requiredAdditional documentation is required for a payout or deposit transaction.
The RFI-related API endpoints (Retrieve RFI, Answer RFI) are not yet fully available in the current API version. This webhook event is documented for reference, but the complete end-to-end RFI workflow cannot be fully supported via the API at this time.

​
Usage guidelines

Upon receiving this notification, follow the steps below:
1

Retrieve RFI details

Use the rfi_id provided in the notification to call the Retrieve RFI API. This returns the required file information for the current RFI.
2

Upload required file

Upload the specified file via the Upload A File API. Upon success, a file_id will be returned.
3

Submit file via Answer RFI

Submit the file_id to UQPAY using the Answer RFI API.Ensure that the answer.key in your request matches the question.key returned from the Retrieve RFI response.

Body

application/json
​
event_id
string<uuid>
required

A unique identifier for this event.

​
event_name
enum<string>
required

Top-level event category.

Available options:
RFI
​
event_type
enum<string>
required

The specific event type that occurred.

Available options:
rfi.transaction.action_required
​
source_id
string
required

RFI ID.

​
version
string
required

API version number.

Example:

"V1.6.0"

​
data
object

RFI (Request for Information) details associated with the event.

Response

200

Return 200 to acknowledge receipt.