api.md

Accounts

Response Types:

• acme.Account
• acme.BalanceLookup

Methods:

• client.Accounts.New(ctx context.Context, body acme.AccountNewParams) (acme.Account, error)
• client.Accounts.Get(ctx context.Context, accountID string) (acme.Account, error)
• client.Accounts.Update(ctx context.Context, accountID string, body acme.AccountUpdateParams) (acme.Account, error)
• client.Accounts.List(ctx context.Context, query acme.AccountListParams) (acme.Page[acme.Account], error)
• client.Accounts.Balance(ctx context.Context, accountID string, query acme.AccountBalanceParams) (acme.BalanceLookup, error)
• client.Accounts.Close(ctx context.Context, accountID string) (acme.Account, error)

AccountNumbers

Response Types:

• acme.AccountNumber

Methods:

• client.AccountNumbers.New(ctx context.Context, body acme.AccountNumberNewParams) (acme.AccountNumber, error)
• client.AccountNumbers.Get(ctx context.Context, accountNumberID string) (acme.AccountNumber, error)
• client.AccountNumbers.Update(ctx context.Context, accountNumberID string, body acme.AccountNumberUpdateParams) (acme.AccountNumber, error)
• client.AccountNumbers.List(ctx context.Context, query acme.AccountNumberListParams) (acme.Page[acme.AccountNumber], error)

BookkeepingAccounts

Response Types:

• acme.BookkeepingAccount
• acme.BookkeepingBalanceLookup

Methods:

• client.BookkeepingAccounts.New(ctx context.Context, body acme.BookkeepingAccountNewParams) (acme.BookkeepingAccount, error)
• client.BookkeepingAccounts.Update(ctx context.Context, bookkeepingAccountID string, body acme.BookkeepingAccountUpdateParams) (acme.BookkeepingAccount, error)
• client.BookkeepingAccounts.List(ctx context.Context, query acme.BookkeepingAccountListParams) (acme.Page[acme.BookkeepingAccount], error)
• client.BookkeepingAccounts.Balance(ctx context.Context, bookkeepingAccountID string, query acme.BookkeepingAccountBalanceParams) (acme.BookkeepingBalanceLookup, error)

BookkeepingEntrySets

Response Types:

• acme.BookkeepingEntrySet

Methods:

• client.BookkeepingEntrySets.New(ctx context.Context, body acme.BookkeepingEntrySetNewParams) (acme.BookkeepingEntrySet, error)
• client.BookkeepingEntrySets.Get(ctx context.Context, bookkeepingEntrySetID string) (acme.BookkeepingEntrySet, error)
• client.BookkeepingEntrySets.List(ctx context.Context, query acme.BookkeepingEntrySetListParams) (acme.Page[acme.BookkeepingEntrySet], error)

BookkeepingEntries

Response Types:

• acme.BookkeepingEntry

Methods:

• client.BookkeepingEntries.Get(ctx context.Context, bookkeepingEntryID string) (acme.BookkeepingEntry, error)
• client.BookkeepingEntries.List(ctx context.Context, query acme.BookkeepingEntryListParams) (acme.Page[acme.BookkeepingEntry], error)

RealTimeDecisions

Response Types:

• acme.RealTimeDecision

Methods:

• client.RealTimeDecisions.Get(ctx context.Context, realTimeDecisionID string) (acme.RealTimeDecision, error)
• client.RealTimeDecisions.Action(ctx context.Context, realTimeDecisionID string, body acme.RealTimeDecisionActionParams) (acme.RealTimeDecision, error)

RealTimePaymentsTransfers

Response Types:

• acme.RealTimePaymentsTransfer

Methods:

• client.RealTimePaymentsTransfers.New(ctx context.Context, body acme.RealTimePaymentsTransferNewParams) (acme.RealTimePaymentsTransfer, error)
• client.RealTimePaymentsTransfers.Get(ctx context.Context, realTimePaymentsTransferID string) (acme.RealTimePaymentsTransfer, error)
• client.RealTimePaymentsTransfers.List(ctx context.Context, query acme.RealTimePaymentsTransferListParams) (acme.Page[acme.RealTimePaymentsTransfer], error)

Cards

Response Types:

• acme.Card
• acme.CardDetails

Methods:

• client.Cards.New(ctx context.Context, body acme.CardNewParams) (acme.Card, error)
• client.Cards.Get(ctx context.Context, cardID string) (acme.Card, error)
• client.Cards.Update(ctx context.Context, cardID string, body acme.CardUpdateParams) (acme.Card, error)
• client.Cards.List(ctx context.Context, query acme.CardListParams) (acme.Page[acme.Card], error)
• client.Cards.GetSensitiveDetails(ctx context.Context, cardID string) (acme.CardDetails, error)

CardDisputes

Response Types:

• acme.CardDispute

Methods:

• client.CardDisputes.New(ctx context.Context, body acme.CardDisputeNewParams) (acme.CardDispute, error)
• client.CardDisputes.Get(ctx context.Context, cardDisputeID string) (acme.CardDispute, error)
• client.CardDisputes.List(ctx context.Context, query acme.CardDisputeListParams) (acme.Page[acme.CardDispute], error)

CardProfiles

Response Types:

• acme.CardProfile

Methods:

• client.CardProfiles.New(ctx context.Context, body acme.CardProfileNewParams) (acme.CardProfile, error)
• client.CardProfiles.Get(ctx context.Context, cardProfileID string) (acme.CardProfile, error)
• client.CardProfiles.List(ctx context.Context, query acme.CardProfileListParams) (acme.Page[acme.CardProfile], error)
• client.CardProfiles.Archive(ctx context.Context, cardProfileID string) (acme.CardProfile, error)

CardPurchaseSupplements

Response Types:

• acme.CardPurchaseSupplement

Methods:

• client.CardPurchaseSupplements.Get(ctx context.Context, cardPurchaseSupplementID string) (acme.CardPurchaseSupplement, error)
• client.CardPurchaseSupplements.List(ctx context.Context, query acme.CardPurchaseSupplementListParams) (acme.Page[acme.CardPurchaseSupplement], error)

ExternalAccounts

Response Types:

• acme.ExternalAccount

Methods:

• client.ExternalAccounts.New(ctx context.Context, body acme.ExternalAccountNewParams) (acme.ExternalAccount, error)
• client.ExternalAccounts.Get(ctx context.Context, externalAccountID string) (acme.ExternalAccount, error)
• client.ExternalAccounts.Update(ctx context.Context, externalAccountID string, body acme.ExternalAccountUpdateParams) (acme.ExternalAccount, error)
• client.ExternalAccounts.List(ctx context.Context, query acme.ExternalAccountListParams) (acme.Page[acme.ExternalAccount], error)

Exports

Response Types:

• acme.Export

Methods:

• client.Exports.New(ctx context.Context, body acme.ExportNewParams) (acme.Export, error)
• client.Exports.Get(ctx context.Context, exportID string) (acme.Export, error)
• client.Exports.List(ctx context.Context, query acme.ExportListParams) (acme.Page[acme.Export], error)

DigitalWalletTokens

Response Types:

• acme.DigitalWalletToken

Methods:

• client.DigitalWalletTokens.Get(ctx context.Context, digitalWalletTokenID string) (acme.DigitalWalletToken, error)
• client.DigitalWalletTokens.List(ctx context.Context, query acme.DigitalWalletTokenListParams) (acme.Page[acme.DigitalWalletToken], error)

Transactions

Response Types:

• acme.Transaction

Methods:

• client.Transactions.Get(ctx context.Context, transactionID string) (acme.Transaction, error)
• client.Transactions.List(ctx context.Context, query acme.TransactionListParams) (acme.Page[acme.Transaction], error)

PendingTransactions

Response Types:

• acme.PendingTransaction

Methods:

• client.PendingTransactions.Get(ctx context.Context, pendingTransactionID string) (acme.PendingTransaction, error)
• client.PendingTransactions.List(ctx context.Context, query acme.PendingTransactionListParams) (acme.Page[acme.PendingTransaction], error)

Programs

Response Types:

• acme.Program

Methods:

• client.Programs.Get(ctx context.Context, programID string) (acme.Program, error)
• client.Programs.List(ctx context.Context, query acme.ProgramListParams) (acme.Page[acme.Program], error)

DeclinedTransactions

Response Types:

• acme.DeclinedTransaction

Methods:

• client.DeclinedTransactions.Get(ctx context.Context, declinedTransactionID string) (acme.DeclinedTransaction, error)
• client.DeclinedTransactions.List(ctx context.Context, query acme.DeclinedTransactionListParams) (acme.Page[acme.DeclinedTransaction], error)

AccountTransfers

Response Types:

• acme.AccountTransfer

Methods:

• client.AccountTransfers.New(ctx context.Context, body acme.AccountTransferNewParams) (acme.AccountTransfer, error)
• client.AccountTransfers.Get(ctx context.Context, accountTransferID string) (acme.AccountTransfer, error)
• client.AccountTransfers.List(ctx context.Context, query acme.AccountTransferListParams) (acme.Page[acme.AccountTransfer], error)
• client.AccountTransfers.Approve(ctx context.Context, accountTransferID string) (acme.AccountTransfer, error)
• client.AccountTransfers.Cancel(ctx context.Context, accountTransferID string) (acme.AccountTransfer, error)

ACHTransfers

Response Types:

• acme.ACHTransfer

Methods:

• client.ACHTransfers.New(ctx context.Context, body acme.ACHTransferNewParams) (acme.ACHTransfer, error)
• client.ACHTransfers.Get(ctx context.Context, achTransferID string) (acme.ACHTransfer, error)
• client.ACHTransfers.List(ctx context.Context, query acme.ACHTransferListParams) (acme.Page[acme.ACHTransfer], error)
• client.ACHTransfers.Approve(ctx context.Context, achTransferID string) (acme.ACHTransfer, error)
• client.ACHTransfers.Cancel(ctx context.Context, achTransferID string) (acme.ACHTransfer, error)

ACHPrenotifications

Response Types:

• acme.ACHPrenotification

Methods:

• client.ACHPrenotifications.New(ctx context.Context, body acme.ACHPrenotificationNewParams) (acme.ACHPrenotification, error)
• client.ACHPrenotifications.Get(ctx context.Context, achPrenotificationID string) (acme.ACHPrenotification, error)
• client.ACHPrenotifications.List(ctx context.Context, query acme.ACHPrenotificationListParams) (acme.Page[acme.ACHPrenotification], error)

Documents

Response Types:

• acme.Document

Methods:

• client.Documents.Get(ctx context.Context, documentID string) (acme.Document, error)
• client.Documents.List(ctx context.Context, query acme.DocumentListParams) (acme.Page[acme.Document], error)

WireTransfers

Response Types:

• acme.WireTransfer

Methods:

• client.WireTransfers.New(ctx context.Context, body acme.WireTransferNewParams) (acme.WireTransfer, error)
• client.WireTransfers.Get(ctx context.Context, wireTransferID string) (acme.WireTransfer, error)
• client.WireTransfers.List(ctx context.Context, query acme.WireTransferListParams) (acme.Page[acme.WireTransfer], error)
• client.WireTransfers.Approve(ctx context.Context, wireTransferID string) (acme.WireTransfer, error)
• client.WireTransfers.Cancel(ctx context.Context, wireTransferID string) (acme.WireTransfer, error)
• client.WireTransfers.Reverse(ctx context.Context, wireTransferID string) (acme.WireTransfer, error)
• client.WireTransfers.Submit(ctx context.Context, wireTransferID string) (acme.WireTransfer, error)

CheckTransfers

Response Types:

• acme.CheckTransfer

Methods:

• client.CheckTransfers.New(ctx context.Context, body acme.CheckTransferNewParams) (acme.CheckTransfer, error)
• client.CheckTransfers.Get(ctx context.Context, checkTransferID string) (acme.CheckTransfer, error)
• client.CheckTransfers.List(ctx context.Context, query acme.CheckTransferListParams) (acme.Page[acme.CheckTransfer], error)
• client.CheckTransfers.Approve(ctx context.Context, checkTransferID string) (acme.CheckTransfer, error)
• client.CheckTransfers.Cancel(ctx context.Context, checkTransferID string) (acme.CheckTransfer, error)
• client.CheckTransfers.StopPayment(ctx context.Context, checkTransferID string, body acme.CheckTransferStopPaymentParams) (acme.CheckTransfer, error)

Entities

Response Types:

• acme.Entity

Methods:

• client.Entities.New(ctx context.Context, body acme.EntityNewParams) (acme.Entity, error)
• client.Entities.Get(ctx context.Context, entityID string) (acme.Entity, error)
• client.Entities.List(ctx context.Context, query acme.EntityListParams) (acme.Page[acme.Entity], error)
• client.Entities.Archive(ctx context.Context, entityID string) (acme.Entity, error)
• client.Entities.UpdateAddress(ctx context.Context, entityID string, body acme.EntityUpdateAddressParams) (acme.Entity, error)

BeneficialOwners

Methods:

• client.Entities.BeneficialOwners.New(ctx context.Context, body acme.EntityBeneficialOwnerNewParams) (acme.Entity, error)
• client.Entities.BeneficialOwners.Archive(ctx context.Context, body acme.EntityBeneficialOwnerArchiveParams) (acme.Entity, error)
• client.Entities.BeneficialOwners.UpdateAddress(ctx context.Context, body acme.EntityBeneficialOwnerUpdateAddressParams) (acme.Entity, error)

SupplementalDocuments

Response Types:

• acme.SupplementalDocument

Methods:

• client.Entities.SupplementalDocuments.New(ctx context.Context, entityID string, body acme.EntitySupplementalDocumentNewParams) (acme.Entity, error)
• client.Entities.SupplementalDocuments.List(ctx context.Context, query acme.EntitySupplementalDocumentListParams) (acme.Page[acme.SupplementalDocument], error)

InboundACHTransfers

Response Types:

• acme.InboundACHTransfer

Methods:

• client.InboundACHTransfers.Get(ctx context.Context, inboundACHTransferID string) (acme.InboundACHTransfer, error)
• client.InboundACHTransfers.List(ctx context.Context, query acme.InboundACHTransferListParams) (acme.Page[acme.InboundACHTransfer], error)
• client.InboundACHTransfers.Decline(ctx context.Context, inboundACHTransferID string) (acme.InboundACHTransfer, error)
• client.InboundACHTransfers.NotificationOfChange(ctx context.Context, inboundACHTransferID string, body acme.InboundACHTransferNotificationOfChangeParams) (acme.InboundACHTransfer, error)
• client.InboundACHTransfers.TransferReturn(ctx context.Context, inboundACHTransferID string, body acme.InboundACHTransferTransferReturnParams) (acme.InboundACHTransfer, error)

InboundWireDrawdownRequests

Response Types:

• acme.InboundWireDrawdownRequest

Methods:

• client.InboundWireDrawdownRequests.Get(ctx context.Context, inboundWireDrawdownRequestID string) (acme.InboundWireDrawdownRequest, error)
• client.InboundWireDrawdownRequests.List(ctx context.Context, query acme.InboundWireDrawdownRequestListParams) (acme.Page[acme.InboundWireDrawdownRequest], error)

WireDrawdownRequests

Response Types:

• acme.WireDrawdownRequest

Methods:

• client.WireDrawdownRequests.New(ctx context.Context, body acme.WireDrawdownRequestNewParams) (acme.WireDrawdownRequest, error)
• client.WireDrawdownRequests.Get(ctx context.Context, wireDrawdownRequestID string) (acme.WireDrawdownRequest, error)
• client.WireDrawdownRequests.List(ctx context.Context, query acme.WireDrawdownRequestListParams) (acme.Page[acme.WireDrawdownRequest], error)

Events

Response Types:

• acme.Event

Methods:

• client.Events.Get(ctx context.Context, eventID string) (acme.Event, error)
• client.Events.List(ctx context.Context, query acme.EventListParams) (acme.Page[acme.Event], error)

EventSubscriptions

Response Types:

• acme.EventSubscription

Methods:

• client.EventSubscriptions.New(ctx context.Context, body acme.EventSubscriptionNewParams) (acme.EventSubscription, error)
• client.EventSubscriptions.Get(ctx context.Context, eventSubscriptionID string) (acme.EventSubscription, error)
• client.EventSubscriptions.Update(ctx context.Context, eventSubscriptionID string, body acme.EventSubscriptionUpdateParams) (acme.EventSubscription, error)
• client.EventSubscriptions.List(ctx context.Context, query acme.EventSubscriptionListParams) (acme.Page[acme.EventSubscription], error)

Files

Response Types:

• acme.File

Methods:

• client.Files.New(ctx context.Context, body acme.FileNewParams) (acme.File, error)
• client.Files.Get(ctx context.Context, fileID string) (acme.File, error)
• client.Files.List(ctx context.Context, query acme.FileListParams) (acme.Page[acme.File], error)

Groups

Response Types:

• acme.Group

Methods:

• client.Groups.GetDetails(ctx context.Context) (acme.Group, error)

OauthConnections

Response Types:

• acme.OauthConnection

Methods:

• client.OauthConnections.Get(ctx context.Context, oauthConnectionID string) (acme.OauthConnection, error)
• client.OauthConnections.List(ctx context.Context, query acme.OauthConnectionListParams) (acme.Page[acme.OauthConnection], error)

CheckDeposits

Response Types:

• acme.CheckDeposit

Methods:

• client.CheckDeposits.New(ctx context.Context, body acme.CheckDepositNewParams) (acme.CheckDeposit, error)
• client.CheckDeposits.Get(ctx context.Context, checkDepositID string) (acme.CheckDeposit, error)
• client.CheckDeposits.List(ctx context.Context, query acme.CheckDepositListParams) (acme.Page[acme.CheckDeposit], error)

RoutingNumbers

Response Types:

• acme.RoutingNumber

Methods:

• client.RoutingNumbers.List(ctx context.Context, query acme.RoutingNumberListParams) (acme.Page[acme.RoutingNumber], error)

AccountStatements

Response Types:

• acme.AccountStatement

Methods:

• client.AccountStatements.Get(ctx context.Context, accountStatementID string) (acme.AccountStatement, error)
• client.AccountStatements.List(ctx context.Context, query acme.AccountStatementListParams) (acme.Page[acme.AccountStatement], error)

Simulations

AccountTransfers

Methods:

• client.Simulations.AccountTransfers.Complete(ctx context.Context, accountTransferID string) (acme.AccountTransfer, error)

AccountStatements

Methods:

• client.Simulations.AccountStatements.New(ctx context.Context, body acme.SimulationAccountStatementNewParams) (acme.AccountStatement, error)

ACHTransfers

Response Types:

• acme.ACHTransferSimulation

Methods:

• client.Simulations.ACHTransfers.NewInbound(ctx context.Context, body acme.SimulationACHTransferNewInboundParams) (acme.ACHTransferSimulation, error)
• client.Simulations.ACHTransfers.Return(ctx context.Context, achTransferID string, body acme.SimulationACHTransferReturnParams) (acme.ACHTransfer, error)
• client.Simulations.ACHTransfers.Submit(ctx context.Context, achTransferID string) (acme.ACHTransfer, error)

CardDisputes

Methods:

• client.Simulations.CardDisputes.Action(ctx context.Context, cardDisputeID string, body acme.SimulationCardDisputeActionParams) (acme.CardDispute, error)

CardProfiles

Methods:

• client.Simulations.CardProfiles.Approve(ctx context.Context, cardProfileID string) (acme.CardProfile, error)

CardRefunds

Methods:

• client.Simulations.CardRefunds.New(ctx context.Context, body acme.SimulationCardRefundNewParams) (acme.Transaction, error)

CheckTransfers

Methods:

• client.Simulations.CheckTransfers.Deposit(ctx context.Context, checkTransferID string) (acme.CheckTransfer, error)
• client.Simulations.CheckTransfers.Mail(ctx context.Context, checkTransferID string) (acme.CheckTransfer, error)

Documents

Methods:

• client.Simulations.Documents.New(ctx context.Context, body acme.SimulationDocumentNewParams) (acme.Document, error)

DigitalWalletTokenRequests

Response Types:

• acme.SimulationDigitalWalletTokenRequestNewResponse

Methods:

• client.Simulations.DigitalWalletTokenRequests.New(ctx context.Context, body acme.SimulationDigitalWalletTokenRequestNewParams) (acme.SimulationDigitalWalletTokenRequestNewResponse, error)

CheckDeposits

Methods:

• client.Simulations.CheckDeposits.Reject(ctx context.Context, checkDepositID string) (acme.CheckDeposit, error)
• client.Simulations.CheckDeposits.Return(ctx context.Context, checkDepositID string) (acme.CheckDeposit, error)
• client.Simulations.CheckDeposits.Submit(ctx context.Context, checkDepositID string) (acme.CheckDeposit, error)

Programs

Methods:

• client.Simulations.Programs.New(ctx context.Context, body acme.SimulationProgramNewParams) (acme.Program, error)

InboundWireDrawdownRequests

Methods:

• client.Simulations.InboundWireDrawdownRequests.New(ctx context.Context, body acme.SimulationInboundWireDrawdownRequestNewParams) (acme.InboundWireDrawdownRequest, error)

InboundFundsHolds

Response Types:

• acme.SimulationInboundFundsHoldReleaseResponse

Methods:

• client.Simulations.InboundFundsHolds.Release(ctx context.Context, inboundFundsHoldID string) (acme.SimulationInboundFundsHoldReleaseResponse, error)

InterestPayments

Response Types:

• acme.InterestPaymentSimulationResult

Methods:

• client.Simulations.InterestPayments.New(ctx context.Context, body acme.SimulationInterestPaymentNewParams) (acme.InterestPaymentSimulationResult, error)

WireTransfers

Response Types:

• acme.WireTransferSimulation

Methods:

• client.Simulations.WireTransfers.NewInbound(ctx context.Context, body acme.SimulationWireTransferNewInboundParams) (acme.WireTransferSimulation, error)

Cards

Response Types:

• acme.CardAuthorizationSimulation

Methods:

• client.Simulations.Cards.Authorize(ctx context.Context, body acme.SimulationCardAuthorizeParams) (acme.CardAuthorizationSimulation, error)
• client.Simulations.Cards.Settlement(ctx context.Context, body acme.SimulationCardSettlementParams) (acme.Transaction, error)

RealTimePaymentsTransfers

Response Types:

• acme.InboundRealTimePaymentsTransferSimulationResult

Methods:

• client.Simulations.RealTimePaymentsTransfers.Complete(ctx context.Context, realTimePaymentsTransferID string, body acme.SimulationRealTimePaymentsTransferCompleteParams) (acme.RealTimePaymentsTransfer, error)
• client.Simulations.RealTimePaymentsTransfers.NewInbound(ctx context.Context, body acme.SimulationRealTimePaymentsTransferNewInboundParams) (acme.InboundRealTimePaymentsTransferSimulationResult, error)

PhysicalCards

Methods:

• client.Simulations.PhysicalCards.ShipmentAdvance(ctx context.Context, physicalCardID string, body acme.SimulationPhysicalCardShipmentAdvanceParams) (acme.PhysicalCard, error)

PhysicalCards

Response Types:

• acme.PhysicalCard

Methods:

• client.PhysicalCards.New(ctx context.Context, body acme.PhysicalCardNewParams) (acme.PhysicalCard, error)
• client.PhysicalCards.Get(ctx context.Context, physicalCardID string) (acme.PhysicalCard, error)
• client.PhysicalCards.Update(ctx context.Context, physicalCardID string, body acme.PhysicalCardUpdateParams) (acme.PhysicalCard, error)
• client.PhysicalCards.List(ctx context.Context, query acme.PhysicalCardListParams) (acme.Page[acme.PhysicalCard], error)

CardPayments

Response Types:

• acme.CardPayment

Methods:

• client.CardPayments.Get(ctx context.Context, cardPaymentID string) (acme.CardPayment, error)
• client.CardPayments.List(ctx context.Context, query acme.CardPaymentListParams) (acme.Page[acme.CardPayment], error)