INinvoiceninja
bank_integrations

Removes an account from the integration

Changed on

Removes an account from the integration

post/api/v1/bank_integrations/remove_account/account_id

Request

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

Returns the bank_integration object

idstring

The bank integration hashed id

user_idstring

The user hashed id

provider_bank_namestring

The providers bank name

bank_account_idinteger

The bank account id

bank_account_namestring

The name of the account

bank_account_numberstring

The account number

bank_account_statusstring

The status of the bank account

bank_account_typestring

The type of account

balancenumber

The current bank balance if available

currencystring

iso_3166_3 code

Example response

{
  "id": "AS3df3A",
  "user_id": "AS3df3A",
  "provider_bank_name": "Chase Bank",
  "bank_account_id": 1233434,
  "bank_account_name": "My Checking Acc",
  "bank_account_number": "111 234 2332",
  "bank_account_status": "ACTIVE",
  "bank_account_type": "CREDITCARD",
  "balance": 1000000,
  "currency": "USD"
}

Changes

  • 69a36036d334Revision changes
    • info

      the response optional property became read-only for the status

  • 8e82a2bd77e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status