@utdk/mercury

Mercury API

Generated UTDK provider client for Mercury API. Streamline financial tasks with secure account management and transaction processing. Enables user registration, balance tracking, and payment handling.

Import sample

import mercury from "@utdk/mercury"

Factory sample

import { createMercuryClient } from "@utdk/mercury"

Provider path: mercury
Source API title: Mercury API
Version: 1.0.0
Generated: May 30, 2026, 6:16 PM
Homepage: Open site
API spec: View spec

README

Embedded directly from the package source.

mercury

Generated UTDK provider types and OpenAPI-backed client for https://dash.readme.com/api/v1/api-registry/ilz81omom1n4vx.

Operations

75 operations — open try-it console

Method	Operation ID	Path	Summary
GET	getAccount	/account/{accountId}	Get account by ID	Try
GET	getAccountCards	/account/{accountId}/cards	Get cards for account	Try
POST	requestSendMoney	/account/{accountId}/request-send-money	Request to send money	Try
GET	getAccountStatements	/account/{accountId}/statements	Get account statements	Try
GET	getTransaction	/account/{accountId}/transaction/{transactionId}	Get transaction by ID	Try
GET	listAccountTransactions	/account/{accountId}/transactions	List account transactions	Try
POST	createTransaction	/account/{accountId}/transactions	Send money to a recipient	Try
GET	getAccounts	/accounts	Get all accounts	Try
GET	getAttachment	/ar/attachments/{attachmentId}	Get an attachment	Try
GET	listCustomers	/ar/customers	List all customers	Try
POST	createCustomer	/ar/customers	Create a customer	Try
GET	getCustomer	/ar/customers/{customerId}	Get a customer	Try
POST	updateCustomer	/ar/customers/{customerId}	Update a customer	Try
DELETE	deleteCustomer	/ar/customers/{customerId}	Delete a customer	Try
GET	listInvoices	/ar/invoices	List all invoices	Try
POST	createInvoice	/ar/invoices	Create an invoice	Try
GET	getInvoice	/ar/invoices/{invoiceId}	Get an invoice	Try
POST	updateInvoice	/ar/invoices/{invoiceId}	Update an invoice	Try
GET	listInvoiceAttachments	/ar/invoices/{invoiceId}/attachments	List invoice attachments	Try
POST	cancelInvoice	/ar/invoices/{invoiceId}/cancel	Cancel an invoice	Try
GET	getInvoicePdf	/ar/invoices/{invoiceId}/pdf	Download invoice PDF	Try
GET	getBooksAgentCoaTemplate	/books/agent-coa-template/{coaTemplateId}	Retrieve a Chart of Accounts Template	Try
DELETE	deleteBooksAgentCoaTemplate	/books/agent-coa-template/{coaTemplateId}	Delete a Chart of Accounts Template	Try
GET	getBooksAgentCoaTemplates	/books/agent-coa-templates	List all Chart of Accounts Templates	Try
POST	postBooksAgentCoaTemplates	/books/agent-coa-templates	Create a Chart of Accounts Template	Try
PUT	putBooksAgentLedgerTemplate	/books/agent-ledger-template/{ledgerId}	Update a Ledger Template	Try
DELETE	deleteBooksAgentLedgerTemplate	/books/agent-ledger-template/{ledgerId}	Delete a Ledger Template	Try
POST	postBooksAgentLedgerTemplates	/books/agent-ledger-templates	Create a Ledger Template	Try
GET	getBooksJournalEntries	/books/journal-entries/{booksId}	List all journal entries	Try
POST	postBooksJournalEntries	/books/journal-entries/{booksId}	Create multiple Journal Entries	Try
PUT	putBooksJournalEntries	/books/journal-entries/{booksId}	Bulk update journal entries	Try
DELETE	deleteBooksJournalEntries	/books/journal-entries/{booksId}	Bulk delete journal entries	Try
GET	getBooksJournalEntry	/books/journal-entry/{booksId}/{journalEntryId}	Retrieve a Journal Entry	Try
GET	listCards	/cards	List cards	Try
POST	createCard	/cards	Create a card	Try
GET	getCard	/cards/{cardId}	Get a card	Try
POST	updateCard	/cards/{cardId}	Update a card	Try
POST	cancelCard	/cards/{cardId}/cancel	Cancel a card	Try
POST	freezeCard	/cards/{cardId}/freeze	Freeze a card	Try
POST	unfreezeCard	/cards/{cardId}/unfreeze	Unfreeze a card	Try
GET	listCategories	/categories	List all categories	Try
POST	createCategory	/categories/create	Create a new category	Try
POST	editCategory	/categories/{expenseCategoryId}/edit	Edit a category	Try
GET	listCredit	/credit	List all credit accounts	Try
GET	getEvents	/events	Get all events	Try
GET	getEvent	/events/{eventId}	Get event by ID	Try
GET	getOrganization	/organization	Get organization information	Try
GET	getRecipient	/recipient/{recipientId}	Get recipient by ID	Try
POST	updateRecipient	/recipient/{recipientId}	Edit information about a specific recipient	Try
POST	uploadRecipientAttachment	/recipient/{recipientId}/attachments	Upload a recipient attachment	Try
GET	getRecipients	/recipients	Get all recipients	Try
POST	createRecipient	/recipients	Add a new recipient	Try
GET	listRecipientsAttachments	/recipients/attachments	List all recipient attachments	Try
GET	listSendMoneyApprovalRequests	/request-send-money	List send money approval requests	Try
GET	getSendMoneyApprovalRequest	/request-send-money/{requestId}	Get send money approval request by ID	Try
GET	getSafeRequests	/safes	Get all SAFEs	Try
GET	getSafeRequest	/safes/{safeRequestId}	Get SAFE by ID	Try
GET	getSafeRequestDocument	/safes/{safeRequestId}/document	Download SAFE document	Try
GET	getStatementPdf	/statements/{statementId}/pdf	Download account statement PDF	Try
GET	getTransactionById	/transaction/{transactionId}	Get a transaction by ID	Try
PATCH	updateTransaction	/transaction/{transactionId}	Update transaction metadata	Try
POST	uploadTransactionAttachment	/transaction/{transactionId}/attachments	Upload a transaction attachment	Try
GET	listTransactions	/transactions	List all transactions	Try
POST	createInternalTransfer	/transfer	Create an internal transfer	Try
GET	getTreasury	/treasury	Get all treasury accounts	Try
GET	getTreasuryStatements	/treasury/{treasuryId}/statements	Get treasury account statements	Try
GET	getTreasuryTransactions	/treasury/{treasuryId}/transactions	Get treasury transactions	Try
GET	getUsers	/users	Get all users	Try
GET	getUser	/users/{userId}	Get user by ID	Try
GET	getWebhooks	/webhooks	Get webhook endpoints	Try
POST	createWebhook	/webhooks	Create a new webhook endpoint	Try
GET	getWebhook	/webhooks/{webhookEndpointId}	Get webhook endpoint by ID	Try
POST	updateWebhook	/webhooks/{webhookEndpointId}	Update an existing webhook endpoint	Try
DELETE	deleteWebhook	/webhooks/{webhookEndpointId}	Delete a webhook endpoint	Try
POST	verifyWebhook	/webhooks/{webhookEndpointId}/verify	Verify a webhook endpoint	Try