Skip to content
campaiDeveloper
campai.com

Accounts

API Endpoints

Link FinAPI account

Links a detached cash account to a FinAPI account at the same bank with the same IBAN.

POST/{organizationId}/finance/cash/accounts/{cashAccountId}/linkFinApiAccount

Create cash account

Creates a new cash account for a given mandate

POST/{organizationId}/{mandateId}/finance/cash/accounts

List cash accounts

Returns a list of cash accounts for a given mandate

POST/{organizationId}/{mandateId}/finance/cash/accounts/list

Get cash account

Returns a specific cash account for a given mandate

GET/{organizationId}/{mandateId}/finance/cash/accounts/{cashAccountId}

Update cash account

Updates certain settings of a specific cash account for a given mandate

POST/{organizationId}/{mandateId}/finance/cash/accounts/{cashAccountId}

Delete cash account

Deletes a specific cash account for a given mandate

DELETE/{organizationId}/{mandateId}/finance/cash/accounts/{cashAccountId}

Get cash account delete info

Returns whether a specific cash account can be deleted for a given mandate

GET/{organizationId}/{mandateId}/finance/cash/accounts/{cashAccountId}/deleteInfo

Archive cash account

Archives a specific cash account for a given mandate

POST/{organizationId}/{mandateId}/finance/cash/accounts/{cashAccountId}/archive

Unarchive cash account

Unarchives a specific cash account for a given mandate

POST/{organizationId}/{mandateId}/finance/cash/accounts/{cashAccountId}/unarchive

Synchronize cash account

Synchronizes a connected cash account for a given mandate and returns the web form URL and ID if needed

GET/{organizationId}/{mandateId}/finance/cash/accounts/{cashAccountId}/sync

Refresh capabilities

Refreshes the capabilities of the cash accounts for a given bank connection

POST/{organizationId}/finance/cash/accounts/refreshCapabilities