Rehive logo
Powered by Redocly

accounts

List accounts

SecurityapiAuth
Request
query Parameters
active
boolean
archived
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
group
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
search
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>
user
string
user__isnull
boolean
Responses
200
get/3/admin/accounts/
Request samples 
rehive.admin.accounts.get().then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create accounts

SecurityapiAuth
Request
Request Body schema:
reference
string or null <= 50 characters
name
string <= 200 characters
Default: "default"
label
string or null <= 200 characters
primary
boolean
recon
boolean
user
string or null
object or null
archived
boolean
Default: false
Responses
201
post/3/admin/accounts/
Request samples
{
  • "reference": "string",
  • "name": "default",
  • "label": "string",
  • "primary": true,
  • "recon": true,
  • "user": "string",
  • "metadata": {
    },
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve account

SecurityapiAuth
Request
path Parameters
reference
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/admin/accounts/{reference}/
Request samples 
rehive.admin.accounts.get({
  "reference: accountReference"
}).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update account

SecurityapiAuth
Request
path Parameters
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
name
string <= 200 characters
Default: "default"
label
string or null <= 200 characters
primary
boolean
recon
boolean
object or null
archived
boolean
Default: false
Responses
200
put/3/admin/accounts/{reference}/
Request samples
{
  • "name": "default",
  • "label": "string",
  • "primary": true,
  • "recon": true,
  • "metadata": {
    },
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update account

SecurityapiAuth
Request
path Parameters
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
name
string <= 200 characters
Default: "default"
label
string or null <= 200 characters
primary
boolean
recon
boolean
object or null
archived
boolean
Default: false
Responses
200
patch/3/admin/accounts/{reference}/
Request samples
{
  • "name": "default",
  • "label": "string",
  • "primary": true,
  • "recon": true,
  • "metadata": {
    },
  • "archived": false
}
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
archived
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>
user
string
Responses
200
get/3/admin/accounts/{reference}/currencies/
Request samples 
admin.accounts.currencies.get(accountReference)
.then(function (res) {
    ...
}, function (err) {
    ...
});
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/admin/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/admin/accounts/{reference}/currencies/{code}/
Request samples 
rehive.admin.accounts.currencies.get(accountReference, {
  "code": currencyCode
}).then(function (res) {
    ...
}, function (err) {
    ...
});
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
archived
boolean
Default: false
Responses
200
put/3/admin/accounts/{reference}/currencies/{code}/
Request samples
{
  • "active": true,
  • "archived": false
}
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
archived
boolean
Default: false
Responses
200
patch/3/admin/accounts/{reference}/currencies/{code}/
Request samples
{
  • "active": true,
  • "archived": false
}
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\_\-]+$
Responses
200
get/3/admin/accounts/{reference}/currencies/{code}/fees/
Request samples 
rehive.admin.accounts.currencies.fees.get(
  accountReference, currencyCode).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Create account currency fees

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
required
name
string or null <= 50 characters
value
integer >= 0
percentage
number <double> [ 0 .. 1000 )
tx_type
required
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
description
string or null <= 250 characters
debit_account
string or null
credit_account
string or null
debit_subtype
string or null
credit_subtype
string or null
inferred
boolean
Responses
201
post/3/admin/accounts/{reference}/currencies/{code}/fees/
Request samples
{
  • "name": "string",
  • "value": 0,
  • "percentage": 0,
  • "tx_type": "credit",
  • "subtype": "string",
  • "description": "string",
  • "debit_account": "string",
  • "credit_account": "string",
  • "debit_subtype": "string",
  • "credit_subtype": "string",
  • "inferred": true
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve account currency fee

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
fee_id
required
string^\d+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/admin/accounts/{reference}/currencies/{code}/fees/{fee_id}/
Request samples 
rehive.admin.accounts.currencies.fees.get(
  accountReference, currencyCode, {
    "id": fee_id
}).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update account currency fee

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
fee_id
required
string^\d+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
required
name
string or null <= 50 characters
value
integer >= 0
percentage
number <double> [ 0 .. 1000 )
tx_type
required
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
description
string or null <= 250 characters
debit_account
string or null
credit_account
string or null
debit_subtype
string or null
credit_subtype
string or null
inferred
boolean
Responses
200
put/3/admin/accounts/{reference}/currencies/{code}/fees/{fee_id}/
Request samples
{
  • "name": "string",
  • "value": 0,
  • "percentage": 0,
  • "tx_type": "credit",
  • "subtype": "string",
  • "description": "string",
  • "debit_account": "string",
  • "credit_account": "string",
  • "debit_subtype": "string",
  • "credit_subtype": "string",
  • "inferred": true
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update account currency fee

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
fee_id
required
string^\d+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
name
string or null <= 50 characters
value
integer >= 0
percentage
number <double> [ 0 .. 1000 )
tx_type
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
description
string or null <= 250 characters
debit_account
string or null
credit_account
string or null
debit_subtype
string or null
credit_subtype
string or null
inferred
boolean
Responses
200
patch/3/admin/accounts/{reference}/currencies/{code}/fees/{fee_id}/
Request samples
{
  • "name": "string",
  • "value": 0,
  • "percentage": 0,
  • "tx_type": "credit",
  • "subtype": "string",
  • "description": "string",
  • "debit_account": "string",
  • "credit_account": "string",
  • "debit_subtype": "string",
  • "credit_subtype": "string",
  • "inferred": true
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete account currency fee

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
fee_id
required
string^\d+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
delete/3/admin/accounts/{reference}/currencies/{code}/fees/{fee_id}/
Request samples 
rehive.admin.accounts.currencies.fees.delete(
  accountReference, currencyCode, feeId).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "sucess"
}

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/admin/accounts/{reference}/currencies/{code}/limits/
Request samples 
rehive.admin.accounts.currencies.limits.get(
  accountReference, currencyCode
).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{}

List account currency limits

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
required
value
required
integer >= 0
type
required
string
  • max - Maximum
  • day_max - Maximum per day
  • month_max - Maximum per month
  • min - Minimum
  • overdraft - Overdraft
Enum: "max" "day_max" "month_max" "min" "overdraft"
tx_type
required
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
Responses
201
post/3/admin/accounts/{reference}/currencies/{code}/limits/
Request samples
{
  • "value": 0,
  • "type": "max",
  • "tx_type": "credit",
  • "subtype": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve account asset 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/admin/accounts/{reference}/currencies/{code}/limits/{limit_id}/
Request samples 
rehive.admin.accounts.currencies.limits.get(
  accountReference, currencyCode, {"id": limitId}
).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update account currency limits

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
limit_id
required
string^\d+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
required
value
required
integer >= 0
type
required
string
  • max - Maximum
  • day_max - Maximum per day
  • month_max - Maximum per month
  • min - Minimum
  • overdraft - Overdraft
Enum: "max" "day_max" "month_max" "min" "overdraft"
tx_type
required
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
Responses
200
put/3/admin/accounts/{reference}/currencies/{code}/limits/{limit_id}/
Request samples
{
  • "value": 0,
  • "type": "max",
  • "tx_type": "credit",
  • "subtype": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update account currency limits

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
limit_id
required
string^\d+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
value
integer >= 0
type
string
  • max - Maximum
  • day_max - Maximum per day
  • month_max - Maximum per month
  • min - Minimum
  • overdraft - Overdraft
Enum: "max" "day_max" "month_max" "min" "overdraft"
tx_type
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
Responses
200
patch/3/admin/accounts/{reference}/currencies/{code}/limits/{limit_id}/
Request samples
{
  • "value": 0,
  • "type": "max",
  • "tx_type": "credit",
  • "subtype": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete account currency limits

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
limit_id
required
string^\d+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
delete/3/admin/accounts/{reference}/currencies/{code}/limits/{limit_id}/
Request samples 
rehive.admin.accounts.currencies.limits.delete(
  accountReference, currencyCode, limitId
).then(function (res) {
    ...
}, function (err) {
    ...
});.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "sucess"
}

List account currency settings

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/admin/accounts/{reference}/currencies/{code}/settings/
Request samples 
rehive.admin.accounts.currencies.settings.get(
  accountReference, currencyCode
).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update account currency settings

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

Partially update account currency settings

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
reference
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
allow_transactions
boolean
allow_debit_transactions
boolean
allow_credit_transactions
boolean
disallowed_transaction_subtypes
Array of integers
Responses
200
patch/3/admin/accounts/{reference}/currencies/{code}/settings/
Request samples
{
  • "allow_transactions": true,
  • "allow_debit_transactions": true,
  • "allow_credit_transactions": true,
  • "disallowed_transaction_subtypes": [
    ]
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}
➔ Next to auth