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 PlatformpostUpdate the details of an existing tenantputGet a tenant by tenant idgetGet 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 configpostUpdate the config entry for the tenantputGet the config for the tenantgetDelete 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 logicpostUpdate a retail billing configId by IdputGet a retail billing configId by IdgetDelete 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 transferspostGet the list of wallet logic set configsgetCreate wallet logic setpostUpdate a wallet logic set by IdputGet a wallet logic set by IdgetDelete wallet logic setdeleteGet the list of wholesale billing configsgetCreate wholesale billing config logicpostUpdate a wholesale billing configId by IdputGet a wholesale billing configId by IdgetDelete wholesale billing configdeletec) Wallet Types & ConfigurationGet list of the tenants wallet typesgetCreate a new wallet typepostUpdate a wallet type by walletTypeIdputGet Wallet Type by walletTypeIdgetDelete a wallet type by walletTypeIddeleted) Customer ManagementSearch for customers in the tenantgetCheck if a customer existsheadRegister a new CustomerpostUpdate a customer profileputGet a customer profilegetDelete 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 customerpostUpdate a customers beneficiaryputGet a customers beneficiary by beneficiaryIdgetDelete beneficiarydeleteGet a customers cardsgetIssue a replacement or addon card to the customer for an existing card on their profilepostInitiate adding a card on file for the customerpostGet a customers cards on filegetUpdate a customers cards on fileputGet a customers cards on file by cardOnFileIdgetDelete 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 customerpostBulk update customers identitiesputCheck if a customer has any identitiesheadGet a list of the customers identitiesgetCreate a username/password for a customerpostUpdate a password for a customerputGet a a specific customer identitygetDelete 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 customerpostInitiate making a payment by a customerpostGet a list of payments for the customergetGet a list of positions held by the customergetAdd a position held by the customerpostDelete a position held by a customer in an organisationdeleteRun a KYC algorithm on the customers profile to update the KYC statuspostGet the ratify results for the customergetGet a list of the customers security questionsgetDelete all security questions for a customerdeleteAdd new security questions for the customerpostDelete 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 organisationpostUpdate an organisationputGet an organisationgetDelete 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 organisationpostInitiate making a payment by a organisationpostGet a list of payments for the organisationgetGet a list of positions held in the organisationgetAdd a position held in the organisationpostDelete a position held by a customer in the organisationdeleteRun a KYC algorithm on the organisations profile to update the KYB statuspostGet the ratify results for the organisationgetGet list of the organisations storesgetAdd a new store against the organisationpostGet Cash Payment's historygetUpdate 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 ManagementUpdate an address by addressIdputGet a certain customer or organisations address by addressIdgetDelete an address by addressIddeleteg) Document ManagementUpdate a document by documentIdputGet a certain customer or organisations document by documentIdgetDelete a document by documentIddeleteh) WalletsSearch for a wallet within tenantgetDo a set of inter account transferspostGet the status of an ongoing non-atomic bulk transfergetUpdate a wallet by walletIdputGet wallet by walletIdgetDelete 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 walletpostGet 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 transactionsgetMark transaction as fraudpatchGet the fees that would be charged on source wallet for P2P transfergeti) Card ManagementSearch for cards in the tenantgetUpdate a cardputGet a specific card by cardIdgetSet and send new card PIN to customerposti.1) Card ProvisioningCard provisioningpostGet eligible token requestors for card push provisioninggetGet Card ProvisioninggetDelete Card Provisioningdeletej) Wallet QRCodesGet details for a specific QRCodegetUpdate QRCodes linked to the wallet in bulkpostUpdate previously created QrCode details like amount, reference and description.putGet details for a specific QRCodegetk) Wallet TopupsGet a wallets topupsgetInitiate a new topup for a walletpostUpdate Topup Status to SUCCESSFUL or ERROR_PERM if Topup is in PENDING / BUILDING Status.putGet the details for a topupgetl) Wallet WithdrawalsInitiate a new withdrawalpostGet a wallets withdrawalsgetGet the fees that would be charged for a withdrawalgetGet the limits that would be applicable for a withdrawalgetUpdate wallet withdrawalputGet a withdrawal by Idgetm.1) Wallet TransfersDo a wallet transferpostm.2) Wallet ReversalsDo a reversalpostn) 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) PaymentsInitiate a new paymentpostGet a list of payments for the QRgetUpdate necessary fields of a paymentputGet the details of a paymentgetGet the Proof of PaymentgetRefund a portion or entire payment amountpostGet payment refund information.getGet payment refund information.getq.1) FraudTo Publish Fraud event to third partypostr) Wallet Cross Border RemittancesRetrieve remittance catalogs.getUpdate enroll customer based on providerputRegister a new enroll customer based on providerpostRetrieve customer status based on providergetExchange quote for cross border remittancepostInitiate a new cross border remittancepostGet a wallets cross border remittancesgetUpdate wallet remittanceputGet a remittance by Idgets) Attachment Managementget derived-attachment-typesgetUpdate an attachment by attachmentIdputGet a certain customer, wallet or organisations attachment by attachmentIdgetDelete an attachment by attachmentIddeletet) Rewards exchangeInitiate a reward exchangepostGet a rewardsgetUpdate rewardsputGet a reward by rewardIdgetu) Loan FunctionalityGet loan catalogs that are currently available.getupdate loans.putRetrieve loan information by loanIdgetGet loans transactionsgetv) POS Terminals & Types & ConfigurationGet list of the tenants terminal typesgetCreate a new terminal typepostUpdate a terminal type by terminalTypeIdputGet Terminal Type by terminalTypeIdgetDelete 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 jobspostUpdate scheduled jobputGet the details of a scheduled jobgetDelete a scheduled jobdeletex) AccountsRetrieve a list of accountsgetAdd a new accountpostUpdate accountputGet Account detailgetDelete the Account details.deleteGet Account historygetRetrieve a list of salesgetAdd a new salepostUpdate saleputGet Sale detailgetUpdate sale with the eventpostRegenerate a sales invoiceputRetrieve a sales invoicegetRetrieve a list of productsgetAdd a new productpostUpdate productputGet Product detailgetDelete productdeletefind sales with/without account idgetRetrieve a list of product itemsgetRetrieve a list of productsgetAdd a new productpostUpdate productputGet Product detailgetDelete productdeletey) Supplier ManagementSearch for suppliersgetRegister a new supplierpostUpdate a supplierputGet a suppliergetDelete a supplierdeletez) Global FunctionalityGet a list of global admin usersgetCreate a user which can work across all tenantspostUpdate an admin userputDelete an admin userdeleteValidate noncepostGet the nonce for deviceIdgetUpload batchpostSearch for batchesgetUpdate a batch statusputDownload a batch file in form of csvgetRemove failed batchesdeleteTo get specific BIN from MasterpassgetDo a set of inter account transferspostFlush 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 I So MessagepostInitiate 3DS authenticationpostSend 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 epochgetSend I So Transaction MessagepostGet 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 Get a list of payments for the QRget https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/paymentsReturns payments that were initiated