Funding¶
Create ACH Relationship For Account¶
- BrokerClient.create_ach_relationship_for_account(account_id: UUID | str, ach_data: CreateACHRelationshipRequest | CreatePlaidRelationshipRequest) ACHRelationship | Dict[str, Any]¶
Creates a single ACH relationship for the given account.
- Parameters:
account_id (Union[UUID, str]) – The ID of the Account that has the ACH Relationship.
ach_data (Union[CreateACHRelationshipRequest, CreatePlaidRelationshipRequest]) – The request data used to create the ACH relationship.
- Returns:
The ACH relationship that was created.
- Return type:
Get ACH Relationships For Account¶
- BrokerClient.get_ach_relationships_for_account(account_id: UUID | str, statuses: List[ACHRelationshipStatus] | None = None) List[ACHRelationship] | Dict[str, Any]¶
Gets the ACH relationships for an account.
- Parameters:
account_id (Union[UUID, str]) – The ID of the Account to get the ACH relationships for.
statuses (Optional[List[ACHRelationshipStatus]]) – Optionally filter a subset of ACH relationship statuses.
- Returns:
List of ACH relationships returned by the query.
- Return type:
List[ACHRelationship]
Delete ACH Relationship For Account¶
- BrokerClient.delete_ach_relationship_for_account(account_id: UUID | str, ach_relationship_id: UUID | str) None¶
Delete an ACH Relation by its ID.
As the api itself returns a 204 on success this function returns nothing in the successful case and will raise an exception in any other case.
- Parameters:
account_id (Union[UUID, str]) – The ID of the Account which has the ACH relationship to be deleted.
ach_relationship_id (Union[UUID, str]) – The ID of the ACH relationship to delete.
Create Bank For Account¶
- BrokerClient.create_bank_for_account(account_id: UUID | str, bank_data: CreateBankRequest) Bank | Dict[str, Any]¶
Creates a single bank relationship for the given account.
- Parameters:
account_id (Union[UUID, str]) – The ID of the Account to create the bank connection for.
bank_data (CreateBankRequest) – The request data used to create the bank connection.
- Returns:
The Bank that was created.
- Return type:
Get Banks For Account¶
- BrokerClient.get_banks_for_account(account_id: UUID | str, status: RecipientBankStatus | str | None = None, bank_name: str | None = None) List[Bank] | Dict[str, Any]¶
Gets the Banks for an account.
- Parameters:
account_id (Union[UUID, str]) – The ID of the Account to get the Banks for.
status (Optional[Union[RecipientBankStatus, str]]) –
ACTIVEorINACTIVE.bank_name (Optional[str]) – Filter to recipient banks with this name.
- Returns:
List of Banks returned by the query.
- Return type:
List[Bank]
Delete Bank For Account¶
- BrokerClient.delete_bank_for_account(account_id: UUID | str, bank_id: UUID | str) None¶
Delete a Bank by its ID.
As the api itself returns a 204 on success this function returns nothing in the successful case and will raise an exception in any other case.
- Parameters:
account_id (Union[UUID, str]) – The ID of the Account which has the Bank to be deleted.
bank_id (Union[UUID, str]) – The ID of the Bank to delete.
Create Transfer For Account¶
- BrokerClient.create_transfer_for_account(account_id: UUID | str, transfer_data: CreateACHTransferRequest | CreateBankTransferRequest) Transfer | Dict[str, Any]¶
Creates a single Transfer for the given account.
- Parameters:
account_id (Union[UUID, str]) – The ID of the Account to create the bank connection for.
transfer_data (Union[CreateACHTransferRequest, CreateBankTransferRequest]) – The request data used to create the bank connection.
- Returns:
The Transfer that was created.
- Return type:
Get Transfers For Account¶
- BrokerClient.get_transfers_for_account(account_id: UUID | str, transfers_filter: GetTransfersRequest | None = None, max_items_limit: int | None = None, handle_pagination: PaginationType | None = None) List[Transfer] | Iterator[List[Transfer]] | List[Dict[str, Any]] | Iterator[List[Dict[str, Any]]]¶
Gets the transfers for an account.
- Parameters:
account_id (Union[UUID, str]) – The ID of the Account to create the bank connection for.
transfers_filter (Optional[GetTransferRequest]) – The various filtering parameters to apply to the request.
max_items_limit (Optional[int]) – A maximum number of items to return over all for when handle_pagination is of type PaginationType.FULL. Ignored otherwise.
handle_pagination (Optional[PaginationType]) – What kind of pagination you want. If None then defaults to PaginationType.FULL.
- Returns:
- Either a list or
an Iterator of lists of Transfer child classes (or raw dictionaries when raw_data=True).
- Return type:
Union[List[Transfer], Iterator[List[Transfer]], List[RawData], Iterator[List[RawData]]]
Cancel Transfer For Account¶
- BrokerClient.cancel_transfer_for_account(account_id: UUID | str, transfer_id: UUID | str) None¶
Cancel a Transfer by its ID.
As the api itself returns a 204 on success this function returns nothing in the successful case and will raise an exception in any other case.
- Parameters:
account_id (Union[UUID, str]) – The ID of the Account which has the Transfer to be canceled.
transfer_id (Union[UUID, str]) – The ID of the Transfer to cancel.