API index
Every API in the public reference, with the stage of an integration at which it is typically used. Purposes are RHUB's own descriptions.
Transaction APIs
| API | Method | Purpose | Integration stage | Endpoint | Page |
|---|---|---|---|---|---|
| Authentication | POST | The Login API is used to authenticate and authorize the user. | Start | /ewallet/oauth/token | Open |
| Quotation | POST | The Quotation API is used to fetch the forex rate between the payin and payout currencies. | Pricing / pre-registration | /ewallet/api/v1/fxratequotation/api | Open |
| Document Upload | POST | The Document Upload API is used to upload the ID proof documents of the specific customer of the send client. | Payout preparation | /ewallet/api/v1/documentUpload/upload/customer | Open |
| Customer Registration | POST | The Customer-Registration API is used to register or create the customer in the system. | Conditional customer setup | /ewallet/api/v1/customer-registration | Open |
| Payout | POST | The Payout API is used to perform all types of transactions (B2B,C2C,C2B,B2C). | Transaction | /ewallet/api/v1/payoutProcess/api | Open |
| WPT Payout | POST | This Payout API is used to perform all types of Wallet transactions (C2C). | Transaction | /ewallet/api/v1/payoutProcess/api | Open |
| Transaction Enquiry | GET | The Transaction Enquiry API is used to fetch the statement for the specified period. | Post-payout | /ewallet/api/v1/transactionInfo/api?types=all&status=all&transId={value} | Open |
| Payout Notification | GET | Returns partner wallet transaction records for the requested date range, wallet and filters, in JSON. | Post-payout | /ewallet/api/v1/miniStatement/partnerStatement | Open |
| Balance Enquiry | GET | The Balance API is used to fetch the current balance in the ledger of the partner. | Final / supporting | /ewallet/api/v1/wallet/walletOwner/{walletOwnerCode} | Open |
| Payin Notification | GET | The Payin Notification API retrieves partner wallet transaction records for a specified date range and customer. | VA post-registration | /ewallet/api/v1/miniStatement/partnerStatement | Open |
Virtual Account APIs
Virtual Account onboarding endpoints. Customer registration uses the same endpoint as the rest of the platform, in a VA onboarding context with a VA-specific request; see the linked page for that variant.
| API | Method | Purpose | Integration stage | Endpoint | Page |
|---|---|---|---|---|---|
| VA Currencies | GET | Returns the settlement currencies enabled for Virtual Accounts under a send client. | VA onboarding | /ewallet/api/v1/currency/virtualAccountCurrency/{sendClientCode} | Open |
| VA Document Type List | GET | Returns the document checklist for a VA customer type. | VA onboarding | /ewallet/api/v1/virtualAccount/customerDocumentType/getByCustomerTypeCode/{customerTypeCode} | Open |
| Upload VA Document | POST | Uploads a single VA document against its document type. | VA onboarding | /ewallet/api/v1/documentUpload/upload/virtualCustomer | Open |
| Get Uploaded VA Documents | GET | Returns the VA documents already uploaded for a wallet owner. | VA onboarding | /ewallet/api/v1/documentUpload/virtualDocument/{walletOwnerCode} | Open |
| VA Customer Registration (individual) | POST | Registers an individual VA customer. Shared endpoint, VA-specific request. | VA onboarding | /ewallet/api/v1/customer-registration | Open |
| VA Customer Registration (business) | POST | Registers a business VA customer. Shared endpoint, VA-specific request. | VA onboarding | /ewallet/api/v1/customer-registration | Open |
| Retrieve VA Customer | GET | Returns a registered VA customer record. | VA onboarding | /ewallet/api/v1/customer-registration/{code} | Open |
| Edit VA Customer | PUT | Updates the editable fields of a registered VA customer. | VA onboarding | /ewallet/api/v1/customer-registration/{code} | Open |
| VA Request Status | GET | Returns the state of submitted VA account requests. | VA post-registration | /ewallet/api/v1/collectionBank/individual/virtualAccount/customer/all | Open |
Master / reference APIs
Master APIs supply the coded values other requests expect. They are need-based: call the ones your route and use case require, in whatever order suits your implementation. They are not a sequence.
| API | Method | Purpose | Integration stage | Endpoint | Page |
|---|---|---|---|---|---|
| Remittance Purpose | GET | The Remittance Purpose API is used to fetch the purpose to send the remittance. | Payout preparation / reference | /ewallet/api/v1/purposeOfRemittance/RHUB/{transactionType}/{countryCode} | Open |
| Source of Fund | GET | The Source of Fund API is used to fetch the source of the fund. | Payout preparation / reference | /ewallet/api/v1/getSourceOfFund/RHUB/{transactionType}/{countryCode} | Open |
| Relationship | GET | The Relationship API is used to fetch the relation of the beneficiary with the sender. | Payout preparation / reference | /ewallet/api/v1/getRelationship/RHUB/{transactionType} | Open |
| Document ID Type | GET | The Document ID Type API is used to fetch the list of all document types. | Payout preparation / reference | /ewallet/api/v1/getDocumentIdType/RHUB/{transactionType} | Open |
| Occupation | GET | The Occupation API is used to fetch the occupation. | Payout preparation / reference | /ewallet/api/v1/getOccupation/RHUB/{transactionType} | Open |
| Business Type | GET | The Business API is used to fetch the Business type of customer. | Payout preparation / reference | /ewallet/api/v1/masterBusinessTypes/RHUB/{transactionType} | Open |
| Business Registration Type | GET | The Business registration type API is used to fetch the registration type of business customers. | Payout preparation / reference | /ewallet/api/v1/masterBusinessRegistrationTypes/RHUB/{transactionType} | Open |
| Account Type | GET | The Account Type API is used to fetch the type of the account. | Payout preparation / reference | /ewallet/api/v1/accountType/all | Open |
| WPT Wallet List | GET | The Wallet list API is used to fetch the list of WPT providers. | Payout preparation / reference | /ewallet/api/v1/walletList/{countryCode}/{currencyCode}/{receiverCode}/WPT | Open |
| Bank List | GET | The Bank List API is used to fetch the list of the bank. | Payout preparation / reference | /ewallet/api/v1/payoutbanklist/{country}/{currency}/{recieverCode} | Open |
| Customer Legal Status | GET | The Customer Type API is used to fetch the legal status of the customer. | Payout preparation / reference | /ewallet/api/v1/customerLegalStatus/getByCustomerTypeCode/{customerTypeCode} | Open |
| Nature of Business | GET | The Nature of Business API is used to fetch the nature of the business run by the customer. | Payout preparation / reference | /ewallet/api/v1/natureOfBusiness/getByCustomerTypeCode/{customerTypeCode} | Open |
| Customer Occupation Type | GET | The Customer Occupation Type API is used to fetch the occupation of the customer. | Payout preparation / reference | /ewallet/api/v1/customerOccupationType/getByCustomerTypeCode/{customerTypeCode} | Open |
| Customer/Individual Document Type | GET | The Customer Document Type API is used to fetch the ID proof documents of the customer. | Payout preparation / reference | /ewallet/api/v1/customerDocumentType/getByCustomerTypeCode/{customerTypeCode} | Open |
Lookups used for Virtual Account onboarding
These lookups supply the coded values the Virtual Account registration payloads expect. Full response shapes and list keys are on VA reference data.
| API | Method | Purpose | Integration stage | Endpoint | Page |
|---|---|---|---|---|---|
| Business Transaction Volume | GET | Returns the business transaction-volume bands for a customer type. Used for VA onboarding. | Payout preparation / reference | /ewallet/api/v1/businessTxnVolume/getByCustomerTypeCode/{customerTypeCode} | Open |
| Purpose of Opening Business | GET | Returns the business-relationship purposes for business customers. Used for VA onboarding. | Payout preparation / reference | /ewallet/api/v1/purposeOfOpeningBusiness/getByCustomerTypeCode/100002 | Open |
| Residence Status | GET | Returns the residence-status values for individual customers. Used for VA onboarding. | Payout preparation / reference | /ewallet/api/v1/residenceStatus/customerTypeCode/100001 | Open |
| ID Type | GET | Returns the identity-document types for business customers. Used for VA onboarding. | Payout preparation / reference | /ewallet/api/v1/idType/getByCustomerTypeCode/100002 | Open |
| Customer Type | GET | Returns the customer types, for example individual and business. Used for VA onboarding. | Payout preparation / reference | /ewallet/api/v1/customerType/all | Open |
note
Endpoints are listed as paths. Append them to the base URL of your environment — see API environments.