VA integration flow
The sequence below is the order RHUB supports for Virtual Account onboarding. Steps 1 to 6 are client actions; the final step is carried out by RHUB Admin/Operations.
Confirm the settlement currency you need is enabled for Virtual Accounts.
Fetch VA document requirements
Retrieve the document checklist for the customer type you are onboarding.
Upload the required VA documents
Upload each document with its document type. One client-generated
docReferenceNumber groups the set.
Retrieve or edit the customer, and the uploaded documents
Retrieve individual · Edit individual · Retrieve business · Edit business · Get uploaded documents
Approval and collection-bank setup
RHUB reviews the request and establishes the collection bank relationship. Clients do not call this operation.
Recommended Order of API Calls
| # | Step | API | Why This Step? |
|---|---|---|---|
| 1 | Check Currencies | Get VA Currency API | Confirm which currencies are VA-settlement enabled (vaSettlementFlag: true) before onboarding. |
| 2 | Fetch Document Checklist | VA Document Type List API | Get the mandatory/optional document list for the customer type (Individual vs Business). |
| 3 | Upload Documents | Upload VA Document API | Upload each document from the checklist. Each call returns a docReferenceNumber. |
| 4 | Verify Uploads (optional) | Get Uploaded VA Documents API | List what's been uploaded so far for a wallet owner, useful for a progress checklist UI. |
| 5 | Register the Customer | Create Individual / Business Customer API | Submit the full registration payload, referencing the docReferenceNumber from Step 3. |
| 6 | Fetch the Receipt (optional) | Customer Receipt API | Re-fetch the registration to confirm what was saved and its screening/approval state. |
| 7 | Edit if Needed | Edit Individual / Business Customer API | Update the customer record — same payload shape as Create, keyed by customerCode. |
| 8 | Track VA Request | VA Account Request Status API | Ops-side: view the queue of pending/approved VA account requests. |
| 9 | Approve & Link Bank | VA Customer Account Approve API | Ops-side: link the customer to a collection bank account and activate the Virtual Account. |