Accounts

List accounts

SecurityToken
Request
query Parameters
reference
string
reference__contains
string
name
string
primary
string
currency
string
active
string
balance
number
balance__gt
number
balance__lt
number
recon
string
orderby
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/accounts/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Create account

SecurityToken
Request
Request Body schema: application/json
name
required
string (Name) non-empty
label
string or null (Label) [ 1 .. 200 ] characters
Responses
201
post/accounts/
Request samples
application/json
{
  • "name": "string",
  • "label": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve account

SecurityToken
Request
path Parameters
reference
required
string
Responses
200
get/accounts/{reference}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List account currencies

SecurityToken
Request
path Parameters
reference
required
string
query Parameters
account__name
string
account__name__contains
string
active
string
account
string
currency
string
balance
number
balance__gt
number
balance__lt
number
historic
string
orderby
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/accounts/{reference}/currencies/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Create account currency

SecurityToken
Request
path Parameters
reference
required
string
Request Body schema: application/json
currency
required
string (Currency) non-empty
active
boolean (Active)
Responses
201
post/accounts/{reference}/currencies/
Request samples
application/json
{
  • "currency": "string",
  • "active": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve account currency

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
Responses
200
get/accounts/{reference}/currencies/{code}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Update account currency

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
Request Body schema: application/json
active
required
boolean (Active)
Responses
200
put/accounts/{reference}/currencies/{code}/
Request samples
application/json
{
  • "active": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Partially update account currency

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
Request Body schema: application/json
active
required
boolean (Active)
Responses
200
patch/accounts/{reference}/currencies/{code}/
Request samples
application/json
{
  • "active": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List account currency fees

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
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/accounts/{reference}/currencies/{code}/fees/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve account currency fees

SecurityToken
Request
path Parameters
code
required
string
fee_id
required
string
reference
required
string
Responses
200
get/accounts/{reference}/currencies/{code}/fees/{fee_id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List account currency limits

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
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/accounts/{reference}/currencies/{code}/limits/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve account currency limit

SecurityToken
Request
path Parameters
code
required
string
limit_id
required
string
reference
required
string
Responses
200
get/accounts/{reference}/currencies/{code}/limits/{limit_id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}