api.md

Accounts

Types:

from increase.types import Account, BalanceLookup

Methods:

• client.accounts.create(**params) -> Account
• client.accounts.retrieve(account_id) -> Account
• client.accounts.update(account_id, **params) -> Account
• client.accounts.list(**params) -> SyncPage[Account]
• client.accounts.balance(account_id, **params) -> BalanceLookup
• client.accounts.close(account_id) -> Account

AccountNumbers

Types:

from increase.types import AccountNumber

Methods:

• client.account_numbers.create(**params) -> AccountNumber
• client.account_numbers.retrieve(account_number_id) -> AccountNumber
• client.account_numbers.update(account_number_id, **params) -> AccountNumber
• client.account_numbers.list(**params) -> SyncPage[AccountNumber]

Cards

Types:

from increase.types import Card, CardDetails

Methods:

• client.cards.create(**params) -> Card
• client.cards.retrieve(card_id) -> Card
• client.cards.update(card_id, **params) -> Card
• client.cards.list(**params) -> SyncPage[Card]
• client.cards.details(card_id) -> CardDetails

CardPayments

Types:

from increase.types import CardPayment

Methods:

• client.card_payments.retrieve(card_payment_id) -> CardPayment
• client.card_payments.list(**params) -> SyncPage[CardPayment]

CardPurchaseSupplements

Types:

from increase.types import CardPurchaseSupplement

Methods:

• client.card_purchase_supplements.retrieve(card_purchase_supplement_id) -> CardPurchaseSupplement
• client.card_purchase_supplements.list(**params) -> SyncPage[CardPurchaseSupplement]

CardDisputes

Types:

from increase.types import CardDispute

Methods:

• client.card_disputes.create(**params) -> CardDispute
• client.card_disputes.retrieve(card_dispute_id) -> CardDispute
• client.card_disputes.list(**params) -> SyncPage[CardDispute]

PhysicalCards

Types:

from increase.types import PhysicalCard

Methods:

• client.physical_cards.create(**params) -> PhysicalCard
• client.physical_cards.retrieve(physical_card_id) -> PhysicalCard
• client.physical_cards.update(physical_card_id, **params) -> PhysicalCard
• client.physical_cards.list(**params) -> SyncPage[PhysicalCard]

DigitalCardProfiles

Types:

from increase.types import DigitalCardProfile

Methods:

• client.digital_card_profiles.create(**params) -> DigitalCardProfile
• client.digital_card_profiles.retrieve(digital_card_profile_id) -> DigitalCardProfile
• client.digital_card_profiles.list(**params) -> SyncPage[DigitalCardProfile]
• client.digital_card_profiles.archive(digital_card_profile_id) -> DigitalCardProfile
• client.digital_card_profiles.clone(digital_card_profile_id, **params) -> DigitalCardProfile

PhysicalCardProfiles

Types:

from increase.types import PhysicalCardProfile

Methods:

• client.physical_card_profiles.create(**params) -> PhysicalCardProfile
• client.physical_card_profiles.retrieve(physical_card_profile_id) -> PhysicalCardProfile
• client.physical_card_profiles.list(**params) -> SyncPage[PhysicalCardProfile]
• client.physical_card_profiles.archive(physical_card_profile_id) -> PhysicalCardProfile
• client.physical_card_profiles.clone(physical_card_profile_id, **params) -> PhysicalCardProfile

DigitalWalletTokens

Types:

from increase.types import DigitalWalletToken

Methods:

• client.digital_wallet_tokens.retrieve(digital_wallet_token_id) -> DigitalWalletToken
• client.digital_wallet_tokens.list(**params) -> SyncPage[DigitalWalletToken]

Transactions

Types:

from increase.types import Transaction

Methods:

• client.transactions.retrieve(transaction_id) -> Transaction
• client.transactions.list(**params) -> SyncPage[Transaction]

PendingTransactions

Types:

from increase.types import PendingTransaction

Methods:

• client.pending_transactions.retrieve(pending_transaction_id) -> PendingTransaction
• client.pending_transactions.list(**params) -> SyncPage[PendingTransaction]

DeclinedTransactions

Types:

from increase.types import DeclinedTransaction

Methods:

• client.declined_transactions.retrieve(declined_transaction_id) -> DeclinedTransaction
• client.declined_transactions.list(**params) -> SyncPage[DeclinedTransaction]

AccountTransfers

Types:

from increase.types import AccountTransfer

Methods:

• client.account_transfers.create(**params) -> AccountTransfer
• client.account_transfers.retrieve(account_transfer_id) -> AccountTransfer
• client.account_transfers.list(**params) -> SyncPage[AccountTransfer]
• client.account_transfers.approve(account_transfer_id) -> AccountTransfer
• client.account_transfers.cancel(account_transfer_id) -> AccountTransfer

ACHTransfers

Types:

from increase.types import ACHTransfer

Methods:

• client.ach_transfers.create(**params) -> ACHTransfer
• client.ach_transfers.retrieve(ach_transfer_id) -> ACHTransfer
• client.ach_transfers.list(**params) -> SyncPage[ACHTransfer]
• client.ach_transfers.approve(ach_transfer_id) -> ACHTransfer
• client.ach_transfers.cancel(ach_transfer_id) -> ACHTransfer

ACHPrenotifications

Types:

from increase.types import ACHPrenotification

Methods:

• client.ach_prenotifications.create(**params) -> ACHPrenotification
• client.ach_prenotifications.retrieve(ach_prenotification_id) -> ACHPrenotification
• client.ach_prenotifications.list(**params) -> SyncPage[ACHPrenotification]

InboundACHTransfers

Types:

from increase.types import InboundACHTransfer

Methods:

• client.inbound_ach_transfers.retrieve(inbound_ach_transfer_id) -> InboundACHTransfer
• client.inbound_ach_transfers.list(**params) -> SyncPage[InboundACHTransfer]
• client.inbound_ach_transfers.create_notification_of_change(inbound_ach_transfer_id, **params) -> InboundACHTransfer
• client.inbound_ach_transfers.decline(inbound_ach_transfer_id, **params) -> InboundACHTransfer
• client.inbound_ach_transfers.transfer_return(inbound_ach_transfer_id, **params) -> InboundACHTransfer

WireTransfers

Types:

from increase.types import WireTransfer

Methods:

• client.wire_transfers.create(**params) -> WireTransfer
• client.wire_transfers.retrieve(wire_transfer_id) -> WireTransfer
• client.wire_transfers.list(**params) -> SyncPage[WireTransfer]
• client.wire_transfers.approve(wire_transfer_id) -> WireTransfer
• client.wire_transfers.cancel(wire_transfer_id) -> WireTransfer

InboundWireTransfers

Types:

from increase.types import InboundWireTransfer

Methods:

• client.inbound_wire_transfers.retrieve(inbound_wire_transfer_id) -> InboundWireTransfer
• client.inbound_wire_transfers.list(**params) -> SyncPage[InboundWireTransfer]

WireDrawdownRequests

Types:

from increase.types import WireDrawdownRequest

Methods:

• client.wire_drawdown_requests.create(**params) -> WireDrawdownRequest
• client.wire_drawdown_requests.retrieve(wire_drawdown_request_id) -> WireDrawdownRequest
• client.wire_drawdown_requests.list(**params) -> SyncPage[WireDrawdownRequest]

InboundWireDrawdownRequests

Types:

from increase.types import InboundWireDrawdownRequest

Methods:

• client.inbound_wire_drawdown_requests.retrieve(inbound_wire_drawdown_request_id) -> InboundWireDrawdownRequest
• client.inbound_wire_drawdown_requests.list(**params) -> SyncPage[InboundWireDrawdownRequest]

CheckTransfers

Types:

from increase.types import CheckTransfer

Methods:

• client.check_transfers.create(**params) -> CheckTransfer
• client.check_transfers.retrieve(check_transfer_id) -> CheckTransfer
• client.check_transfers.list(**params) -> SyncPage[CheckTransfer]
• client.check_transfers.approve(check_transfer_id) -> CheckTransfer
• client.check_transfers.cancel(check_transfer_id) -> CheckTransfer
• client.check_transfers.stop_payment(check_transfer_id, **params) -> CheckTransfer

InboundCheckDeposits

Types:

from increase.types import InboundCheckDeposit

Methods:

• client.inbound_check_deposits.retrieve(inbound_check_deposit_id) -> InboundCheckDeposit
• client.inbound_check_deposits.list(**params) -> SyncPage[InboundCheckDeposit]
• client.inbound_check_deposits.decline(inbound_check_deposit_id) -> InboundCheckDeposit
• client.inboundcheck_deposits.return(inbound_check_deposit_id, **params) -> InboundCheckDeposit

RealTimePaymentsTransfers

Types:

from increase.types import RealTimePaymentsTransfer

Methods:

• client.real_time_payments_transfers.create(**params) -> RealTimePaymentsTransfer
• client.real_time_payments_transfers.retrieve(real_time_payments_transfer_id) -> RealTimePaymentsTransfer
• client.real_time_payments_transfers.list(**params) -> SyncPage[RealTimePaymentsTransfer]

InboundRealTimePaymentsTransfers

Types:

from increase.types import InboundRealTimePaymentsTransfer

Methods:

• client.inbound_real_time_payments_transfers.retrieve(inbound_real_time_payments_transfer_id) -> InboundRealTimePaymentsTransfer
• client.inbound_real_time_payments_transfers.list(**params) -> SyncPage[InboundRealTimePaymentsTransfer]

CheckDeposits

Types:

from increase.types import CheckDeposit

Methods:

• client.check_deposits.create(**params) -> CheckDeposit
• client.check_deposits.retrieve(check_deposit_id) -> CheckDeposit
• client.check_deposits.list(**params) -> SyncPage[CheckDeposit]

Lockboxes

Types:

from increase.types import Lockbox

Methods:

• client.lockboxes.create(**params) -> Lockbox
• client.lockboxes.retrieve(lockbox_id) -> Lockbox
• client.lockboxes.update(lockbox_id, **params) -> Lockbox
• client.lockboxes.list(**params) -> SyncPage[Lockbox]

InboundMailItems

Types:

from increase.types import InboundMailItem

Methods:

• client.inbound_mail_items.retrieve(inbound_mail_item_id) -> InboundMailItem
• client.inbound_mail_items.list(**params) -> SyncPage[InboundMailItem]

RoutingNumbers

Types:

from increase.types import RoutingNumberListResponse

Methods:

• client.routing_numbers.list(**params) -> SyncPage[RoutingNumberListResponse]

ExternalAccounts

Types:

from increase.types import ExternalAccount

Methods:

• client.external_accounts.create(**params) -> ExternalAccount
• client.external_accounts.retrieve(external_account_id) -> ExternalAccount
• client.external_accounts.update(external_account_id, **params) -> ExternalAccount
• client.external_accounts.list(**params) -> SyncPage[ExternalAccount]

Entities

Types:

from increase.types import Entity

Methods:

• client.entities.create(**params) -> Entity
• client.entities.retrieve(entity_id) -> Entity
• client.entities.list(**params) -> SyncPage[Entity]
• client.entities.archive(entity_id) -> Entity
• client.entities.archive_beneficial_owner(entity_id, **params) -> Entity
• client.entities.confirm(entity_id, **params) -> Entity
• client.entities.create_beneficial_owner(entity_id, **params) -> Entity
• client.entities.update_address(entity_id, **params) -> Entity
• client.entities.update_beneficial_owner_address(entity_id, **params) -> Entity
• client.entities.update_industry_code(entity_id, **params) -> Entity

SupplementalDocuments

Types:

from increase.types import EntitySupplementalDocument

Methods:

• client.supplemental_documents.create(**params) -> EntitySupplementalDocument
• client.supplemental_documents.list(**params) -> SyncPage[EntitySupplementalDocument]

Programs

Types:

from increase.types import Program

Methods:

• client.programs.retrieve(program_id) -> Program
• client.programs.list(**params) -> SyncPage[Program]

ProofOfAuthorizationRequests

Types:

from increase.types import ProofOfAuthorizationRequest

Methods:

• client.proof_of_authorization_requests.retrieve(proof_of_authorization_request_id) -> ProofOfAuthorizationRequest
• client.proof_of_authorization_requests.list(**params) -> SyncPage[ProofOfAuthorizationRequest]

ProofOfAuthorizationRequestSubmissions

Types:

from increase.types import ProofOfAuthorizationRequestSubmission

Methods:

• client.proof_of_authorization_request_submissions.create(**params) -> ProofOfAuthorizationRequestSubmission
• client.proof_of_authorization_request_submissions.retrieve(proof_of_authorization_request_submission_id) -> ProofOfAuthorizationRequestSubmission
• client.proof_of_authorization_request_submissions.list(**params) -> SyncPage[ProofOfAuthorizationRequestSubmission]

AccountStatements

Types:

from increase.types import AccountStatement

Methods:

• client.account_statements.retrieve(account_statement_id) -> AccountStatement
• client.account_statements.list(**params) -> SyncPage[AccountStatement]

Files

Types:

from increase.types import File

Methods:

• client.files.create(**params) -> File
• client.files.retrieve(file_id) -> File
• client.files.list(**params) -> SyncPage[File]

Documents

Types:

from increase.types import Document

Methods:

• client.documents.retrieve(document_id) -> Document
• client.documents.list(**params) -> SyncPage[Document]

Exports

Types:

from increase.types import Export

Methods:

• client.exports.create(**params) -> Export
• client.exports.retrieve(export_id) -> Export
• client.exports.list(**params) -> SyncPage[Export]

Events

Types:

from increase.types import Event

Methods:

• client.events.retrieve(event_id) -> Event
• client.events.list(**params) -> SyncPage[Event]

EventSubscriptions

Types:

from increase.types import EventSubscription

Methods:

• client.event_subscriptions.create(**params) -> EventSubscription
• client.event_subscriptions.retrieve(event_subscription_id) -> EventSubscription
• client.event_subscriptions.update(event_subscription_id, **params) -> EventSubscription
• client.event_subscriptions.list(**params) -> SyncPage[EventSubscription]

RealTimeDecisions

Types:

from increase.types import RealTimeDecision

Methods:

• client.real_time_decisions.retrieve(real_time_decision_id) -> RealTimeDecision
• client.real_time_decisions.action(real_time_decision_id, **params) -> RealTimeDecision

BookkeepingAccounts

Types:

from increase.types import BookkeepingAccount, BookkeepingBalanceLookup

Methods:

• client.bookkeeping_accounts.create(**params) -> BookkeepingAccount
• client.bookkeeping_accounts.update(bookkeeping_account_id, **params) -> BookkeepingAccount
• client.bookkeeping_accounts.list(**params) -> SyncPage[BookkeepingAccount]
• client.bookkeeping_accounts.balance(bookkeeping_account_id, **params) -> BookkeepingBalanceLookup

BookkeepingEntrySets

Types:

from increase.types import BookkeepingEntrySet

Methods:

• client.bookkeeping_entry_sets.create(**params) -> BookkeepingEntrySet
• client.bookkeeping_entry_sets.retrieve(bookkeeping_entry_set_id) -> BookkeepingEntrySet
• client.bookkeeping_entry_sets.list(**params) -> SyncPage[BookkeepingEntrySet]

BookkeepingEntries

Types:

from increase.types import BookkeepingEntry

Methods:

• client.bookkeeping_entries.retrieve(bookkeeping_entry_id) -> BookkeepingEntry
• client.bookkeeping_entries.list(**params) -> SyncPage[BookkeepingEntry]

Groups

Types:

from increase.types import Group

Methods:

• client.groups.retrieve() -> Group

OAuthConnections

Types:

from increase.types import OAuthConnection

Methods:

• client.oauth_connections.retrieve(oauth_connection_id) -> OAuthConnection
• client.oauth_connections.list(**params) -> SyncPage[OAuthConnection]

OAuthTokens

Types:

from increase.types import OAuthToken

Methods:

• client.oauth_tokens.create(**params) -> OAuthToken

IntrafiAccountEnrollments

Types:

from increase.types import IntrafiAccountEnrollment

Methods:

• client.intrafi_account_enrollments.create(**params) -> IntrafiAccountEnrollment
• client.intrafi_account_enrollments.retrieve(intrafi_account_enrollment_id) -> IntrafiAccountEnrollment
• client.intrafi_account_enrollments.list(**params) -> SyncPage[IntrafiAccountEnrollment]
• client.intrafi_account_enrollments.unenroll(intrafi_account_enrollment_id) -> IntrafiAccountEnrollment

IntrafiBalances

Types:

from increase.types import IntrafiBalance

Methods:

• client.intrafi_balances.retrieve(account_id) -> IntrafiBalance

IntrafiExclusions

Types:

from increase.types import IntrafiExclusion

Methods:

• client.intrafi_exclusions.create(**params) -> IntrafiExclusion
• client.intrafi_exclusions.retrieve(intrafi_exclusion_id) -> IntrafiExclusion
• client.intrafi_exclusions.list(**params) -> SyncPage[IntrafiExclusion]
• client.intrafi_exclusions.archive(intrafi_exclusion_id) -> IntrafiExclusion

RealTimePaymentsRequestForPayments

Types:

from increase.types import RealTimePaymentsRequestForPayment

Methods:

• client.real_time_payments_request_for_payments.create(**params) -> RealTimePaymentsRequestForPayment
• client.real_time_payments_request_for_payments.retrieve(request_for_payment_id) -> RealTimePaymentsRequestForPayment
• client.real_time_payments_request_for_payments.list(**params) -> SyncPage[RealTimePaymentsRequestForPayment]

Webhooks

Methods:

• client.webhooks.unwrap(*args) -> object
• client.webhooks.verify_signature(*args) -> None

Simulations

InterestPayments

Methods:

• client.simulations.interest_payments.create(**params) -> Transaction

CardAuthorizations

Types:

from increase.types.simulations import CardAuthorizationCreateResponse

Methods:

• client.simulations.card_authorizations.create(**params) -> CardAuthorizationCreateResponse

CardAuthorizationExpirations

Methods:

• client.simulations.card_authorization_expirations.create(**params) -> CardPayment

CardSettlements

Methods:

• client.simulations.card_settlements.create(**params) -> Transaction

CardReversals

Methods:

• client.simulations.card_reversals.create(**params) -> CardPayment

CardIncrements

Methods:

• client.simulations.card_increments.create(**params) -> CardPayment

CardFuelConfirmations

Methods:

• client.simulations.card_fuel_confirmations.create(**params) -> CardPayment

CardRefunds

Methods:

• client.simulations.card_refunds.create(**params) -> Transaction

CardDisputes

Methods:

• client.simulations.card_disputes.action(card_dispute_id, **params) -> CardDispute

PhysicalCards

Methods:

• client.simulations.physical_cards.advance_shipment(physical_card_id, **params) -> PhysicalCard

DigitalWalletTokenRequests

Types:

from increase.types.simulations import DigitalWalletTokenRequestCreateResponse

Methods:

• client.simulations.digital_wallet_token_requests.create(**params) -> DigitalWalletTokenRequestCreateResponse

InboundFundsHolds

Types:

from increase.types.simulations import InboundFundsHoldReleaseResponse

Methods:

• client.simulations.inbound_funds_holds.release(inbound_funds_hold_id) -> InboundFundsHoldReleaseResponse

AccountTransfers

Methods:

• client.simulations.account_transfers.complete(account_transfer_id) -> AccountTransfer

ACHTransfers

Methods:

• client.simulations.ach_transfers.acknowledge(ach_transfer_id) -> ACHTransfer
• client.simulations.ach_transfers.create_notification_of_change(ach_transfer_id, **params) -> ACHTransfer
• client.simulations.achtransfers.return(ach_transfer_id, **params) -> ACHTransfer
• client.simulations.ach_transfers.settle(ach_transfer_id) -> ACHTransfer
• client.simulations.ach_transfers.submit(ach_transfer_id) -> ACHTransfer

InboundACHTransfers

Methods:

• client.simulations.inbound_ach_transfers.create(**params) -> InboundACHTransfer

WireTransfers

Methods:

• client.simulations.wire_transfers.reverse(wire_transfer_id) -> WireTransfer
• client.simulations.wire_transfers.submit(wire_transfer_id) -> WireTransfer

InboundWireTransfers

Methods:

• client.simulations.inbound_wire_transfers.create(**params) -> InboundWireTransfer

InboundWireDrawdownRequests

Methods:

• client.simulations.inbound_wire_drawdown_requests.create(**params) -> InboundWireDrawdownRequest

CheckTransfers

Methods:

• client.simulations.check_transfers.mail(check_transfer_id) -> CheckTransfer

InboundCheckDeposits

Methods:

• client.simulations.inbound_check_deposits.create(**params) -> InboundCheckDeposit

RealTimePaymentsTransfers

Methods:

• client.simulations.real_time_payments_transfers.complete(real_time_payments_transfer_id, **params) -> RealTimePaymentsTransfer

InboundRealTimePaymentsTransfers

Methods:

• client.simulations.inbound_real_time_payments_transfers.create(**params) -> InboundRealTimePaymentsTransfer

CheckDeposits

Methods:

• client.simulations.check_deposits.reject(check_deposit_id) -> CheckDeposit
• client.simulations.checkdeposits.return(check_deposit_id) -> CheckDeposit
• client.simulations.check_deposits.submit(check_deposit_id) -> CheckDeposit

InboundMailItems

Methods:

• client.simulations.inbound_mail_items.create(**params) -> InboundMailItem

Programs

Methods:

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

AccountStatements

Methods:

• client.simulations.account_statements.create(**params) -> AccountStatement

Documents

Methods:

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