Rehive logo
Powered by Redocly

bank-accounts

List company bank accounts

SecurityapiAuth
Request
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/bank-accounts/
Request samples 
rehive.admin.bankAccounts.get().then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create company bank account

SecurityapiAuth
Request
Request Body schema:
name
string or null <= 200 characters
number
string or null <= 200 characters
type
string or null <= 200 characters
bank_name
string or null <= 200 characters
bank_code
string or null <= 50 characters
branch_code
string or null <= 50 characters
object (CompanyBankBranchAddress)

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

routing_number
string or null <= 50 characters
swift
string or null <= 16 characters
iban
string or null <= 50 characters
bic
string or null <= 16 characters
object or null
archived
boolean
Default: false
action
string or null
  • deposit - Deposit
Enum: "deposit" null
Responses
201
post/3/admin/bank-accounts/
Request samples
{
  • "name": "string",
  • "number": "string",
  • "type": "string",
  • "bank_name": "string",
  • "bank_code": "string",
  • "branch_code": "string",
  • "branch_address": {
    },
  • "routing_number": "string",
  • "swift": "string",
  • "iban": "string",
  • "bic": "string",
  • "metadata": {
    },
  • "archived": false,
  • "action": "deposit"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve company bank account

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
get/3/admin/bank-accounts/{id}/
Request samples 
rehive.admin.bank_accounts.get(
  {"id": bankAccountsId}
).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update company bank account

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
name
string or null <= 200 characters
number
string or null <= 200 characters
type
string or null <= 200 characters
bank_name
string or null <= 200 characters
bank_code
string or null <= 50 characters
branch_code
string or null <= 50 characters
object (CompanyBankBranchAddress)

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

routing_number
string or null <= 50 characters
swift
string or null <= 16 characters
iban
string or null <= 50 characters
bic
string or null <= 16 characters
object or null
archived
boolean
Default: false
action
string or null
  • deposit - Deposit
Enum: "deposit" null
Responses
200
put/3/admin/bank-accounts/{id}/
Request samples
{
  • "name": "string",
  • "number": "string",
  • "type": "string",
  • "bank_name": "string",
  • "bank_code": "string",
  • "branch_code": "string",
  • "branch_address": {
    },
  • "routing_number": "string",
  • "swift": "string",
  • "iban": "string",
  • "bic": "string",
  • "metadata": {
    },
  • "archived": false,
  • "action": "deposit"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update company bank account

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
name
string or null <= 200 characters
number
string or null <= 200 characters
type
string or null <= 200 characters
bank_name
string or null <= 200 characters
bank_code
string or null <= 50 characters
branch_code
string or null <= 50 characters
object (CompanyBankBranchAddress)

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

routing_number
string or null <= 50 characters
swift
string or null <= 16 characters
iban
string or null <= 50 characters
bic
string or null <= 16 characters
object or null
archived
boolean
Default: false
action
string or null
  • deposit - Deposit
Enum: "deposit" null
Responses
200
patch/3/admin/bank-accounts/{id}/
Request samples
{
  • "name": "string",
  • "number": "string",
  • "type": "string",
  • "bank_name": "string",
  • "bank_code": "string",
  • "branch_code": "string",
  • "branch_address": {
    },
  • "routing_number": "string",
  • "swift": "string",
  • "iban": "string",
  • "bic": "string",
  • "metadata": {
    },
  • "archived": false,
  • "action": "deposit"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete company bank account

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
delete/3/admin/bank-accounts/{id}/
Request samples 
rehive.admin.bankAccounts.delete(bankAccountsId).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "sucess"
}

List company bank account currencies

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/bank-accounts/{id}/currencies/
Request samples 
rehive.admin.bankAccounts.currencies.get(bankAccountsId)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{}

Create company bank account currency

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
required
currency
required
string
Responses
201
post/3/admin/bank-accounts/{id}/currencies/
Request samples
{
  • "currency": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve company bank account currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
id
required
string^\d+$
Responses
200
get/3/admin/bank-accounts/{id}/currencies/{code}/
Request samples 
rehive.admin.bankAccounts.currencies.get(bankAccountsId, currencyCode)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete company bank account currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
id
required
string^\d+$
Responses
200
delete/3/admin/bank-accounts/{id}/currencies/{code}/
Request samples 
rehive.admin.bankAccounts.currencies.delete(
  bankAccountsId, currencyCode
)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "sucess"
}
➔ Next to company