api.md

Accounts

Types:

• Account
• BalanceLookup

Methods:

• client.accounts.create({ ...params }) -> Account
• client.accounts.retrieve(accountId) -> Account
• client.accounts.update(accountId, { ...params }) -> Account
• client.accounts.list({ ...params }) -> AccountsPage
• client.accounts.balance(accountId, { ...params }) -> BalanceLookup
• client.accounts.close(accountId) -> Account

AccountNumbers

Types:

• AccountNumber

Methods:

• client.accountNumbers.create({ ...params }) -> AccountNumber
• client.accountNumbers.retrieve(accountNumberId) -> AccountNumber
• client.accountNumbers.update(accountNumberId, { ...params }) -> AccountNumber
• client.accountNumbers.list({ ...params }) -> AccountNumbersPage

Cards

Types:

• Card
• CardDetails

Methods:

• client.cards.create({ ...params }) -> Card
• client.cards.retrieve(cardId) -> Card
• client.cards.update(cardId, { ...params }) -> Card
• client.cards.list({ ...params }) -> CardsPage
• client.cards.details(cardId) -> CardDetails

CardPayments

Types:

• CardPayment

Methods:

• client.cardPayments.retrieve(cardPaymentId) -> CardPayment
• client.cardPayments.list({ ...params }) -> CardPaymentsPage

CardPurchaseSupplements

Types:

• CardPurchaseSupplement

Methods:

• client.cardPurchaseSupplements.retrieve(cardPurchaseSupplementId) -> CardPurchaseSupplement
• client.cardPurchaseSupplements.list({ ...params }) -> CardPurchaseSupplementsPage

CardDisputes

Types:

• CardDispute

Methods:

• client.cardDisputes.create({ ...params }) -> CardDispute
• client.cardDisputes.retrieve(cardDisputeId) -> CardDispute
• client.cardDisputes.list({ ...params }) -> CardDisputesPage

PhysicalCards

Types:

• PhysicalCard

Methods:

• client.physicalCards.create({ ...params }) -> PhysicalCard
• client.physicalCards.retrieve(physicalCardId) -> PhysicalCard
• client.physicalCards.update(physicalCardId, { ...params }) -> PhysicalCard
• client.physicalCards.list({ ...params }) -> PhysicalCardsPage

DigitalCardProfiles

Types:

• DigitalCardProfile

Methods:

• client.digitalCardProfiles.create({ ...params }) -> DigitalCardProfile
• client.digitalCardProfiles.retrieve(digitalCardProfileId) -> DigitalCardProfile
• client.digitalCardProfiles.list({ ...params }) -> DigitalCardProfilesPage
• client.digitalCardProfiles.archive(digitalCardProfileId) -> DigitalCardProfile
• client.digitalCardProfiles.clone(digitalCardProfileId, { ...params }) -> DigitalCardProfile

PhysicalCardProfiles

Types:

• PhysicalCardProfile

Methods:

• client.physicalCardProfiles.create({ ...params }) -> PhysicalCardProfile
• client.physicalCardProfiles.retrieve(physicalCardProfileId) -> PhysicalCardProfile
• client.physicalCardProfiles.list({ ...params }) -> PhysicalCardProfilesPage
• client.physicalCardProfiles.archive(physicalCardProfileId) -> PhysicalCardProfile
• client.physicalCardProfiles.clone(physicalCardProfileId, { ...params }) -> PhysicalCardProfile

DigitalWalletTokens

Types:

• DigitalWalletToken

Methods:

• client.digitalWalletTokens.retrieve(digitalWalletTokenId) -> DigitalWalletToken
• client.digitalWalletTokens.list({ ...params }) -> DigitalWalletTokensPage

Transactions

Types:

• Transaction

Methods:

• client.transactions.retrieve(transactionId) -> Transaction
• client.transactions.list({ ...params }) -> TransactionsPage

PendingTransactions

Types:

• PendingTransaction

Methods:

• client.pendingTransactions.retrieve(pendingTransactionId) -> PendingTransaction
• client.pendingTransactions.list({ ...params }) -> PendingTransactionsPage

DeclinedTransactions

Types:

• DeclinedTransaction

Methods:

• client.declinedTransactions.retrieve(declinedTransactionId) -> DeclinedTransaction
• client.declinedTransactions.list({ ...params }) -> DeclinedTransactionsPage

AccountTransfers

Types:

• AccountTransfer

Methods:

• client.accountTransfers.create({ ...params }) -> AccountTransfer
• client.accountTransfers.retrieve(accountTransferId) -> AccountTransfer
• client.accountTransfers.list({ ...params }) -> AccountTransfersPage
• client.accountTransfers.approve(accountTransferId) -> AccountTransfer
• client.accountTransfers.cancel(accountTransferId) -> AccountTransfer

ACHTransfers

Types:

• ACHTransfer

Methods:

• client.achTransfers.create({ ...params }) -> ACHTransfer
• client.achTransfers.retrieve(achTransferId) -> ACHTransfer
• client.achTransfers.list({ ...params }) -> ACHTransfersPage
• client.achTransfers.approve(achTransferId) -> ACHTransfer
• client.achTransfers.cancel(achTransferId) -> ACHTransfer

ACHPrenotifications

Types:

• ACHPrenotification

Methods:

• client.achPrenotifications.create({ ...params }) -> ACHPrenotification
• client.achPrenotifications.retrieve(achPrenotificationId) -> ACHPrenotification
• client.achPrenotifications.list({ ...params }) -> ACHPrenotificationsPage

InboundACHTransfers

Types:

• InboundACHTransfer

Methods:

• client.inboundACHTransfers.retrieve(inboundACHTransferId) -> InboundACHTransfer
• client.inboundACHTransfers.list({ ...params }) -> InboundACHTransfersPage
• client.inboundACHTransfers.createNotificationOfChange(inboundACHTransferId, { ...params }) -> InboundACHTransfer
• client.inboundACHTransfers.decline(inboundACHTransferId, { ...params }) -> InboundACHTransfer
• client.inboundACHTransfers.transferReturn(inboundACHTransferId, { ...params }) -> InboundACHTransfer

WireTransfers

Types:

• WireTransfer

Methods:

• client.wireTransfers.create({ ...params }) -> WireTransfer
• client.wireTransfers.retrieve(wireTransferId) -> WireTransfer
• client.wireTransfers.list({ ...params }) -> WireTransfersPage
• client.wireTransfers.approve(wireTransferId) -> WireTransfer
• client.wireTransfers.cancel(wireTransferId) -> WireTransfer

InboundWireTransfers

Types:

• InboundWireTransfer

Methods:

• client.inboundWireTransfers.retrieve(inboundWireTransferId) -> InboundWireTransfer
• client.inboundWireTransfers.list({ ...params }) -> InboundWireTransfersPage

WireDrawdownRequests

Types:

• WireDrawdownRequest

Methods:

• client.wireDrawdownRequests.create({ ...params }) -> WireDrawdownRequest
• client.wireDrawdownRequests.retrieve(wireDrawdownRequestId) -> WireDrawdownRequest
• client.wireDrawdownRequests.list({ ...params }) -> WireDrawdownRequestsPage

InboundWireDrawdownRequests

Types:

• InboundWireDrawdownRequest

Methods:

• client.inboundWireDrawdownRequests.retrieve(inboundWireDrawdownRequestId) -> InboundWireDrawdownRequest
• client.inboundWireDrawdownRequests.list({ ...params }) -> InboundWireDrawdownRequestsPage

CheckTransfers

Types:

• CheckTransfer

Methods:

• client.checkTransfers.create({ ...params }) -> CheckTransfer
• client.checkTransfers.retrieve(checkTransferId) -> CheckTransfer
• client.checkTransfers.list({ ...params }) -> CheckTransfersPage
• client.checkTransfers.approve(checkTransferId) -> CheckTransfer
• client.checkTransfers.cancel(checkTransferId) -> CheckTransfer
• client.checkTransfers.stopPayment(checkTransferId, { ...params }) -> CheckTransfer

InboundCheckDeposits

Types:

• InboundCheckDeposit

Methods:

• client.inboundCheckDeposits.retrieve(inboundCheckDepositId) -> InboundCheckDeposit
• client.inboundCheckDeposits.list({ ...params }) -> InboundCheckDepositsPage
• client.inboundCheckDeposits.decline(inboundCheckDepositId) -> InboundCheckDeposit
• client.inboundCheckDeposits.return(inboundCheckDepositId, { ...params }) -> InboundCheckDeposit

RealTimePaymentsTransfers

Types:

• RealTimePaymentsTransfer

Methods:

• client.realTimePaymentsTransfers.create({ ...params }) -> RealTimePaymentsTransfer
• client.realTimePaymentsTransfers.retrieve(realTimePaymentsTransferId) -> RealTimePaymentsTransfer
• client.realTimePaymentsTransfers.list({ ...params }) -> RealTimePaymentsTransfersPage

InboundRealTimePaymentsTransfers

Types:

• InboundRealTimePaymentsTransfer

Methods:

• client.inboundRealTimePaymentsTransfers.retrieve(inboundRealTimePaymentsTransferId) -> InboundRealTimePaymentsTransfer
• client.inboundRealTimePaymentsTransfers.list({ ...params }) -> InboundRealTimePaymentsTransfersPage

CheckDeposits

Types:

• CheckDeposit

Methods:

• client.checkDeposits.create({ ...params }) -> CheckDeposit
• client.checkDeposits.retrieve(checkDepositId) -> CheckDeposit
• client.checkDeposits.list({ ...params }) -> CheckDepositsPage

Lockboxes

Types:

• Lockbox

Methods:

• client.lockboxes.create({ ...params }) -> Lockbox
• client.lockboxes.retrieve(lockboxId) -> Lockbox
• client.lockboxes.update(lockboxId, { ...params }) -> Lockbox
• client.lockboxes.list({ ...params }) -> LockboxesPage

InboundMailItems

Types:

• InboundMailItem

Methods:

• client.inboundMailItems.retrieve(inboundMailItemId) -> InboundMailItem
• client.inboundMailItems.list({ ...params }) -> InboundMailItemsPage

RoutingNumbers

Types:

• RoutingNumberListResponse

Methods:

• client.routingNumbers.list({ ...params }) -> RoutingNumberListResponsesPage

ExternalAccounts

Types:

• ExternalAccount

Methods:

• client.externalAccounts.create({ ...params }) -> ExternalAccount
• client.externalAccounts.retrieve(externalAccountId) -> ExternalAccount
• client.externalAccounts.update(externalAccountId, { ...params }) -> ExternalAccount
• client.externalAccounts.list({ ...params }) -> ExternalAccountsPage

Entities

Types:

• Entity

Methods:

• client.entities.create({ ...params }) -> Entity
• client.entities.retrieve(entityId) -> Entity
• client.entities.list({ ...params }) -> EntitiesPage
• client.entities.archive(entityId) -> Entity
• client.entities.archiveBeneficialOwner(entityId, { ...params }) -> Entity
• client.entities.confirm(entityId, { ...params }) -> Entity
• client.entities.createBeneficialOwner(entityId, { ...params }) -> Entity
• client.entities.updateAddress(entityId, { ...params }) -> Entity
• client.entities.updateBeneficialOwnerAddress(entityId, { ...params }) -> Entity
• client.entities.updateIndustryCode(entityId, { ...params }) -> Entity

SupplementalDocuments

Types:

• EntitySupplementalDocument

Methods:

• client.supplementalDocuments.create({ ...params }) -> EntitySupplementalDocument
• client.supplementalDocuments.list({ ...params }) -> EntitySupplementalDocumentsPage

Programs

Types:

• Program

Methods:

• client.programs.retrieve(programId) -> Program
• client.programs.list({ ...params }) -> ProgramsPage

ProofOfAuthorizationRequests

Types:

• ProofOfAuthorizationRequest

Methods:

• client.proofOfAuthorizationRequests.retrieve(proofOfAuthorizationRequestId) -> ProofOfAuthorizationRequest
• client.proofOfAuthorizationRequests.list({ ...params }) -> ProofOfAuthorizationRequestsPage

ProofOfAuthorizationRequestSubmissions

Types:

• ProofOfAuthorizationRequestSubmission

Methods:

• client.proofOfAuthorizationRequestSubmissions.create({ ...params }) -> ProofOfAuthorizationRequestSubmission
• client.proofOfAuthorizationRequestSubmissions.retrieve(proofOfAuthorizationRequestSubmissionId) -> ProofOfAuthorizationRequestSubmission
• client.proofOfAuthorizationRequestSubmissions.list({ ...params }) -> ProofOfAuthorizationRequestSubmissionsPage

AccountStatements

Types:

• AccountStatement

Methods:

• client.accountStatements.retrieve(accountStatementId) -> AccountStatement
• client.accountStatements.list({ ...params }) -> AccountStatementsPage

Files

Types:

• File

Methods:

• client.files.create({ ...params }) -> File
• client.files.retrieve(fileId) -> File
• client.files.list({ ...params }) -> FilesPage

Documents

Types:

• Document

Methods:

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

Exports

Types:

• Export

Methods:

• client.exports.create({ ...params }) -> Export
• client.exports.retrieve(exportId) -> Export
• client.exports.list({ ...params }) -> ExportsPage

Events

Types:

• Event

Methods:

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

EventSubscriptions

Types:

• EventSubscription

Methods:

• client.eventSubscriptions.create({ ...params }) -> EventSubscription
• client.eventSubscriptions.retrieve(eventSubscriptionId) -> EventSubscription
• client.eventSubscriptions.update(eventSubscriptionId, { ...params }) -> EventSubscription
• client.eventSubscriptions.list({ ...params }) -> EventSubscriptionsPage

RealTimeDecisions

Types:

• RealTimeDecision

Methods:

• client.realTimeDecisions.retrieve(realTimeDecisionId) -> RealTimeDecision
• client.realTimeDecisions.action(realTimeDecisionId, { ...params }) -> RealTimeDecision

BookkeepingAccounts

Types:

• BookkeepingAccount
• BookkeepingBalanceLookup

Methods:

• client.bookkeepingAccounts.create({ ...params }) -> BookkeepingAccount
• client.bookkeepingAccounts.update(bookkeepingAccountId, { ...params }) -> BookkeepingAccount
• client.bookkeepingAccounts.list({ ...params }) -> BookkeepingAccountsPage
• client.bookkeepingAccounts.balance(bookkeepingAccountId, { ...params }) -> BookkeepingBalanceLookup

BookkeepingEntrySets

Types:

• BookkeepingEntrySet

Methods:

• client.bookkeepingEntrySets.create({ ...params }) -> BookkeepingEntrySet
• client.bookkeepingEntrySets.retrieve(bookkeepingEntrySetId) -> BookkeepingEntrySet
• client.bookkeepingEntrySets.list({ ...params }) -> BookkeepingEntrySetsPage

BookkeepingEntries

Types:

• BookkeepingEntry

Methods:

• client.bookkeepingEntries.retrieve(bookkeepingEntryId) -> BookkeepingEntry
• client.bookkeepingEntries.list({ ...params }) -> BookkeepingEntriesPage

Groups

Types:

• Group

Methods:

• client.groups.retrieve() -> Group

OAuthConnections

Types:

• OAuthConnection

Methods:

• client.oauthConnections.retrieve(oauthConnectionId) -> OAuthConnection
• client.oauthConnections.list({ ...params }) -> OAuthConnectionsPage

OAuthTokens

Types:

• OAuthToken

Methods:

• client.oauthTokens.create({ ...params }) -> OAuthToken

IntrafiAccountEnrollments

Types:

• IntrafiAccountEnrollment

Methods:

• client.intrafiAccountEnrollments.create({ ...params }) -> IntrafiAccountEnrollment
• client.intrafiAccountEnrollments.retrieve(intrafiAccountEnrollmentId) -> IntrafiAccountEnrollment
• client.intrafiAccountEnrollments.list({ ...params }) -> IntrafiAccountEnrollmentsPage
• client.intrafiAccountEnrollments.unenroll(intrafiAccountEnrollmentId) -> IntrafiAccountEnrollment

IntrafiBalances

Types:

• IntrafiBalance

Methods:

• client.intrafiBalances.retrieve(accountId) -> IntrafiBalance

IntrafiExclusions

Types:

• IntrafiExclusion

Methods:

• client.intrafiExclusions.create({ ...params }) -> IntrafiExclusion
• client.intrafiExclusions.retrieve(intrafiExclusionId) -> IntrafiExclusion
• client.intrafiExclusions.list({ ...params }) -> IntrafiExclusionsPage
• client.intrafiExclusions.archive(intrafiExclusionId) -> IntrafiExclusion

RealTimePaymentsRequestForPayments

Types:

• RealTimePaymentsRequestForPayment

Methods:

• client.realTimePaymentsRequestForPayments.create({ ...params }) -> RealTimePaymentsRequestForPayment
• client.realTimePaymentsRequestForPayments.retrieve(requestForPaymentId) -> RealTimePaymentsRequestForPayment
• client.realTimePaymentsRequestForPayments.list({ ...params }) -> RealTimePaymentsRequestForPaymentsPage

Webhooks

Methods:

• client.webhooks.unwrap(payload, headers, secret) -> Record<string, unknown>
• client.webhooks.verifySignature(payload, headers, secret) -> void

Simulations

AccountTransfers

Methods:

• client.simulations.accountTransfers.complete(accountTransferId) -> AccountTransfer

InboundACHTransfers

Methods:

• client.simulations.inboundACHTransfers.create({ ...params }) -> InboundACHTransfer

ACHTransfers

Methods:

• client.simulations.achTransfers.acknowledge(achTransferId) -> ACHTransfer
• client.simulations.achTransfers.createNotificationOfChange(achTransferId, { ...params }) -> ACHTransfer
• client.simulations.achTransfers.return(achTransferId, { ...params }) -> ACHTransfer
• client.simulations.achTransfers.settle(achTransferId) -> ACHTransfer
• client.simulations.achTransfers.submit(achTransferId) -> ACHTransfer

CheckTransfers

Methods:

• client.simulations.checkTransfers.mail(checkTransferId) -> CheckTransfer

InboundCheckDeposits

Methods:

• client.simulations.inboundCheckDeposits.create({ ...params }) -> InboundCheckDeposit

CheckDeposits

Methods:

• client.simulations.checkDeposits.reject(checkDepositId) -> CheckDeposit
• client.simulations.checkDeposits.return(checkDepositId) -> CheckDeposit
• client.simulations.checkDeposits.submit(checkDepositId) -> CheckDeposit

InboundWireTransfers

Methods:

• client.simulations.inboundWireTransfers.create({ ...params }) -> InboundWireTransfer

WireTransfers

Methods:

• client.simulations.wireTransfers.reverse(wireTransferId) -> WireTransfer
• client.simulations.wireTransfers.submit(wireTransferId) -> WireTransfer

InboundWireDrawdownRequests

Methods:

• client.simulations.inboundWireDrawdownRequests.create({ ...params }) -> InboundWireDrawdownRequest

InboundRealTimePaymentsTransfers

Methods:

• client.simulations.inboundRealTimePaymentsTransfers.create({ ...params }) -> InboundRealTimePaymentsTransfer

InboundFundsHolds

Types:

• InboundFundsHoldReleaseResponse

Methods:

• client.simulations.inboundFundsHolds.release(inboundFundsHoldId) -> InboundFundsHoldReleaseResponse

RealTimePaymentsTransfers

Methods:

• client.simulations.realTimePaymentsTransfers.complete(realTimePaymentsTransferId, { ...params }) -> RealTimePaymentsTransfer

CardAuthorizations

Types:

• CardAuthorizationCreateResponse

Methods:

• client.simulations.cardAuthorizations.create({ ...params }) -> CardAuthorizationCreateResponse

CardSettlements

Methods:

• client.simulations.cardSettlements.create({ ...params }) -> Transaction

CardReversals

Methods:

• client.simulations.cardReversals.create({ ...params }) -> CardPayment

CardIncrements

Methods:

• client.simulations.cardIncrements.create({ ...params }) -> CardPayment

CardAuthorizationExpirations

Methods:

• client.simulations.cardAuthorizationExpirations.create({ ...params }) -> CardPayment

CardFuelConfirmations

Methods:

• client.simulations.cardFuelConfirmations.create({ ...params }) -> CardPayment

CardRefunds

Methods:

• client.simulations.cardRefunds.create({ ...params }) -> Transaction

CardDisputes

Methods:

• client.simulations.cardDisputes.action(cardDisputeId, { ...params }) -> CardDispute

DigitalWalletTokenRequests

Types:

• DigitalWalletTokenRequestCreateResponse

Methods:

• client.simulations.digitalWalletTokenRequests.create({ ...params }) -> DigitalWalletTokenRequestCreateResponse

PhysicalCards

Methods:

• client.simulations.physicalCards.advanceShipment(physicalCardId, { ...params }) -> PhysicalCard

InterestPayments

Methods:

• client.simulations.interestPayments.create({ ...params }) -> Transaction

AccountStatements

Methods:

• client.simulations.accountStatements.create({ ...params }) -> AccountStatement

Documents

Methods:

• client.simulations.documents.create({ ...params }) -> Document

InboundMailItems

Methods:

• client.simulations.inboundMailItems.create({ ...params }) -> InboundMailItem

Programs

Methods:

• client.simulations.programs.create({ ...params }) -> Program