API Reference
Start typing to search…

Payout / Deposit RFI

Published when a RFI is required during a transaction process.

Usage Guidelines

Upon receiving this notification, please follow the steps below:

  1. Retrieve RFI Details
    Use the rfi_id provided in the notification to call the API Retrieve RFI. This API returns the required file information for the current RFI.
  2. Upload Required File
    Upload the specified file via the API Upload A File. Upon success, a file_id will be returned.
  3. Submit File via Answer RFI
    Submit the file_id to UQPAY using the API Answer RFI. Please ensure that the answer.key in your request matches the question.key returned from the Retrieve RFI response.

Event metadata

  • name: RFI
  • types:
    • rfi.transaction.action_required

Request body

Fields

Data Type

Description

version

string

API Version number.

event_name

string

Event name.

event_type

string

Type of event that triggered the RFI. Valid values are:

  • rfi.action_required: Triggered during onboarding.
  • rfi.transaction.action_required: Triggered by a deposit or payout transaction.

In this case, rfi.transaction.action_required will be returned.

event_id

string

A unique UUID identifier of the event.

source_id

string

A unique UUID identifier of the source, which in this case is the rfi_id.

data.rfi_id

string

A unique UUID identifier of the RFI.

data.rfi_type

string

The type of RFI. Indicates the business scenario for which the RFI was triggered. Valid values are:

  • onboarding: The RFI was raised during the account onboarding process. This typically requires documents to verify your business information or compliance details.
  • transaction: The RFI was raised in the context of a specific transaction. Additional documentation is needed to verify the legitimacy or purpose of the transaction.

In this case, transaction will be returned.

data.account_id

string

A unique UUID identifier of the account.

data.create_time

string

The timestamp when the RFI was initiated. Timestamp follows the ISO 8601 standard.

data.update_time

string

The timestamp when the RFI was updated. Timestamp follows the ISO 8601 standard.

data.transaction_type

string

The type of transaction related to the RFI. This field is only returned when rfi_type is transaction. Valid values are:

  • payout
  • deposit

data.ref_reference_id

string

A unique UUID referencing the related entity:

  • If rfi_type is onboarding, the account_id will be returned.
  • If rfi_type is transaction, either the deposit_id or payout_id will be returned, depending on the transaction type.

Notification example

{
  "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"
  }
}