The Bank 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.

bank_name string required
swift_number string
website string
plaid_access_token string
The Bank object 
{
  "id": "bank_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "bank_name": "bank_name_example",
  "swift_number": "swift_number_example",
  "website": "website_example",
  "plaid_access_token": "plaid_access_token_example"
}
GET /api/accounts/bank/{id}

Retrieve a bank

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

Path parameters

id string required

The identifier of the bank to retrieve.

Returns

Returns the bank object if a valid identifier was provided.

GET /api/accounts/bank/{id} 
curl https://api.overplane.dev/api/accounts/bank/bank_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "bank_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "bank_name": "bank_name_example",
  "swift_number": "swift_number_example",
  "website": "website_example",
  "plaid_access_token": "plaid_access_token_example"
}
GET /api/accounts/bank

List all banks

Returns a list of banks. 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 objects.

GET /api/accounts/bank 
curl https://api.overplane.dev/api/accounts/bank \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "bank_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "bank_name": "bank_name_example",
      "swift_number": "swift_number_example",
      "website": "website_example",
      "plaid_access_token": "plaid_access_token_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/bank

Create a bank

Creates a new bank object.

Body parameters

bank_name string required
swift_number string
website string
plaid_access_token string

Returns

Returns the newly created bank object if the call succeeded.

POST /api/accounts/bank 
curl https://api.overplane.dev/api/accounts/bank \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"bank_name":"bank_name_example"}'
Response 
{
  "id": "bank_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "bank_name": "bank_name_example",
  "swift_number": "swift_number_example",
  "website": "website_example",
  "plaid_access_token": "plaid_access_token_example"
}
PATCH /api/accounts/bank/{id}

Update a bank

Updates the specified bank 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 to update.

Body parameters

bank_name string
swift_number string
website string
plaid_access_token string

Returns

Returns the updated bank object.

PATCH /api/accounts/bank/{id} 
curl https://api.overplane.dev/api/accounts/bank/bank_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"bank_name":"bank_name_example","swift_number":"swift_number_example"}'
Response 
{
  "id": "bank_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "bank_name": "bank_name_example",
  "swift_number": "swift_number_example",
  "website": "website_example",
  "plaid_access_token": "plaid_access_token_example"
}
DELETE /api/accounts/bank/{id}

Delete a bank

Permanently deletes a bank. This cannot be undone.

Path parameters

id string required

The identifier of the bank to delete.

Returns

Returns a confirmation that the bank has been deleted.

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

Line items

Child objects that belong to this bank. These are accessed via the parent's ID.

Bank Transaction Mapping

Attributes

idx integer
bank_id string required
bank_transaction_field string required
file_field string required

Endpoints

GET /api/accounts/bank-transaction-mapping?parent_id={id}
POST /api/accounts/bank-transaction-mapping
PATCH /api/accounts/bank-transaction-mapping/{id}
DELETE /api/accounts/bank-transaction-mapping/{id}
POST /api/accounts/bank-transaction-mapping/reorder
Bank Transaction Mapping object 
{
  "id": "bank-transaction-mapping_abc123",
  "idx": 1,
  "bank_id": "bank_id_example",
  "bank_transaction_field": "bank_transaction_field_example",
  "file_field": "file_field_example"
}