Integration flow
Authentication, Quotation, Payout and Transaction Enquiry are the constant core of every integration. What happens between them depends on the customer and the transaction type.
One point is worth stating up front: a quotation does not require a registered customer. You can price a transaction first and resolve registration afterwards.
The integration sequence
Obtain the access token; send it as Authorization: Bearer <access_token> on every later call.
Price the transaction. The customer does not need to be registered first: pass an existing customerCode, or send it blank.
Send the existing RHUB customer code in customerCode.
Send customerCode as an empty value. Registration happens later.
Upload the KYC/KYB documentation payout requires, and invoice documentation for B2B, B2C and C2B.
Customer registration decision
Resolve the customer before payout — not before the quotation.
Continue with the customer code you hold.
Register with the Customer Registration API, or use on-the-fly registration in the Payout request.
Fetch the master and reference values required by the selected transaction type, route and payout payload.
The final API in the documented sequence; may be used to retrieve the current balance.
What is core, what is conditional, what is supporting
| Category | APIs | When |
|---|---|---|
| Core transaction APIs | Authentication, Quotation, Payout, Transaction Enquiry | Every payout |
| Conditional preparation | Document Upload, Customer Registration | Depends on the customer and the transaction type |
| Preparation / reference | Bank List, other master APIs, currency and country validations | As the route and payload require |
| Final / supporting | Balance | The final API in the documented sequence |
Supporting capabilities
- Master / reference APIs — fetch the coded values your transaction type, route and payload require. There is no requirement to call them all.
- Balance Enquiry — the current wallet or account balance.
- Currency validations and country validations — which conditional fields a given correspondent, currency or country requires.