/
Bank Account Object v2

Bank Account Object v2

Owned by Matt Sullivan (Unlicensed)
Last updated: Aug 24, 2022
2 min read

Path Parameters

HTTP Header

api-key status:REQUIRED
string - Your Accelerate API Key

URL Substitution

subdomain status:Required
string - Your Accelerate subdomain

relationship ID status:REQUIRED
integer - ID of your chosen relationship

bank account ID status:optional
integer - ID of your chosen bank account

Bank Account Requests status:GEt status:Post status:put

status:Get status:Post - Retrieve a bank account from a relationship or insert a new bank account into a relationship

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/bank-accounts/

Example Payload status:POSt

{ "bank_account_type": "Current account", "bank_name": "LLOYDS BANK PLC", "account_name": "Joe Bloggs", "sort_code": "775008", "account_number": "00000000", "address_line_1": "PO BOX 1000", "town_city": "Birmingham", "postcode": "BX1 1LT" }

Response

status:200
Returned if the request is successful.

{ "items": [ { "bank_account_id": 69630, "bank_account_type": "Current account", "bank_name": "LLOYDS BANK PLC", "account_name": "Joe Bloggs", "sort_code": "775008", "account_number": "00000000", "address_line_1": "PO BOX 1000", "address_line_2": null, "town_city": "Birmingham", "postcode": "BX1 1LT", "year_opened": null, "manual_entry_flag": "N" } ], "first": { "$ref": "https://example.quotevineapp.com/qvine/quotevine/api/v2/relationships/2300191/bank-accounts/" } }

status:400
Returned if the request sent is invalid.

status:404
Returned if the request is not found or the user does not have permission to view it.

status:Put - Update an existing bank account on a relationship

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/bank-accounts/{id}/

Example Payload status:PUT

{ "bank_account_type": "Other account", "bank_name": "LLOYDS BANK PLC", "account_name": "Joe Bloggs", "sort_code": "775008", "account_number": "00000000", "town_city": "Birmingham", "postcode": "BX5 5LT" }

Response

status:200
Returned if the request is successful.

A successful put request will not return a response body.

{}

status:400
Returned if the request sent is invalid.

status:404
Returned if the request is not found or the user does not have permission to view it.

Bank Account Attributes

When updating/adding a new Bank Account via the API, there are a number of fields needed.

Mandatory Fields

bank_account_type - string
Must be either Current Account or Other Account

bank_name- string

account_name - string

sort_code - string

account_number - string

town_city - string

postcode - string

Non Mandatory Fields

bank_account_id - number
Must not be supplied when using status:Post or status:Put

address_line_1 - string

address_line_2 - string

year_opened - number
Must be a valid year

manual_entry_flag - string
Y or N. Must not be supplied when using status:Put

Related content