Skip to main content

​
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.action_required

​
Request body

​
Notification example

JSON
{
    "version": "V1.6.0",
    "event_name": "RFI",
    "event_type": "rfi.action_required",
    "event_id": "f531776b-df59-4d11-84f0-11e7ae3755f0",
    "source_id": "881147e4-89de-4e0e-afbc-7d19f6c4f14b",
    "data": {
      "rfi_id": "3bb1231f-3010-4bd8-b44b-c689c79cf635",
      "rfi_type": "onboarding",
      "account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
      "create_time": "2024-03-21T17:17:32+08:00",
      "update_time": "2024-03-21T17:17:32+08:00",
      "ref_reference_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7"
    }
}