The Bank Account object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

account_name string required
account string
bank string required
account_type string
account_subtype string
is_default boolean

Default: false

is_company_account boolean

Default: false

company string
party_type string
party string
iban string
bank_account_no string
integration_id string
last_integration_date string
mask string
branch_code string
disabled boolean

Default: false

The Bank Account object 
{
  "id": "bank-account_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_name": "account_name_example",
  "account": "account_example",
  "bank": "bank_example",
  "account_type": "account_type_example",
  "account_subtype": "account_subtype_example",
  "is_default": false,
  "is_company_account": false,
  "company": "Example Corp",
  "party_type": "party_type_example",
  "party": "party_example",
  "iban": "iban_example",
  "bank_account_no": "bank_account_no_example",
  "integration_id": "integration_id_example",
  "last_integration_date": "2024-01-15",
  "mask": "mask_example",
  "branch_code": "branch_code_example",
  "disabled": false
}
GET /api/accounts/bank-account/{id}

Retrieve a bank account

Retrieves the details of an existing bank account. Supply the unique bank account ID that was returned from a previous request.

Path parameters

id string required

The identifier of the bank account to retrieve.

Returns

Returns the bank account object if a valid identifier was provided.

GET /api/accounts/bank-account/{id} 
curl https://api.overplane.dev/api/accounts/bank-account/bank-account_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "bank-account_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_name": "account_name_example",
  "account": "account_example",
  "bank": "bank_example",
  "account_type": "account_type_example",
  "account_subtype": "account_subtype_example",
  "is_default": false,
  "is_company_account": false,
  "company": "Example Corp",
  "party_type": "party_type_example",
  "party": "party_example",
  "iban": "iban_example",
  "bank_account_no": "bank_account_no_example",
  "integration_id": "integration_id_example",
  "last_integration_date": "2024-01-15",
  "mask": "mask_example",
  "branch_code": "branch_code_example",
  "disabled": false
}
GET /api/accounts/bank-account

List all bank accounts

Returns a list of bank accounts. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of bank account objects.

GET /api/accounts/bank-account 
curl https://api.overplane.dev/api/accounts/bank-account \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "bank-account_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "account_name": "account_name_example",
      "account": "account_example",
      "bank": "bank_example",
      "account_type": "account_type_example",
      "account_subtype": "account_subtype_example",
      "is_default": false,
      "is_company_account": false,
      "company": "Example Corp",
      "party_type": "party_type_example",
      "party": "party_example",
      "iban": "iban_example",
      "bank_account_no": "bank_account_no_example",
      "integration_id": "integration_id_example",
      "last_integration_date": "2024-01-15",
      "mask": "mask_example",
      "branch_code": "branch_code_example",
      "disabled": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/bank-account

Create a bank account

Creates a new bank account object.

Body parameters

account_name string required
account string
bank string required
account_type string
account_subtype string
is_default boolean

Default: false

is_company_account boolean

Default: false

company string
party_type string
party string
iban string
bank_account_no string
integration_id string
last_integration_date string
mask string
branch_code string
disabled boolean

Default: false

Returns

Returns the newly created bank account object if the call succeeded.

POST /api/accounts/bank-account 
curl https://api.overplane.dev/api/accounts/bank-account \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"account_name":"account_name_example","bank":"bank_example"}'
Response 
{
  "id": "bank-account_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_name": "account_name_example",
  "account": "account_example",
  "bank": "bank_example",
  "account_type": "account_type_example",
  "account_subtype": "account_subtype_example",
  "is_default": false,
  "is_company_account": false,
  "company": "Example Corp",
  "party_type": "party_type_example",
  "party": "party_example",
  "iban": "iban_example",
  "bank_account_no": "bank_account_no_example",
  "integration_id": "integration_id_example",
  "last_integration_date": "2024-01-15",
  "mask": "mask_example",
  "branch_code": "branch_code_example",
  "disabled": false
}
PATCH /api/accounts/bank-account/{id}

Update a bank account

Updates the specified bank account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the bank account to update.

Body parameters

account_name string
account string
bank string
account_type string
account_subtype string
is_default boolean

Default: false

is_company_account boolean

Default: false

company string
party_type string
party string
iban string
bank_account_no string
integration_id string
last_integration_date string
mask string
branch_code string
disabled boolean

Default: false

Returns

Returns the updated bank account object.

PATCH /api/accounts/bank-account/{id} 
curl https://api.overplane.dev/api/accounts/bank-account/bank-account_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"account_name":"account_name_example","account":"account_example"}'
Response 
{
  "id": "bank-account_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_name": "account_name_example",
  "account": "account_example",
  "bank": "bank_example",
  "account_type": "account_type_example",
  "account_subtype": "account_subtype_example",
  "is_default": false,
  "is_company_account": false,
  "company": "Example Corp",
  "party_type": "party_type_example",
  "party": "party_example",
  "iban": "iban_example",
  "bank_account_no": "bank_account_no_example",
  "integration_id": "integration_id_example",
  "last_integration_date": "2024-01-15",
  "mask": "mask_example",
  "branch_code": "branch_code_example",
  "disabled": false
}
DELETE /api/accounts/bank-account/{id}

Delete a bank account

Permanently deletes a bank account. This cannot be undone.

Path parameters

id string required

The identifier of the bank account to delete.

Returns

Returns a confirmation that the bank account has been deleted.

DELETE /api/accounts/bank-account/{id} 
curl https://api.overplane.dev/api/accounts/bank-account/bank-account_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "bank-account_abc123",
  "deleted": true
}