API Reference

for object "Bank account"

Find here the list of actions to apply on the objects, and the data reference for this object.




What is a bank account ?

It contains all your bank information




Getting the bank accounts list

GET /bank_accounts.xml

Returns all bank accounts, page by page
Add a page parameter to navigate




Getting a single bank account

GET /bank_accounts/#{id}.xml

Returns a single bank account, identified by its id




Creating a new bank account

POST /bank_accounts.xml

Creates a new bank account, and returns the bank account data




Updating an existing bank account

PUT /bank_accounts/#{id}.xml

Updates some fields of an existing bank account




Deleting an existing bank account

DELETE /bank_accounts/#{id}.xml

Deletes the bank account identified by its id




Object data

<bank_account>
 <id>id of this object</id>
 <name>your name for this bank account</name>
 <bank_name>name of bank</bank_name>
 <bank_code>code of bank</bank_code>
 <bank_desk>number of branch</bank_desk>
 <bank_account>your account</bank_account>
 <bank_key>your account key</bank_key>
 <bank_iban>your account iban code</bank_iban>
 <bank_bic>your account bics code</bank_bic>
 <bank_dom>name of branch</bank_dom>
 <street_address>address of branch</street_address>
 <street_address2>address of branch</street_address2>
 <zip_code>zip of branch</zip_code>
 <city>city of branch</city>
 <country>France</country>
</bank_account>