Skip to content

Latest commit

 

History

History
944 lines (551 loc) · 53.5 KB

File metadata and controls

944 lines (551 loc) · 53.5 KB

Accounts

Types:

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:

Methods:

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

AccountTransfers

Types:

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

Cards

Types:

Methods:

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

CardPayments

Types:

Methods:

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

CardPurchaseSupplements

Types:

Methods:

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

CardDisputes

Types:

Methods:

  • client.cardDisputes.create({ ...params }) -> CardDispute
  • client.cardDisputes.retrieve(cardDisputeID) -> CardDispute
  • client.cardDisputes.list({ ...params }) -> CardDisputesPage
  • client.cardDisputes.submitUserSubmission(cardDisputeID, { ...params }) -> CardDispute
  • client.cardDisputes.withdraw(cardDisputeID, { ...params }) -> CardDispute

PhysicalCards

Types:

Methods:

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

DigitalCardProfiles

Types:

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:

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:

Methods:

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

Transactions

Types:

Methods:

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

PendingTransactions

Types:

Methods:

  • client.pendingTransactions.create({ ...params }) -> PendingTransaction
  • client.pendingTransactions.retrieve(pendingTransactionID) -> PendingTransaction
  • client.pendingTransactions.list({ ...params }) -> PendingTransactionsPage
  • client.pendingTransactions.release(pendingTransactionID) -> PendingTransaction

DeclinedTransactions

Types:

Methods:

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

ACHTransfers

Types:

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:

Methods:

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

InboundACHTransfers

Types:

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:

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:

Methods:

  • client.inboundWireTransfers.retrieve(inboundWireTransferID) -> InboundWireTransfer
  • client.inboundWireTransfers.list({ ...params }) -> InboundWireTransfersPage
  • client.inboundWireTransfers.reverse(inboundWireTransferID, { ...params }) -> InboundWireTransfer

WireDrawdownRequests

Types:

Methods:

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

InboundWireDrawdownRequests

Types:

Methods:

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

CheckTransfers

Types:

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:

Methods:

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

RealTimePaymentsTransfers

Types:

Methods:

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

InboundRealTimePaymentsTransfers

Types:

Methods:

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

FednowTransfers

Types:

Methods:

  • client.fednowTransfers.create({ ...params }) -> FednowTransfer
  • client.fednowTransfers.retrieve(fednowTransferID) -> FednowTransfer
  • client.fednowTransfers.list({ ...params }) -> FednowTransfersPage
  • client.fednowTransfers.approve(fednowTransferID) -> FednowTransfer
  • client.fednowTransfers.cancel(fednowTransferID) -> FednowTransfer

InboundFednowTransfers

Types:

Methods:

  • client.inboundFednowTransfers.retrieve(inboundFednowTransferID) -> InboundFednowTransfer
  • client.inboundFednowTransfers.list({ ...params }) -> InboundFednowTransfersPage

SwiftTransfers

Types:

Methods:

  • client.swiftTransfers.create({ ...params }) -> SwiftTransfer
  • client.swiftTransfers.retrieve(swiftTransferID) -> SwiftTransfer
  • client.swiftTransfers.list({ ...params }) -> SwiftTransfersPage
  • client.swiftTransfers.approve(swiftTransferID) -> SwiftTransfer
  • client.swiftTransfers.cancel(swiftTransferID) -> SwiftTransfer

CheckDeposits

Types:

Methods:

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

Lockboxes

Types:

Methods:

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

InboundMailItems

Types:

Methods:

  • client.inboundMailItems.retrieve(inboundMailItemID) -> InboundMailItem
  • client.inboundMailItems.list({ ...params }) -> InboundMailItemsPage
  • client.inboundMailItems.action(inboundMailItemID, { ...params }) -> InboundMailItem

RoutingNumbers

Types:

Methods:

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

ExternalAccounts

Types:

Methods:

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

Entities

Types:

Methods:

  • client.entities.create({ ...params }) -> Entity
  • client.entities.retrieve(entityID) -> Entity
  • client.entities.update(entityID, { ...params }) -> Entity
  • client.entities.list({ ...params }) -> EntitiesPage
  • client.entities.archive(entityID) -> Entity

BeneficialOwners

Types:

Methods:

  • client.beneficialOwners.create({ ...params }) -> EntityBeneficialOwner
  • client.beneficialOwners.retrieve(entityBeneficialOwnerID) -> EntityBeneficialOwner
  • client.beneficialOwners.update(entityBeneficialOwnerID, { ...params }) -> EntityBeneficialOwner
  • client.beneficialOwners.list({ ...params }) -> EntityBeneficialOwnersPage
  • client.beneficialOwners.archive(entityBeneficialOwnerID) -> EntityBeneficialOwner

SupplementalDocuments

Types:

Methods:

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

EntityOnboardingSessions

Types:

Methods:

  • client.entityOnboardingSessions.create({ ...params }) -> EntityOnboardingSession
  • client.entityOnboardingSessions.retrieve(entityOnboardingSessionID) -> EntityOnboardingSession
  • client.entityOnboardingSessions.list({ ...params }) -> EntityOnboardingSessionsPage
  • client.entityOnboardingSessions.expire(entityOnboardingSessionID) -> EntityOnboardingSession

Programs

Types:

Methods:

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

AccountStatements

Types:

Methods:

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

Files

Types:

Methods:

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

FileLinks

Types:

Methods:

  • client.fileLinks.create({ ...params }) -> FileLink

Exports

Types:

Methods:

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

Events

Types:

Methods:

  • client.events.retrieve(eventID) -> Event
  • client.events.list({ ...params }) -> EventsPage
  • client.events.unwrap(body) -> void

EventSubscriptions

Types:

Methods:

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

RealTimeDecisions

Types:

Methods:

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

BookkeepingAccounts

Types:

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:

Methods:

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

BookkeepingEntries

Types:

Methods:

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

Groups

Types:

Methods:

OAuthApplications

Types:

Methods:

  • client.oauthApplications.retrieve(oauthApplicationID) -> OAuthApplication
  • client.oauthApplications.list({ ...params }) -> OAuthApplicationsPage

OAuthConnections

Types:

Methods:

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

OAuthTokens

Types:

Methods:

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

IntrafiAccountEnrollments

Types:

Methods:

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

IntrafiBalances

Types:

Methods:

IntrafiExclusions

Types:

Methods:

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

CardTokens

Types:

Methods:

  • client.cardTokens.retrieve(cardTokenID) -> CardToken
  • client.cardTokens.list({ ...params }) -> CardTokensPage
  • client.cardTokens.capabilities(cardTokenID) -> CardTokenCapabilities

CardPushTransfers

Types:

Methods:

  • client.cardPushTransfers.create({ ...params }) -> CardPushTransfer
  • client.cardPushTransfers.retrieve(cardPushTransferID) -> CardPushTransfer
  • client.cardPushTransfers.list({ ...params }) -> CardPushTransfersPage
  • client.cardPushTransfers.approve(cardPushTransferID) -> CardPushTransfer
  • client.cardPushTransfers.cancel(cardPushTransferID) -> CardPushTransfer

CardValidations

Types:

Methods:

  • client.cardValidations.create({ ...params }) -> CardValidation
  • client.cardValidations.retrieve(cardValidationID) -> CardValidation
  • client.cardValidations.list({ ...params }) -> CardValidationsPage

Simulations

InterestPayments

Methods:

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

CardAuthorizations

Types:

Methods:

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

CardBalanceInquiries

Methods:

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

CardAuthorizationExpirations

Methods:

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

CardSettlements

Methods:

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

CardReversals

Methods:

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

CardIncrements

Methods:

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

CardFuelConfirmations

Methods:

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

CardRefunds

Methods:

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

CardAuthentications

Methods:

  • client.simulations.cardAuthentications.create({ ...params }) -> CardPayment
  • client.simulations.cardAuthentications.challengeAttempts(cardPaymentID, { ...params }) -> CardPayment
  • client.simulations.cardAuthentications.challenges(cardPaymentID) -> CardPayment

CardPurchaseSupplements

Methods:

  • client.simulations.cardPurchaseSupplements.create({ ...params }) -> CardPurchaseSupplement

CardDisputes

Methods:

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

PhysicalCards

Methods:

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

DigitalWalletTokenRequests

Types:

Methods:

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

PendingTransactions

Methods:

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, { ...params }) -> ACHTransfer
  • client.simulations.achTransfers.submit(achTransferID) -> ACHTransfer

InboundACHTransfers

Methods:

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

WireTransfers

Methods:

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

InboundWireTransfers

Methods:

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

WireDrawdownRequests

Methods:

  • client.simulations.wireDrawdownRequests.refuse(wireDrawdownRequestID) -> WireDrawdownRequest
  • client.simulations.wireDrawdownRequests.submit(wireDrawdownRequestID) -> WireDrawdownRequest

InboundWireDrawdownRequests

Methods:

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

CheckTransfers

Methods:

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

InboundCheckDeposits

Methods:

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

RealTimePaymentsTransfers

Methods:

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

InboundRealTimePaymentsTransfers

Methods:

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

InboundFednowTransfers

Methods:

  • client.simulations.inboundFednowTransfers.create({ ...params }) -> InboundFednowTransfer

CheckDeposits

Methods:

  • client.simulations.checkDeposits.adjustment(checkDepositID, { ...params }) -> CheckDeposit
  • client.simulations.checkDeposits.reject(checkDepositID) -> CheckDeposit
  • client.simulations.checkDeposits.return(checkDepositID) -> CheckDeposit
  • client.simulations.checkDeposits.submit(checkDepositID, { ...params }) -> CheckDeposit

InboundMailItems

Methods:

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

EntityOnboardingSessions

Methods:

  • client.simulations.entityOnboardingSessions.submit(entityOnboardingSessionID) -> EntityOnboardingSession

Programs

Methods:

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

AccountStatements

Methods:

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

Exports

Methods:

  • client.simulations.exports.create({ ...params }) -> Export

CardTokens

Methods:

  • client.simulations.cardTokens.create({ ...params }) -> CardToken