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 | http://host/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 | http://host/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 | http://host/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 | http://host/ewallet/api/v1/customer-registration | Open |
| Payout | POST | The Payout API is used to perform all types of transactions (B2B,C2C,C2B,B2C). | Transaction | http://host/ewallet/api/v1/payoutProcess/api | Open |
| WPT Payout | POST | This Payout API is used to perform all types of Wallet transactions (C2C). | Transaction | http://host/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 | http://host/ewallet/api/v1/transactionInfo/api?types=all&status=all&transId={value} | Open |
| Balance Enquiry | GET | The Balance API is used to fetch the current balance in the ledger of the partner. | Final / supporting | http://host/ewallet/api/v1/wallet/walletOwner/{walletOwnerCode} | 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 | http://host/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 | http://host/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 | http://host/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 | http://host/ewallet/api/v1/getDocumentIdType/RHUB/{transactionType} | Open |
| Occupation | GET | The Occupation API is used to fetch the occupation. | Payout preparation / reference | http://host/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 | http://host/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 | http://host/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 | http://host/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 | http://host/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 | http://host/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 | http://host/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 | http://host/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 | http://host/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 | http://host/ewallet/api/v1/customerDocumentType/getByCustomerTypeCode/{customerTypeCode} | Open |
note
Endpoint strings are reproduced exactly as RHUB writes them, including the literal http://host placeholder where RHUB uses it.