Rehive logo
Powered by Redocly

accounts

List accounts

SecurityapiAuth
Request
query Parameters
active
boolean
available_balance
number
available_balance__gt
number
available_balance__lt
number
balance
number
balance__gt
number
balance__lt
number
created
string <date-time>
created__gt
string <date-time>
created__gte
string <date-time>
created__lt
string <date-time>
created__lte
string <date-time>
currency
string
definition
string
name
string
orderby
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

primary
boolean
recon
boolean
reference
string
reference__contains
string
updated
string <date-time>
updated__gt
string <date-time>
updated__gte
string <date-time>
updated__lt
string <date-time>
updated__lte
string <date-time>
Responses
200
get/3/accounts/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create account

SecurityapiAuth
Request
Request Body schema:
name
string <= 200 characters
label
string or null <= 200 characters
Responses
201
post/3/accounts/
Request samples
{
  • "name": "string",
  • "label": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve account

SecurityapiAuth
Request
path Parameters
reference
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/accounts/{reference}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

List account currencies

SecurityapiAuth
Request
path Parameters
reference
required
string^[a-zA-Z0-9\_\-]+$
query Parameters
account
string
account__definition
string
account__name
string
account__name__contains
string
active
boolean
available_balance
number
available_balance__gt
number
available_balance__lt
number
balance
number
balance__gt
number
balance__lt
number
created
string <date-time>
created__gt
string <date-time>
created__gte
string <date-time>
created__lt
string <date-time>
created__lte
string <date-time>
currency
string
exclude__transactions__created__gt
string <date-time>
exclude__transactions__created__lt
string <date-time>
historic
string
orderby
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

transactions__created__gt
string <date-time>
transactions__created__lt
string <date-time>
updated
string <date-time>
updated__gt
string <date-time>
updated__gte
string <date-time>
updated__lt
string <date-time>
updated__lte
string <date-time>
Responses
200
get/3/accounts/{reference}/currencies/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create account currency

SecurityapiAuth
Request
path Parameters
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
required
currency
required
string
active
boolean
Responses
201
post/3/accounts/{reference}/currencies/
Request samples
{
  • "currency": "string",
  • "active": true
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve account currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/accounts/{reference}/currencies/{code}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update account currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
required
active
required
boolean
Responses
200
put/3/accounts/{reference}/currencies/{code}/
Request samples
{
  • "active": true
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update account currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
active
boolean
Responses
200
patch/3/accounts/{reference}/currencies/{code}/
Request samples
{
  • "active": true
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

List account currency fees

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
reference
required
string^[a-zA-Z0-9\_\-]+$
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/accounts/{reference}/currencies/{code}/fees/
Response samples
application/json
{}

Retrieve account currency fees

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
fee_id
required
string^\d+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/accounts/{reference}/currencies/{code}/fees/{fee_id}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

List account currency limits

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
reference
required
string^[a-zA-Z0-9\_\-]+$
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/accounts/{reference}/currencies/{code}/limits/
Response samples
application/json
{}

Retrieve account currency limit

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
limit_id
required
string^\d+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/accounts/{reference}/currencies/{code}/limits/{limit_id}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}
➔ Next to auth