Jump to Content
Home
Integration Guides
API
Discussions
Log In
API
Log In
Home
Integration Guides
API
Discussions
Making your First API Call
All
Pages
Start typing to search…
JUMP TO
Getting Started
Making your First API Call
Eclipse ReST API
a) Authentication
Update a JSON Web Token by providing additional authentication information to step-up the power of the JWT
put
Create a JSON Web Token by passing an identity and password
post
Get a PKI challenge for use on /login, with an associated challenge to the server to prove its identity
get
Invalidate the token provided in the Authorization header or body
post
Renew a JSON Web Token by providing the current token in the Authorization header or body
post
b) Tenant Configuration & Onboarding
Get list of tenants
get
Register a new tenant on the Eclipse Platform
post
Update the details of an existing tenant
put
Get a tenant by tenant id
get
Get a list of admin users in the tenant
get
Create a user which can administer the tenant
post
Update an admin user
put
Delete an admin user
del
Get the config for the tenant
get
Add a config item for the tenant
post
Do 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 config
post
Update the config entry for the tenant
put
Get the config for the tenant
get
Delete the config for the tenant
del
Get the config for the tenant derived permissions
get
Generic interface for migrating data into a tenant
post
Get some generic data in a weakly typed manner for some open ended use-case
post
Send 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.Introduces a new TEMPLATE EclipseNotificationType type, supported via Handlebars templates for dynamic, multi-channel messaging.
post
Generate and hold one or more QRCodes
post
Run a tenant report and return the result
get
Get the list of retail billing configs
get
Create retail billing config logic
post
Update a retail billing configId by Id
put
Get a retail billing configId by Id
get
Delete retail billing config
del
Allows you to create a new subscription for an admin user
post
Search 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 names
get
Generic interface for managing session keys for terminals and other use cases
post
Get a list of the tenant/organisation's addresses
get
Get list of wallets directly attached to the tenant
get
Create a wallet directly attached to the tenant
post
Add a new address for the tenant/organisation
post
Do a set of inter account transfers
post
Get the list of wallet logic set configs
get
Create wallet logic set
post
Update a wallet logic set by Id
put
Get a wallet logic set by Id
get
Delete wallet logic set
del
Get the list of wholesale billing configs
get
Create wholesale billing config logic
post
Update a wholesale billing configId by Id
put
Get a wholesale billing configId by Id
get
Delete wholesale billing config
del
c) Wallet Types & Configuration
Get list of the tenants wallet types
get
Create a new wallet type
post
Update a wallet type by walletTypeId
put
Get Wallet Type by walletTypeId
get
Delete a wallet type by walletTypeId
del
d) Customer Management
Search for customers in the tenant
get
Check if a customer exists
head
Register a new Customer
post
Update a customer profile
put
Get a customer profile
get
Delete a customer profile
del
Get a list of the customers addresses
get
Add a new address for the customer
post
Get a list of the customers attachments
get
Add a new attachment on the customer
post
Get the Customer Audit detail
get
Get a customers beneficiaries
get
Add a new beneficiary for the customer
post
Update a customers beneficiary
put
Get a customers beneficiary by beneficiaryId
get
Delete beneficiary
del
Get a customers cards
get
Issue a replacement or addon card to the customer for an existing card on their profile
post
Initiate adding a card on file for the customer
post
Get a customers cards on file
get
Update a customers cards on file
put
Get a customers cards on file by cardOnFileId
get
Delete card on file
del
Use a card on file in a HTTP request to a permitted partner API
post
Get a list of the customers device fingerprints
get
Delete a device fingerprint for a customer
del
Send a message to the customers applicable device token
post
Get a customers device tokens
get
Add a new device token for the customer
post
Get a specific device token
get
Delete a specific device token
del
Get list of the customers documents
get
Add a new document against the customer
post
Bulk update customers identities
put
Check if a customer has any identities
head
Get a list of the customers identities
get
Create a username/password for a customer
post
Update a password for a customer
put
Get a a specific customer identity
get
Delete an identity for a customer
del
Get the fees that would be charged for a loan
get
Get the limits that would be applicable for a loan
get
Get all loan associated with the customer
get
New loan for the customer
post
Initiate making a payment by a customer
post
Get a list of payments for the customer
get
Get a list of positions held by the customer
get
Add a position held by the customer
post
Delete a position held by a customer in an organisation
del
Run a KYC algorithm on the customers profile to update the KYC status
post
Get the ratify results for the customer
get
Get a list of the customers security questions
get
Delete all security questions for a customer
del
Add new security questions for the customer
post
Delete a security question for a customer
del
Remove all sessions so the customer has to login again
del
Get a list of allowed wallet types for a customer
get
Retrieve 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 scenario
get
Create a new Wallet for the customer
post
Opt-In the customer for the loans
post
Opt-out the customer for the loans
post
e) Organisation Management
Search for organisations
get
Register a new organisation
post
Update an organisation
put
Get an organisation
get
Delete an organisation
del
Get a list of the organisations addresses
get
Add a new address for the organisation
post
Get a list of the organisations attachments
get
Add a new attachment on the organisation
post
Get list of the organisations documents
get
Get an organisations beneficiaries
get
Add a new document against the organisation
post
Add a new beneficiary for the organisation
post
Initiate making a payment by an organisation
post
Update an organisations beneficiary
put
Get a list of payments for the organisation
get
Get an organisations beneficiary by beneficiaryId
get
Get a list of positions held in the organisation
get
Delete beneficiary
del
Add a position held in the organisation
post
Delete a position held by a customer in the organisation
del
Run a KYC algorithm on the organisations profile to update the KYB status
post
Get the ratify results for the organisation
get
Get list of the organisations stores
get
Run an organisation report and return the result
get
Add a new store against the organisation
post
Get Cash Payment's history
get
Update a store
put
Delete a store
del
Get list of the organisations terminals
get
Add a new terminal against the organisation
post
Update a terminal
put
enroll a terminal
post
Get a list of allowed wallet types for an organisation
get
Retrieve a list of wallets associated with the organisation
get
Create a new Wallet for the organisation
post
f) Address Management
Update an address by addressId
put
Get a certain customer or organisations address by addressId
get
Delete an address by addressId
del
g) Document Management
Update a document by documentId
put
Get a certain customer or organisations document by documentId
get
Delete a document by documentId
del
h) Wallets
Search for a wallet within tenant
get
Do a set of inter account transfers
post
Get the status of an ongoing non-atomic bulk transfer
get
Update a wallet by walletId
put
Get wallet by walletId
get
Delete a wallet by walletId
del
Get a list of the wallets attachments
get
Add a new attachment on the wallet
post
Get the Wallet Audit detail
get
Create a new QRCodes linked to the wallet in bulk
post
Do a set of inter account transfers from the wallet
post
Get cards linked to the wallet
get
Create a card linked to the existing wallet
post
Get transaction limits applicable for given wallet
get
Get payments made by or accepted into the wallet
get
Get QRCodes linked to the wallet. We only support the masterpass QRCode search by reference which has been created by eclipse.
get
Create a new QRCode linked to the wallet or link an existing unlinked QRCode to the wallet or link existing reserved qrCode to wallet
post
Unlink the QRCode from the wallet
del
Get wallets transactions
get
Mark transaction as fraud
patch
Get the fees that would be charged on source wallet for P2P transfer
get
i) Card Management
Search for cards in the tenant
get
Update a card
put
Get a specific card by cardId
get
Set and send new card PIN to customer
post
Retrieve card activities
get
Retrieve issuer card tokens
get
Retrieve issuer card token details
get
i.1) Card Provisioning
Card provisioning
post
Get eligible token requestors for card push provisioning
get
Get Card Provisioning
get
Delete Card Provisioning
del
i.2) Proxy Card Management
Update card limits for a card program
put
Get card limits for a card program
get
Blocks a card to prevent unauthorized use and Reactivates a previously blocked card
put
Retrieve the status of the card (e.g. Active, Blocked)
get
Activate a new card after issuance of a physical card
post
Link account to card
post
Get account list
get
Update account to card
put
Unlink account from card
del
Update card limits by encrypted pan
put
Retrieve card activities
get
Get card limits
get
Generate new card PIN to card
post
Change or Reset card PIN to card
put
Validates the provided PIN
post
j) Wallet QRCodes
Get details for a specific QRCode
get
Update QRCodes linked to the wallet in bulk
post
Update previously created QrCode details like amount, reference and description.
put
Get details for a specific QRCode
get
k) Wallet Topups
Get a wallets topups
get
Initiate a new topup for a wallet
post
Update Topup Status to SUCCESSFUL or ERROR_PERM if Topup is in PENDING / BUILDING Status.
put
Get the details for a topup
get
l) Wallet Withdrawals
Initiate a new withdrawal
post
Get a wallets withdrawals
get
Get the fees that would be charged for a withdrawal
get
Get the limits that would be applicable for a withdrawal
get
Update wallet withdrawal
put
Get a withdrawal by Id
get
m.1) Wallet Transfers
Do a wallet transfer
post
m.2) Wallet Reversals
Do a reversal
post
n) Wallet Reservations
Get wallets reservations
get
Create a reservation
post
Get a Reservation
get
Delete the reservation
del
o) Wallet Bundles
Get wallets bundles
get
Create a bundle
post
Get a bundle
get
p) VAS Functionality
Get list of vas partner and their products
get
Get a mobile network information as vas partner through mobile number
get
q) Payments
Initiate a new payment
post
Get a list of payments for the QR
get
Update necessary fields of a payment
put
Get the details of a payment
get
Get the Proof of Payment
get
Refund a portion or entire payment amount
post
Get payment refund information.
get
Get payment refund information.
get
q.1) Fraud
To Publish Fraud event to third party
post
r) Wallet Cross Border Remittances
Retrieve remittance catalogs.
get
Update enroll customer based on provider
put
Register a new enroll customer based on provider
post
Retrieve customer status based on provider
get
Exchange quote for cross border remittance
post
Initiate a new cross border remittance
post
Get a wallets cross border remittances
get
Update wallet remittance
put
Get a remittance by Id
get
s) Attachment Management
get derived-attachment-types
get
Update an attachment by attachmentId
put
Get a certain customer, wallet or organisations attachment by attachmentId
get
Delete an attachment by attachmentId
del
t) Rewards exchange
Initiate a reward exchange
post
Get a rewards
get
Update rewards
put
Get a reward by rewardId
get
u) Loan Functionality
Get loan catalogs that are currently available.
get
update loans.
put
Retrieve loan information by loanId
get
Get loans transactions
get
loan repayment.
post
v) POS Terminals & Types & Configuration
Get list of the tenants terminal types
get
Create a new terminal type
post
Update a terminal type by terminalTypeId
put
Get Terminal Type by terminalTypeId
get
Delete a terminal type by terminalTypeId
del
Enroll a terminal at the tenant level
post
Get Terminal by terminalId
get
Delete a terminal
del
Enroll a terminal at the tenant level, specifiying the terminal
post
Get a terminal by mapping
get
w) Scheduled Jobs
Get scheduled jobs
get
Create a scheduled jobs
post
Update scheduled job
put
Get the details of a scheduled job
get
Delete a scheduled job
del
x) Accounts
Retrieve a list of accounts
get
Add a new account
post
Update account
put
Get Account detail
get
Delete the Account details.
del
Get Account history
get
Retrieve a list of sales
get
Add a new sale
post
Update sale
put
Get Sale detail
get
Update sale with the event
post
Regenerate a sales invoice
put
Retrieve a sales invoice
get
Retrieve a list of products
get
Add a new product
post
Update product
put
Get Product detail
get
Delete product
del
find sales with/without account id
get
Retrieve a list of product items
get
Retrieve a list of products
get
Add a new product
post
Update product
put
Get Product detail
get
Delete product
del
y) Supplier Management
Search for suppliers
get
Register a new supplier
post
Update a supplier
put
Get a supplier
get
Delete a supplier
del
z) Global Functionality
Get a list of global admin users
get
Create a user which can work across all tenants
post
Update an admin user
put
Delete an admin user
del
Validate nonce
post
Get the nonce for deviceId
get
Upload batch
post
Search for batches
get
Update a batch status
put
Download a batch file in form of csv
get
Remove failed batches
del
To get specific BIN from Masterpass
get
Do a set of inter account transfers
post
Flush configuration caches
post
Get a list of Callbacks
get
Update necessary fields of a Callback
put
Get the value of a publically available global config value
get
Utility for various document conversions
post
Execute query in database
post
Non-Eclipse tenant have the ability to download a file using a pre-signed URL.
get
Check if given identity exists
head
Change a customers password
post
Initiate a password change by sending an OTP to the users phone which can be used for a POST to password-change
post
Initiate 3DS authentication
post
Send 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.Introduces a new TEMPLATE notification type, supported via Handlebars templates for dynamic, multi-channel messaging.
post
Get payments
get
update a payment
put
Get the ratify results that have not been manually verified yet
get
Update the individual ratify result which is manually verified
put
Current server date and time in milliseconds after the epoch
get
Send ISO Transaction Message
post
Get a list of tasks based on a query parameters
get
Update a task
put
Add a log to the current trace
post
Send an OTP sms/email to a customer
post
Check if a OTP sent by SMS/Email is correct or if security questions answers are correct
get
Search for a wallet irrespective of tenant
get
Add Customer to Agency as WatchList
post
z.1) Institution Level Management
Search for customers in the institution
get
Get a customer profile
get
Get metrics for an institution
get
Update a customer wallets status within an institution
put
Get some generic data in a weakly typed manner for some open ended use-case
post
Get a list of tenants with various metadata about the tenants for an institution
get
m.3) Wallet Reallocations
Do a reallocation
post
z.2) Visa Issuer Tokenisation
Check Eligibility for Tokenization
post
Retrieve Step-Up Methods for Tokenization
post
Send Passcode for Tokenization
post
Approve Provisioning for Tokenization
post
Token Notification
post
z.2) Visa Issuer Tokenization
The issuer to activate, resume, suspend, or delete the token, and perform other operations
post
Approve Provisioning for Tokenization
post
MCP Server
MCP
Powered by
Making your First API Call
Ask AI
