api.md

ModernTreasury

Types:

• PingResponse

Methods:

• client.ping() -> PingResponse

Shared

Types:

• AccountsType
• AsyncResponse
• Currency
• TransactionDirection

Connections

Types:

• Connection

Methods:

• client.connections.list({ ...params }) -> ConnectionsPage

Counterparties

Types:

• Counterparty
• CounterpartyCollectAccountResponse

Methods:

• client.counterparties.create({ ...params }) -> Counterparty
• client.counterparties.retrieve(id) -> Counterparty
• client.counterparties.update(id, { ...params }) -> Counterparty
• client.counterparties.list({ ...params }) -> CounterpartiesPage
• client.counterparties.del(id) -> void
• client.counterparties.collectAccount(id, { ...params }) -> CounterpartyCollectAccountResponse

Events

Types:

• Event

Methods:

• client.events.retrieve(id) -> Event
• client.events.list({ ...params }) -> EventsPage

ExpectedPayments

Types:

• ExpectedPayment
• ExpectedPaymentType

Methods:

• client.expectedPayments.create({ ...params }) -> ExpectedPayment
• client.expectedPayments.retrieve(id) -> ExpectedPayment
• client.expectedPayments.update(id, { ...params }) -> ExpectedPayment
• client.expectedPayments.list({ ...params }) -> ExpectedPaymentsPage
• client.expectedPayments.del(id) -> ExpectedPayment

ExternalAccounts

Types:

• ExternalAccount
• ExternalAccountType
• ExternalAccountVerifyResponse

Methods:

• client.externalAccounts.create({ ...params }) -> ExternalAccount
• client.externalAccounts.retrieve(id) -> ExternalAccount
• client.externalAccounts.update(id, { ...params }) -> ExternalAccount
• client.externalAccounts.list({ ...params }) -> ExternalAccountsPage
• client.externalAccounts.del(id) -> void
• client.externalAccounts.completeVerification(id, { ...params }) -> ExternalAccount
• client.externalAccounts.verify(id, { ...params }) -> ExternalAccountVerifyResponse

IncomingPaymentDetails

Types:

• IncomingPaymentDetail

Methods:

• client.incomingPaymentDetails.retrieve(id) -> IncomingPaymentDetail
• client.incomingPaymentDetails.update(id, { ...params }) -> IncomingPaymentDetail
• client.incomingPaymentDetails.list({ ...params }) -> IncomingPaymentDetailsPage
• client.incomingPaymentDetails.createAsync({ ...params }) -> AsyncResponse

Invoices

Types:

• Invoice

Methods:

• client.invoices.create({ ...params }) -> Invoice
• client.invoices.retrieve(id) -> Invoice
• client.invoices.update(id, { ...params }) -> Invoice
• client.invoices.list({ ...params }) -> InvoicesPage
• client.invoices.addPaymentOrder(id, paymentOrderId) -> void

LineItems

Types:

• InvoiceLineItem

Methods:

• client.invoices.lineItems.create(invoiceId, { ...params }) -> InvoiceLineItem
• client.invoices.lineItems.retrieve(invoiceId, id) -> InvoiceLineItem
• client.invoices.lineItems.update(invoiceId, id, { ...params }) -> InvoiceLineItem
• client.invoices.lineItems.list(invoiceId, { ...params }) -> InvoiceLineItemsPage
• client.invoices.lineItems.del(invoiceId, id) -> InvoiceLineItem

Documents

Types:

• Document

Methods:

• client.documents.create({ ...params }) -> Document
• client.documents.retrieve(id) -> Document
• client.documents.list({ ...params }) -> DocumentsPage

AccountCollectionFlows

Types:

• AccountCollectionFlow

Methods:

• client.accountCollectionFlows.create({ ...params }) -> AccountCollectionFlow
• client.accountCollectionFlows.retrieve(id) -> AccountCollectionFlow
• client.accountCollectionFlows.update(id, { ...params }) -> AccountCollectionFlow
• client.accountCollectionFlows.list({ ...params }) -> AccountCollectionFlowsPage

AccountDetails

Types:

• AccountDetail

Methods:

• client.accountDetails.create(accountsType, accountId, { ...params }) -> AccountDetail
• client.accountDetails.retrieve(accountsType, accountId, id) -> AccountDetail
• client.accountDetails.list(accountsType, accountId, { ...params }) -> AccountDetailsPage
• client.accountDetails.del(accountsType, accountId, id) -> void

RoutingDetails

Types:

• RoutingDetail

Methods:

• client.routingDetails.create(accountsType, accountId, { ...params }) -> RoutingDetail
• client.routingDetails.retrieve(accountsType, accountId, id) -> RoutingDetail
• client.routingDetails.list(accountsType, accountId, { ...params }) -> RoutingDetailsPage
• client.routingDetails.del(accountsType, accountId, id) -> void

InternalAccounts

Types:

• InternalAccount

Methods:

• client.internalAccounts.create({ ...params }) -> InternalAccount
• client.internalAccounts.retrieve(id) -> InternalAccount
• client.internalAccounts.update(id, { ...params }) -> InternalAccount
• client.internalAccounts.list({ ...params }) -> InternalAccountsPage

BalanceReports

Types:

• BalanceReport

Methods:

• client.internalAccounts.balanceReports.create(internalAccountId, { ...params }) -> BalanceReport
• client.internalAccounts.balanceReports.retrieve(internalAccountId, id) -> BalanceReport
• client.internalAccounts.balanceReports.list(internalAccountId, { ...params }) -> BalanceReportsPage
• client.internalAccounts.balanceReports.del(internalAccountId, id) -> void

Ledgers

Types:

• Ledger

Methods:

• client.ledgers.create({ ...params }) -> Ledger
• client.ledgers.retrieve(id) -> Ledger
• client.ledgers.update(id, { ...params }) -> Ledger
• client.ledgers.list({ ...params }) -> LedgersPage
• client.ledgers.del(id) -> Ledger

LedgerableEvents

Types:

• LedgerableEvent

Methods:

• client.ledgerableEvents.create({ ...params }) -> LedgerableEvent
• client.ledgerableEvents.retrieve(id) -> LedgerableEvent

LedgerAccountCategories

Types:

• LedgerAccountCategory

Methods:

• client.ledgerAccountCategories.create({ ...params }) -> LedgerAccountCategory
• client.ledgerAccountCategories.retrieve(id, { ...params }) -> LedgerAccountCategory
• client.ledgerAccountCategories.update(id, { ...params }) -> LedgerAccountCategory
• client.ledgerAccountCategories.list({ ...params }) -> LedgerAccountCategoriesPage
• client.ledgerAccountCategories.del(id) -> LedgerAccountCategory
• client.ledgerAccountCategories.addLedgerAccount(id, ledgerAccountId) -> void
• client.ledgerAccountCategories.addNestedCategory(id, subCategoryId) -> void
• client.ledgerAccountCategories.removeLedgerAccount(id, ledgerAccountId) -> void
• client.ledgerAccountCategories.removeNestedCategory(id, subCategoryId) -> void

LedgerAccounts

Types:

• LedgerAccount

Methods:

• client.ledgerAccounts.create({ ...params }) -> LedgerAccount
• client.ledgerAccounts.retrieve(id, { ...params }) -> LedgerAccount
• client.ledgerAccounts.update(id, { ...params }) -> LedgerAccount
• client.ledgerAccounts.list({ ...params }) -> LedgerAccountsPage
• client.ledgerAccounts.del(id) -> LedgerAccount

LedgerAccountBalanceMonitors

Types:

• LedgerAccountBalanceMonitor

Methods:

• client.ledgerAccountBalanceMonitors.create({ ...params }) -> LedgerAccountBalanceMonitor
• client.ledgerAccountBalanceMonitors.retrieve(id) -> LedgerAccountBalanceMonitor
• client.ledgerAccountBalanceMonitors.update(id, { ...params }) -> LedgerAccountBalanceMonitor
• client.ledgerAccountBalanceMonitors.list({ ...params }) -> LedgerAccountBalanceMonitorsPage
• client.ledgerAccountBalanceMonitors.del(id) -> LedgerAccountBalanceMonitor

LedgerAccountStatements

Types:

• LedgerAccountStatementCreateResponse
• LedgerAccountStatementRetrieveResponse

Methods:

• client.ledgerAccountStatements.create({ ...params }) -> LedgerAccountStatementCreateResponse
• client.ledgerAccountStatements.retrieve(id) -> LedgerAccountStatementRetrieveResponse

LedgerEntries

Types:

• LedgerEntry

Methods:

• client.ledgerEntries.retrieve(id, { ...params }) -> LedgerEntry
• client.ledgerEntries.update(id, { ...params }) -> LedgerEntry
• client.ledgerEntries.list({ ...params }) -> LedgerEntriesPage

LedgerEventHandlers

Types:

• LedgerEventHandler
• LedgerEventHandlerVariable

Methods:

• client.ledgerEventHandlers.create({ ...params }) -> LedgerEventHandler
• client.ledgerEventHandlers.retrieve(id) -> LedgerEventHandler
• client.ledgerEventHandlers.list({ ...params }) -> LedgerEventHandlersPage
• client.ledgerEventHandlers.del(id) -> LedgerEventHandler

LedgerTransactions

Types:

• LedgerTransaction

Methods:

• client.ledgerTransactions.create({ ...params }) -> LedgerTransaction
• client.ledgerTransactions.retrieve(id) -> LedgerTransaction
• client.ledgerTransactions.update(id, { ...params }) -> LedgerTransaction
• client.ledgerTransactions.list({ ...params }) -> LedgerTransactionsPage
• client.ledgerTransactions.createReversal(id, { ...params }) -> LedgerTransaction

Versions

Types:

• LedgerTransactionVersion

Methods:

• client.ledgerTransactions.versions.list({ ...params }) -> LedgerTransactionVersionsPage

LineItems

Types:

• LineItem

Methods:

• client.lineItems.retrieve(itemizableType, itemizableId, id) -> LineItem
• client.lineItems.update(itemizableType, itemizableId, id, { ...params }) -> LineItem
• client.lineItems.list(itemizableType, itemizableId, { ...params }) -> LineItemsPage

PaymentFlows

Types:

• PaymentFlow

Methods:

• client.paymentFlows.create({ ...params }) -> PaymentFlow
• client.paymentFlows.retrieve(id) -> PaymentFlow
• client.paymentFlows.update(id, { ...params }) -> PaymentFlow
• client.paymentFlows.list({ ...params }) -> PaymentFlowsPage

PaymentOrders

Types:

• PaymentOrder
• PaymentOrderSubtype
• PaymentOrderType

Methods:

• client.paymentOrders.create({ ...params }) -> PaymentOrder
• client.paymentOrders.retrieve(id) -> PaymentOrder
• client.paymentOrders.update(id, { ...params }) -> PaymentOrder
• client.paymentOrders.list({ ...params }) -> PaymentOrdersPage
• client.paymentOrders.createAsync({ ...params }) -> AsyncResponse

Reversals

Types:

• Reversal

Methods:

• client.paymentOrders.reversals.create(paymentOrderId, { ...params }) -> Reversal
• client.paymentOrders.reversals.retrieve(paymentOrderId, reversalId) -> Reversal
• client.paymentOrders.reversals.list(paymentOrderId, { ...params }) -> ReversalsPage

PaymentReferences

Types:

• PaymentReference

Methods:

• client.paymentReferences.retrieve(id) -> PaymentReference
• client.paymentReferences.list({ ...params }) -> PaymentReferencesPage

Returns

Types:

• ReturnObject

Methods:

• client.returns.create({ ...params }) -> ReturnObject
• client.returns.retrieve(id) -> ReturnObject
• client.returns.list({ ...params }) -> ReturnObjectsPage

Transactions

Types:

• Transaction

Methods:

• client.transactions.create({ ...params }) -> Transaction
• client.transactions.retrieve(id) -> Transaction
• client.transactions.update(id, { ...params }) -> Transaction
• client.transactions.list({ ...params }) -> TransactionsPage
• client.transactions.del(id) -> void

LineItems

Types:

• TransactionLineItem

Methods:

• client.transactions.lineItems.create({ ...params }) -> TransactionLineItem
• client.transactions.lineItems.retrieve(id) -> TransactionLineItem
• client.transactions.lineItems.list({ ...params }) -> TransactionLineItemsPage
• client.transactions.lineItems.del(id) -> void

Validations

Types:

• RoutingNumberLookupRequest

Methods:

• client.validations.validateRoutingNumber({ ...params }) -> RoutingNumberLookupRequest

PaperItems

Types:

• PaperItem

Methods:

• client.paperItems.retrieve(id) -> PaperItem
• client.paperItems.list({ ...params }) -> PaperItemsPage

Webhooks

Methods:

• client.webhooks.getSignature(payload, opts?) -> string
• client.webhooks.validateSignature(payload, headers, opts?) -> boolean

VirtualAccounts

Types:

• VirtualAccount

Methods:

• client.virtualAccounts.create({ ...params }) -> VirtualAccount
• client.virtualAccounts.retrieve(id) -> VirtualAccount
• client.virtualAccounts.update(id, { ...params }) -> VirtualAccount
• client.virtualAccounts.list({ ...params }) -> VirtualAccountsPage
• client.virtualAccounts.del(id) -> VirtualAccount

BulkRequests

Types:

• BulkRequest

Methods:

• client.bulkRequests.create({ ...params }) -> BulkRequest
• client.bulkRequests.retrieve(id) -> BulkRequest
• client.bulkRequests.list({ ...params }) -> BulkRequestsPage

BulkResults

Types:

• BulkResult

Methods:

• client.bulkResults.retrieve(id) -> BulkResult
• client.bulkResults.list({ ...params }) -> BulkResultsPage

LedgerAccountSettlements

Types:

• LedgerAccountSettlement

Methods:

• client.ledgerAccountSettlements.create({ ...params }) -> LedgerAccountSettlement
• client.ledgerAccountSettlements.retrieve(id) -> LedgerAccountSettlement
• client.ledgerAccountSettlements.update(id, { ...params }) -> LedgerAccountSettlement
• client.ledgerAccountSettlements.list({ ...params }) -> LedgerAccountSettlementsPage

ForeignExchangeQuotes

Types:

• ForeignExchangeQuote

Methods:

• client.foreignExchangeQuotes.create({ ...params }) -> ForeignExchangeQuote
• client.foreignExchangeQuotes.retrieve(id) -> ForeignExchangeQuote
• client.foreignExchangeQuotes.list({ ...params }) -> ForeignExchangeQuotesPage

ConnectionLegalEntities

Types:

• ConnectionLegalEntity

Methods:

• client.connectionLegalEntities.create({ ...params }) -> ConnectionLegalEntity
• client.connectionLegalEntities.retrieve(id) -> ConnectionLegalEntity
• client.connectionLegalEntities.update(id, { ...params }) -> ConnectionLegalEntity
• client.connectionLegalEntities.list({ ...params }) -> ConnectionLegalEntitiesPage

LegalEntities

Types:

• LegalEntity

Methods:

• client.legalEntities.create({ ...params }) -> LegalEntity
• client.legalEntities.retrieve(id) -> LegalEntity
• client.legalEntities.update(id, { ...params }) -> LegalEntity
• client.legalEntities.list({ ...params }) -> LegalEntitiesPage

LegalEntityAssociations

Types:

• LegalEntityAssociation

Methods:

• client.legalEntityAssociations.create({ ...params }) -> LegalEntityAssociation