JUMP TOGetting StartedMaking your First API CallEclipse ReST APIa) AuthenticationUpdate a JSON Web Token by providing additional authentication information to step-up the power of the JWTputCreate a JSON Web Token by passing an identity and passwordpostGet a PKI challenge for use on /login, with an associated challenge to the server to prove its identitygetInvalidate the token provided in the Authorization header or bodypostRenew a JSON Web Token by providing the current token in the Authorization header or bodypostb) Tenant Configuration & OnboardingGet list of tenantsgetRegister a new tenant on the Eclipse PlatformpostGet a tenant by tenant idgetUpdate the details of an existing tenantputGet a list of admin users in the tenantgetCreate a user which can administer the tenantpostUpdate an admin userputDelete an admin userdeleteGet the config for the tenantgetAdd a config item for the tenantpostDo a bulk config updates for tenant. Will update the config if the config already exists and the value has changed. If the config is not present it will be added as a new configpostGet the config for the tenantgetUpdate the config entry for the tenantputDelete the config for the tenantdeleteGet the config for the tenant derived permissionsgetGet some generic data in a weakly typed manner for some open ended use-casepostSend notification to the customer by SMS, Email, Email with attachment etc. In order to use this API, we must first need to set the Mustache template in the property.postGenerate and hold one or more QRCodespostRun a tenant report and return the resultgetGet the list of retail billing configsgetCreate retail billing config logicpostGet a retail billing configId by IdgetUpdate a retail billing configId by IdputDelete retail billing configdeleteAllows you to create a new subscription for an admin userpostSearch admin-users subscription information and status based on the provider. The provider name is a mandatory parameter in the query string. To retrieve information for multiple providers, you can pass a comma-delimited list of provider namesgetAdd a new address for the tenant/organisationpostGet a list of the tenant/organisation's addressesgetGet list of wallets directly attached to the tenantgetCreate a wallet directly attached to the tenantpostDo a set of inter account transfers only applicable for close loop walletspostGet the list of wallet logic set configsgetCreate wallet logic setpostGet a wallet logic set by IdgetUpdate a wallet logic set by IdputDelete wallet logic setdeleteGet the list of wholesale billing configsgetCreate wholesale billing config logicpostGet a wholesale billing configId by IdgetUpdate a wholesale billing configId by IdputDelete wholesale billing configdeletec) Wallet Types & ConfigurationGet list of the tenants wallet typesgetCreate a new wallet typepostGet Wallet Type by walletTypeIdgetUpdate a wallet type by walletTypeIdputDelete a wallet type by walletTypeIddeleted) Customer ManagementSearch for customers in the tenantgetRegister a new CustomerpostCheck if a customer existsheadGet a customer profilegetUpdate a customer profileputDelete a customer profiledeleteGet a list of the customers addressesgetAdd a new address for the customerpostGet a list of the customers attachmentsgetAdd a new attachment on the customerpostGet the Customer Audit detailgetGet a customers beneficiariesgetAdd a new beneficiary for the customerpostGet a customers beneficiary by beneficiaryIdgetUpdate a customers beneficiaryputDelete beneficiarydeleteGet a customers cardsgetIssue a replacement or addon card to the customer for an existing card on their profilepostGet a customers cards on filegetInitiate adding a card on file for the customerpostGet a customers cards on file by cardOnFileIdgetUpdate a customers cards on fileputDelete card on filedeleteUse a card on file in a HTTP request to a permitted partner APIpostGet a list of the customers device fingerprintsgetDelete a device fingerprint for a customerdeleteSend a message to the customers applicable device tokenpostGet a customers device tokensgetAdd a new device token for the customerpostGet a specific device tokengetDelete a specific device tokendeleteGet list of the customers documentsgetAdd a new document against the customerpostGet a list of the customers identitiesgetBulk update customers identitiesputCreate a username/password for a customerpostCheck if a customer has any identitiesheadGet a a specific customer identitygetUpdate a password for a customerputDelete an identity for a customerdeleteGet the fees that would be charged for a loangetGet the limits that would be applicable for a loangetGet all loan associated with the customergetNew loan for the customerpostGet a list of payments for the customergetInitiate making a payment by a customerpostGet a list of positions held by the customergetAdd a position held by the customerpostDelete a position held by a customer in an organisationdeleteGet the ratify results for the customergetRun a KYC algorithm on the customers profile to update the KYC statuspostGet a list of the customers security questionsgetAdd new security questions for the customerpostDelete all security questions for a customerdeleteDelete a security question for a customerdeleteRemove all sessions so the customer has to login againdeleteGet a list of allowed wallet types for a customergetRetrieve a list of wallets associated with the customer. When utilizing the query parameter fields with a value of local, the API will exclusively return local fields, such as walletId and walletType etc. External system interactions will be excluded in this scenariogetCreate a new Wallet for the customerposte) Organisation ManagementSearch for organisationsgetRegister a new organisationpostGet an organisationgetUpdate an organisationputDelete an organisationdeleteGet a list of the organisations addressesgetAdd a new address for the organisationpostGet a list of the organisations attachmentsgetAdd a new attachment on the organisationpostGet list of the organisations documentsgetAdd a new document against the organisationpostGet a list of payments for the organisationgetInitiate making a payment by a organisationpostGet a list of positions held in the organisationgetAdd a position held in the organisationpostDelete a position held by a customer in the organisationdeleteGet the ratify results for the organisationgetRun a KYC algorithm on the organisations profile to update the KYB statuspostGet Cash Payment's historygetGet list of the organisations storesgetAdd a new store against the organisationpostUpdate a storeputDelete a storedeleteGet list of the organisations terminalsgetAdd a new terminal against the organisationpostUpdate a terminalputenroll a terminalpostGet a list of allowed wallet types for a organisationgetRetrieve a list of wallets associated with the organisationgetCreate a new Wallet for the organisationpostf) Address ManagementGet a certain customer or organisations address by addressIdgetUpdate an address by addressIdputDelete an address by addressIddeleteg) Document ManagementGet a certain customer or organisations document by documentIdgetUpdate a document by documentIdputDelete a document by documentIddeleteh) WalletsSearch for a wallet within tenantgetDo a set of inter account transfers only applicable for close loop walletspostGet the status of an ongoing non-atomic bulk transfergetGet wallet by walletIdgetUpdate a wallet by walletIdputDelete a wallet by walletIddeleteGet a list of the wallets attachmentsgetAdd a new attachment on the walletpostGet the Wallet Audit detailgetCreate a new QRCodes linked to the wallet in bulkpostDo a set of inter account transfers from the wallet. Only applicable for close loop walletspostGet cards linked to the walletgetCreate a card linked to the existing walletpostGet transaction limits applicable for given walletgetGet payments made by or accepted into the walletgetGet QRCodes linked to the wallet. We only support the masterpass QRCode search by reference which has been created by eclipse.getCreate a new QRCode linked to the wallet or link an existing unlinked QRCode to the wallet or link existing reserved qrCode to walletpostUnlink the QRCode from the walletdeleteGet wallets transactionsgetGet the fees that would be charged on source wallet for P2P transfergeti) Card ManagementSearch for cards in the tenantgetGet a specific card by cardIdgetUpdate a cardputSet and send new card PIN to customerpostj) Wallet QRCodesGet details for a specific QRCodegetUpdate QRCodes linked to the wallet in bulkpostGet details for a specific QRCodegetUpdate previously created QrCode details like amount, reference and description.putk) Wallet TopupsGet a wallets topupsgetInitiate a new topup for a walletpostGet the details for a topupgetUpdate Topup Status to SUCCESSFUL or ERROR_PERM if Topup is in PENDING / BUILDING Status.putl) Wallet WithdrawalsGet a wallets withdrawalsgetInitiate a new withdrawalpostGet the fees that would be charged for a withdrawalgetGet the limits that would be applicable for a withdrawalgetGet a withdrawal by IdgetUpdate wallet withdrawalputm) Wallet TransfersDo a wallet transferpostn) Wallet ReservationsGet wallets reservationsgetCreate a reservationpostGet a ReservationgetDelete the reservationdeleteo) Wallet BundlesGet wallets bundlesgetCreate a bundlepostGet a bundlegetp) VAS FunctionalityGet list of vas partner and their productsgetGet a mobile network information as vas partner through mobile numbergetq) PaymentsGet a list of payments for the QRgetInitiate a new paymentpostGet the details of a paymentgetUpdate necessary fields of a paymentputGet the Proof of PaymentgetGet payment refund information.getRefund a portion or entire payment amountpostGet payment refund information.getr) Wallet Cross Border RemittancesRetrieve remittance catalogs.getRetrieve customer status based on providergetUpdate enroll customer based on providerputRegister a new enroll customer based on providerpostExchange quote for cross border remittancepostGet a wallets cross border remittancesgetInitiate a new cross border remittancepostGet a remittance by IdgetUpdate wallet remittanceputs) Attachment Managementget derived-attachment-typesgetGet a certain customer, wallet or organisations attachment by attachmentIdgetUpdate an attachment by attachmentIdputDelete an attachment by attachmentIddeletet) Rewards exchangeGet a rewardsgetInitiate a reward exchangepostGet a reward by rewardIdgetUpdate rewardsputu) Loan FunctionalityGet loan catalogs that are currently available.getRetrieve loan information by loanIdgetupdate loans.putGet loans transactionsgetv) POS Terminals & Types & ConfigurationGet list of the tenants terminal typesgetCreate a new terminal typepostGet Terminal Type by terminalTypeIdgetUpdate a terminal type by terminalTypeIdputDelete a terminal type by terminalTypeIddeleteEnroll a terminal at the tenant levelpostGet Terminal by terminalIdgetDelete a terminaldeleteEnroll a terminal at the tenant level, specifiying the terminalpostw) Scheduled JobsGet scheduled jobsgetCreate a scheduled jobspostGet the details of a scheduled jobgetUpdate scheduled jobputDelete a scheduled jobdeletex) AccountsRetrieve a list of accountsgetAdd a new accountpostGet Account detailgetUpdate accountputDelete the Account details.deleteGet Account historygetRetrieve a list of salesgetAdd a new salepostGet Sale detailgetUpdate saleputUpdate sale with the eventpostRetrieve a sales invoicegetRegenerate a sales invoiceputRetrieve a list of productsgetAdd a new productpostGet Product detailgetUpdate productputDelete productdeletefind sales with/without account idgetz) Global FunctionalityGet a list of global admin usersgetCreate a user which can work across all tenantspostUpdate an admin userputDelete an admin userdeleteGet the nonce for deviceIdgetValidate noncepostSearch for batchesgetUpload batchpostDownload a batch file in form of csvgetRemove failed batchesdeleteTo get specific BIN from MasterpassgetFlush configuration cachespostGet a list of CallbacksgetUpdate necessary fields of a CallbackputGet the value of a publically available global config valuegetUtility for various document conversionspostNon-Eclipse tenant have the ability to download a file using a pre-signed URL.getCheck if given identity existsheadChange a customers passwordpostInitiate a password change by sending an OTP to the users phone which can be used for a POST to password-changepostSend notification by SMS, Email, Email with attachment etc. In order to use this API, we must first need to set the Mustache template in the property.postGet paymentsgetupdate a paymentputGet the ratify results that have not been manually verified yetgetUpdate the individual ratify result which is manually verifiedputCurrent server date and time in milliseconds after the epochgetGet a list of tasks based on a query parametersgetUpdate a taskputAdd a log to the current tracepostSend an OTP sms/email to a customerpostCheck if a OTP sent by SMS/Email is correct or if security questions answers are correctgetSearch for a wallet irrespective of tenantgetAdd Customer to Agency as WatchListpostPowered by Send a message to the customers applicable device tokenpost https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/device-messagesSends a push message