For AI agents: the docs index is at https://developer.eftcorp.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Eclipse | Developers
HomeIntegration GuidesAPIDiscussions
Log InEclipse | Developers
API
Log In
HomeIntegration GuidesAPIDiscussions

Getting Started

  • Making your First API Call

Eclipse ReST API

  • a) Authentication
    • Step-up an existing JWT with additional authput
    • Authenticate and obtain a JWTpost
    • Get a PKI login challengeget
    • Invalidate the token provided in the Authorization header or bodypost
    • Renew an existing JWTpost
    • Launch an external portal with a short-lived tokenpost
  • b) Tenant Configuration & Onboarding
    • List tenantsget
    • Register a new tenantpost
    • Update an existing tenantput
    • Get a tenant by IDget
    • List admin users for the tenantget
    • Create a tenant admin userpost
    • Update a tenant admin userput
    • Delete a tenant admin userdel
    • Get all config items for the tenantget
    • Add a config item for the tenantpost
    • Bulk update config items for the tenantpost
    • Update a config item for the tenantput
    • Get a specific config item for the tenantget
    • Delete a config item for the tenantdel
    • Get derived config items for the tenantget
    • Migrate data into a tenantpost
    • Execute a generic integration actionpost
    • Send a notification to customerspost
    • Generate QR codes for the tenantpost
    • Run a tenant report and return the resultget
    • List retail billing configs for the tenantget
    • Create a retail billing configpost
    • Update a retail billing config by IDput
    • Get a retail billing config by IDget
    • Delete a retail billing configdel
    • Create a subscription for an admin userpost
    • Get subscriptions for an admin userget
    • Manage session keys for terminalspost
    • List addresses for the tenantget
    • List wallets attached to the tenantget
    • Create a wallet for the tenantpost
    • Add an address for the tenantpost
    • Execute bulk wallet transfers from a tenant walletpost
    • List wallet logic sets for the tenantget
    • Create a wallet logic setpost
    • Update a wallet logic set by Idput
    • Get a wallet logic set by IDget
    • Delete wallet logic setdel
    • List wholesale billing configs for the tenantget
    • Create a wholesale billing configpost
    • Update a wholesale billing config by IDput
    • Get a wholesale billing config by IDget
    • Delete a wholesale billing configdel
    • Upload a batch file for the tenantpost
    • Get a batch by IDget
    • List portlets configured for the tenantget
    • Get a portlet by idget
  • b.1) State Publishing
    • Get all state publish configurationsget
    • Create a new state publish configurationpost
    • Update a state publish configurationput
    • Get a state publish configurationget
    • Delete a state publish configurationdel
  • c) Wallet Types & Configuration
    • List the tenant's wallet typesget
    • Create a new wallet typepost
    • Update a wallet typeput
    • Get a wallet type by IDget
    • Delete a wallet typedel
  • d) Customer Management
    • Search for customers in the tenantget
    • Check if a customer existshead
    • Register a new Customerpost
    • Update a customer profileput
    • Get a customer profileget
    • Delete a customer profiledel
    • Get a list of the customers addressesget
    • Add a new address for the customerpost
    • Get a list of the customers attachmentsget
    • Add a new attachment on the customerpost
    • Get the Customer Audit detailget
    • Get a customers beneficiariesget
    • Add a new beneficiary for the customerpost
    • Update a customers beneficiaryput
    • Get a customers beneficiary by beneficiaryIdget
    • Delete beneficiarydel
    • Get a customers cardsget
    • Issue a replacement or addon card to the customer for an existing card on their profilepost
    • Initiate adding a card on file for the customerpost
    • Get a customers cards on fileget
    • Update a customers cards on fileput
    • Get a customers cards on file by cardOnFileIdget
    • Delete card on filedel
    • Use a card on file in a HTTP request to a permitted partner APIpost
    • Get a list of the customers device fingerprintsget
    • Delete a device fingerprint for a customerdel
    • Send a message to the customers applicable device tokenpost
    • Get a customers device tokensget
    • Add a new device token for the customerpost
    • Get a specific device tokenget
    • Delete a specific device tokendel
    • Get list of the customers documentsget
    • Add a new document against the customerpost
    • Bulk update customers identitiesput
    • Check if a customer has any identitieshead
    • Get a list of the customers identitiesget
    • Create a username/password for a customerpost
    • Update a password for a customerput
    • Get a a specific customer identityget
    • Delete an identity for a customerdel
    • Get the fees that would be charged for a loanget
    • Get the limits that would be applicable for a loanget
    • Get all loan associated with the customerget
    • New loan for the customerpost
    • Initiate making a payment by a customerpost
    • Get a list of payments for the customerget
    • Get a list of positions held by the customerget
    • Add a position held by the customerpost
    • Delete a position held by a customer in an organisationdel
    • Run a KYC algorithm on the customers profile to update the KYC statuspost
    • Get the ratify results for the customerget
    • Get a list of the customers security questionsget
    • Delete all security questions for a customerdel
    • Add new security questions for the customerpost
    • Delete a security question for a customerdel
    • Remove all sessions so the customer has to login againdel
    • Get a list of allowed wallet types for a customerget
    • 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 scenarioget
    • Create a new Wallet for the customerpost
    • Opt-In the customer for the loanspost
    • Opt-out the customer for the loanspost
  • d) Customer Management V2
    • Run KYC ratification on a customerpost
    • List KYC ratification results for a customerget
  • e) Organisation Management
    • Search for organisationsget
    • Register a new organisationpost
    • Update an organisation by IDput
    • Get an organisation by IDget
    • Delete an organisationdel
    • List organisation addressesget
    • Add a new address for the organisationpost
    • Get a list of the organisation's attachmentsget
    • Add an attachment to the organisationpost
    • List organisation documentsget
    • List beneficiaries for the organisationget
    • Add a document to the organisationpost
    • Add a beneficiary to the organisationpost
    • Initiate a payment from the organisationpost
    • Update an organisation's beneficiaryput
    • List payments for the organisationget
    • Get an organisation's beneficiary by IDget
    • List positions held in the organisationget
    • Delete a beneficiary from the organisationdel
    • Add a position in the organisationpost
    • Remove a customer's position in the organisationdel
    • Run KYB ratification on the organisationpost
    • Get KYB ratification results for the organisationget
    • List stores for the organisationget
    • Run an organisation report and return the resultget
    • Add a store to the organisationpost
    • List organisation cash payment historyget
    • Update a storeput
    • Delete a storedel
    • List terminals for the organisationget
    • Add a terminal to the organisationpost
    • Update a terminalput
    • Enroll a terminalpost
    • List allowed wallet types for the organisationget
    • List wallets for the organisationget
    • Create a wallet for the organisationpost
    • Initiate adding a card on file for the organisationpost
    • List cards on file for the organisationget
    • Update an organisation's card on fileput
    • Get an organisation's card on file by IDget
    • Delete a card on file from the organisationdel
    • Run KYB ratification on the organisationpost
    • Get KYB ratification results for the organisationget
    • Get a list of the organisation's divisionsget
    • Add a new division to the organisationpost
    • Partially update a storepatch
    • Partially update a terminalpatch
  • e.1) Division Management
    • Update a division by divisionIdput
    • Get a division by divisionIdget
    • Delete a division by divisionIddel
  • f) Address Management
    • Update an address by IDput
    • Get an address by IDget
    • Delete an address by IDdel
  • g) Document Management
    • Update a document by IDput
    • Get a document by IDget
    • Delete a document by IDdel
    • Generate a tenant-branded documentpost
  • h) Wallets
    • Search for wallets in a tenantget
    • Submit bulk wallet transferspost
    • Get bulk transfer statusget
    • Update a wallet by walletIdput
    • Get wallet by walletIdget
    • Delete a wallet by walletIddel
    • Get a list of the wallets attachmentsget
    • Add a new attachment on the walletpost
    • Get the Wallet Audit detailget
    • Create a new QRCodes linked to the wallet in bulkpost
    • Do a set of inter account transfers from the walletpost
    • Get cards linked to the walletget
    • Create a card linked to the existing walletpost
    • Get transaction limits applicable for given walletget
    • Get payments made by or accepted into the walletget
    • 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 walletpost
    • Unlink the QRCode from the walletdel
    • Get wallets transactionsget
    • Mark transaction as fraudpatch
    • Get the fees that would be charged on source wallet for P2P transferget
    • Get proxies linked to the walletget
    • Create a new proxy linked to the walletpost
    • Update Proxyput
    • Unlink the proxy from the walletdel
    • Create a new proxy linked to the walletget
    • Search wallet transactions across a tenantget
  • i) Card Management
    • Search for cards in the tenantget
    • Update a card by IDput
    • Get a card by IDget
    • Set or deliver a new card PINpost
    • List card transaction activitiesget
    • List issuer card tokensget
    • Update a token card detailsput
    • Update a token statusput
    • Get issuer card token detailsget
    • Unlink a carddel
    • Reprocess a 0120/0220 card activity record.post
  • i.1) Card Provisioning
    • Initiate card push provisioningpost
    • List eligible token requestors for a cardget
    • Get a card provisioning record by IDget
    • Delete a card provisioning record by IDdel
  • i.2) Proxy Card Management
    • Update spend limits for a card programput
    • Get spend limits for a card programget
    • Block or reactivate a proxy cardput
    • Get proxy card status and detailsget
    • Activate a newly issued physical cardpost
    • Link an account to a proxy cardpost
    • Get accounts linked to a proxy cardget
    • Update a linked account on a proxy cardput
    • Unlink an account from a proxy carddel
    • Update spend limits for a proxy cardput
    • List activities for a proxy cardget
    • Get spend limits for a proxy cardget
    • Issue a new PIN for a proxy cardpost
    • Change or reset a proxy card PINput
    • Validate a proxy card PINpost
    • Get balance for a linked accountget
    • Get mini-statement for a linked accountget
    • Get proxy card balanceget
    • Get proxy card mini-statementget
    • Initiate a proxy card transactionpost
    • Returns a list of proxy cards based on the provided search criteria, such as idNumber or accountNumberget
  • j) Wallet QRCodes
    • Get QR code details by query parameterget
    • Bulk-update QR codes linked to the walletpost
    • Update QR code amount, reference or descriptionput
    • Get QR code details by codeget
  • k) Wallet Topups
    • List top-ups for a walletget
    • Initiate a new wallet top-uppost
    • Update a top-up statusput
    • Get a top-up by IDget
  • l) Wallet Withdrawals
    • Initiate a new withdrawalpost
    • List withdrawals for a walletget
    • Calculate withdrawal feeget
    • Get applicable withdrawal limitsget
    • Update a withdrawalput
    • Get a withdrawal by IDget
  • o) Wallet Bundles
  • m.1) Wallet Transfers
    • Transfer funds between walletspost
  • m.2) Wallet Reversals
    • Reverse a wallet session's transactionspost
  • m.3) Wallet Reallocations
    • Reallocate transactions by session IDpost
  • n) Wallet Reservations
    • List reservations for a walletget
    • Create a wallet reservationpost
    • Get a wallet reservation by IDget
    • Cancel a wallet reservationdel
    • Create multiple wallet reservations atomicallypost
  • p) VAS Functionality
    • List VAS partner catalogs for a tenantget
    • Get VAS partner by mobile numberget
  • q) Payments
    • Initiate a new paymentpost
    • List payments for the tenantget
    • Update a paymentput
    • Get a payment by IDget
    • Get proof of paymentget
    • Initiate a payment refundpost
    • List refunds for a paymentget
    • Get a refund by IDget
  • q.1) Fraud
    • Publish fraud event to third partypost
  • r) Wallet Cross Border Remittances
    • Retrieve remittance catalogsget
    • Update a customer's remittance enrollmentput
    • Enroll a customer with a remittance providerpost
    • Get customer remittance enrollment statusget
    • Get an exchange rate quote for remittancepost
    • Initiate a cross-border remittancepost
    • List cross-border remittances for a walletget
    • Update a wallet remittanceput
    • Get a remittance by IDget
  • s) Attachment Management
    • Get derived attachment typesget
    • Update an attachment by IDput
    • Get an attachment by IDget
    • Delete an attachment by IDdel
  • t) Rewards exchange
    • Initiate a reward exchangepost
    • List rewards for a walletget
    • Redeem a rewardput
    • Get a reward by IDget
  • u) Loan Functionality
    • List available loan catalogsget
    • Update a loanput
    • Get a loan by IDget
    • Get loan transactionsget
    • Make a loan repaymentpost
  • v) POS Terminals & Types & Configuration
    • List terminal types for a tenantget
    • Create a terminal typepost
    • Update a terminal type by IDput
    • Get a terminal type by IDget
    • Delete a terminal type by IDdel
    • Enroll a terminal for the current userpost
    • Get a terminal by IDget
    • Delete a terminaldel
    • Enroll a terminal at the tenant levelpost
    • Get a terminal by external identifierget
    • Get stores by external mappingget
  • w) Scheduled Jobs
    • List scheduled jobs for a tenantget
    • Create a scheduled jobpost
    • Update scheduled jobput
    • Get details of a scheduled jobget
    • Delete a scheduled jobdel
  • w.1) Job Schedules
    • Get all job schedulesget
    • Update a job scheduleput
    • Get a job schedule by IDget
  • x) Accounts
    • List accounts for an organisationget
    • Create a new account for an organisationpost
    • Update an account by IDput
    • Get an account by IDget
    • Delete accountdel
    • Get account transaction historyget
    • List sales for an accountget
    • Add a new salepost
    • Update a saleput
    • Get a sale by IDget
    • Transition a sale via an eventpost
    • Regenerate a sales invoiceput
    • Retrieve a sales invoiceget
    • List products for an organisationget
    • Create a new productpost
    • Update a productput
    • Get a product by IDget
    • Delete a productdel
    • Find sales with or without an account IDget
    • List product items for a tenantget
    • List products for a tenantget
    • Create a productpost
    • Update a productput
    • Get a product by IDget
    • Delete a productdel
  • y) Supplier Management
    • Search for suppliersget
    • Register a new supplierpost
    • Update a supplierput
    • Get a supplier by IDget
    • Delete a supplierdel
  • z) Global Functionality
    • List global admin usersget
    • Create a global admin userpost
    • Update a global admin userput
    • Delete a global admin userdel
    • Validate a device attestation noncepost
    • Get the attestation nonce for a deviceget
    • Upload batchpost
    • Search for batchesget
    • Update batch statusput
    • Download a batch file as CSVget
    • Delete a batch by IDdel
    • Look up card BIN informationget
    • Execute a batch of wallet transferspost
    • Flush configuration cachespost
    • List global callbacksget
    • Update a callbackput
    • Convert a document formatpost
    • Download a file using a pre-signed URLget
    • Check if given identity existshead
    • Change a customer's passwordpost
    • Initiate a password change via OTPpost
    • Initiate 3DS authenticationpost
    • Send a global notificationpost
    • List cross-tenant paymentsget
    • Update a global paymentput
    • List pending KYC ratification resultsget
    • Manually verify a KYC ratification resultput
    • Get the current server timeget
    • Simulate an ISO 8583 transaction messagepost
    • List tasks by initiator, approver, or executorget
    • Update a taskput
    • Add a log entry to a distributed tracepost
    • Send an OTP to a customerpost
    • Verify an OTP or security question answersget
    • Search for a wallet across all tenantsget
    • Add a customer to the fraud agency watchlistpost
    • Get the value of a publicly available global config valueget
    • Create a portletpost
    • Search for portletsget
    • Create portlet state for the calling userpost
    • Update portlet stateput
    • Get portlet state by IDget
    • Delete portlet statedel
    • Update a portletput
    • Get a portlet by IDget
    • Delete a portletdel
    • Update a SQL statisticput
    • Get a SQL statistic by IDget
    • Delete a SQL statisticdel
    • Get a portlet source by name/idget
    • Get a global paymentget
    • Get a global admin userget
    • Broadcast a service discovery eventpost
    • Get a task by IDget
    • Search wallet transactions across tenantsget
  • z) Global Functionality V2
    • List pending KYC ratification resultsget
    • Manually verify a KYC ratification resultput
  • z.1) Institution Level Management
    • Search for customers in the institutionget
    • Get a customer profileget
    • Get metrics for an institutionget
    • Bulk update customer wallet status within an institutionput
    • Run a generic integration for an institutionpost
    • Get a list of tenants with various metadata about the tenants for an institutionget
    • Get the golden customer for an institutionget
  • z.2) Visa Issuer Tokenization
    • Check card eligibility for tokenisationpost
    • Retrieve available step-up authentication methodspost
    • Send a step-up passcode to the cardholderpost
    • Bind a device to a card tokenpost
    • Approve token provisioning for a cardpost
    • Process a token lifecycle notificationpost
  • z.3) MDES Issuer Tokenization
    • Authorize a Mastercard service request (e.g. digitization)post
    • Receive the Activation Code (and chosen activation method) for a token so it can be relayed to the Cardholder.post
    • Receive notifications that the provisioning and activation of a token.post
    • Receive notification of suspicious activity detected by MDES during MCBP replenishment for a device-based Cloud token.post
    • Notify the Issuer of significant token updates, such as when the token is suspended, unsuspended or deleted or bound by the TAF/TAS service.post
    • Request activation methods for a Mastercard tokenizationpost
  • z.3) SQL Statistics
    • Get all SQL statisticsget
    • Create a SQL statisticpost
  • z.4) Alerts
    • Search alertsget
    • Apply one action to many alertspost
    • Replace the deduplication rulesput
    • Get the deduplication rulesget
    • Try a message against the deduplication rulespost
    • Link or unlink duplicate alertspost
    • Replace the ownership rotaput
    • Get the ownership rotaget
    • Re-shape alerts and rebuild their duplicate linkspost
    • Summarise alertsget
    • Get an alertget
    • Get every occurrence of the same faultget
    • Act on an alertpost
    • Raise an alertpost

MCP Server

  • MCP
Powered by 

o) Wallet Bundles

Updated about 1 year ago


Get a withdrawal by ID
m.1) Wallet Transfers
Did this page help you?

Updated about 1 year ago


Get a withdrawal by ID
m.1) Wallet Transfers
Did this page help you?