Accounts

get

Get a paginated list of account's currency deposits information in the system

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/deposits
200

Successfully retrieved a list of items.

Get account's withdrawals

get

Get a paginated list of account's currency withdrawals information in the system

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/withdrawals
200

Successfully retrieved a list of items.

get

Retrieve a list of accounts available in the system

Query parameters
modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:
orderanyOptional

Array of fields and directions to order. Supported fields: createdAt, type, status

Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts
200

Successfully retrieved a list of items.

post

Create a new investor account.

Body
institutionSectorCodestring · enumRequired

Institutional Sector Code from 2010 ESA Standards

Possible values:
walletTypestring · enumRequired

Indicates that funds are owned by either broker or client

Possible values:
Responses
post
/accounts
201

Created investor account

get

Get specific account information in the system

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Responses
chevron-right
200

Found account

application/json
createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

nodeIdstring · uuidRequired

Unique UUID of the node that manages this account

Example: fb098963-aa15-48e0-94cf-84d5b3829044
addressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
typestring · enumRequired

Type of account

Possible values:
institutionSectorCodestring · enumRequired

Institutional Sector Code from 2010 ESA Standards

Possible values:
walletTypestring · enumRequired

Indicates that funds are owned by either broker or client

Possible values:
statusstring · enumRequired

Status of the account:

  • active - account is allowed to interact with the system
  • frozen - no assets can be moved around
  • deleted - no further actions can be done
Possible values:
openedAtstring · date-timeRequired

Opened date

get
/accounts/{accountAddress}
200

Found account

delete

Changes investor account status to deleted and disables account in the system

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Responses
chevron-right
200

Deleted investor account

application/json
createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

nodeIdstring · uuidRequired

Unique UUID of the node that manages this account

Example: fb098963-aa15-48e0-94cf-84d5b3829044
addressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
typestring · enumRequired

Type of account

Possible values:
institutionSectorCodestring · enumRequired

Institutional Sector Code from 2010 ESA Standards

Possible values:
walletTypestring · enumRequired

Indicates that funds are owned by either broker or client

Possible values:
statusstring · enumRequired

Status of the account:

  • active - account is allowed to interact with the system
  • frozen - no assets can be moved around
  • deleted - no further actions can be done
Possible values:
openedAtstring · date-timeRequired

Opened date

delete
/accounts/{accountAddress}
200

Deleted investor account

patch

Update investor specific account information in the system

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Body
statusstring · enumOptional

Status of the account:

  • active - account is allowed to interact with the system
  • frozen - no assets can be moved around
  • deleted - no further actions can be done
Possible values:
Responses
chevron-right
200

Updated investor account

application/json
createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

nodeIdstring · uuidRequired

Unique UUID of the node that manages this account

Example: fb098963-aa15-48e0-94cf-84d5b3829044
addressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
typestring · enumRequired

Type of account

Possible values:
institutionSectorCodestring · enumRequired

Institutional Sector Code from 2010 ESA Standards

Possible values:
walletTypestring · enumRequired

Indicates that funds are owned by either broker or client

Possible values:
statusstring · enumRequired

Status of the account:

  • active - account is allowed to interact with the system
  • frozen - no assets can be moved around
  • deleted - no further actions can be done
Possible values:
openedAtstring · date-timeRequired

Opened date

patch
/accounts/{accountAddress}
200

Updated investor account

get

Get a paginated list of maturity payments' information in the system associated with provided account

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/bonds/maturity/payments
200

Successfully retrieved a list of items.

get

Get a paginated list of coupon payments' information in the system associated with provided account

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/bonds/coupon-payments
200

Successfully retrieved a list of items.

Deprecated
get

Retrieve a paginated list of account's bond distributions

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/bonds/distributions
200

Successfully retrieved a list of items.

Deprecated
patch

Manually retry bond distribution, when failed due to account

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
distributionIdstring · uuidRequired

Distribution UUID identifier, unique in scope of this node

Example: ec6d56d5-7aba-4cfe-8daa-ce54570e406c
Responses
chevron-right
200Success
application/json
createdAtstring · date-timeRequired

Created date

updatedAtstring · date-timeRequired

Updated date

idstring · uuidRequired

Unique UUID of the distribution entry in scope of this system

Example: 30139970-74c9-4bd7-813a-4449ec5553bb
bondIdstring · uuidRequired

Unique identifier of the related bond in scope of this system

Example: 1735c7a7-1709-4524-b95a-3c91c9caf338
accountAddressstring · xrp-addressRequired

Bond`s destination address corresponding to the investor account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
amountnumberRequired

Bond distribution amount to particular account

Example: 1000
pricenumberRequired

Price of distribution bonds

Example: 900
statusstring · enumRequired

Status of the distribution entry

Possible values:
patch
/accounts/{accountAddress}/bonds/distributions/{distributionId}
200Success
get

Retrieve a list of OTC DVP Trade available in the system where account address is involved

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/otc-trades-dvp
200

Successfully retrieved a list of items.

get

Retrieve a list of OTC FOP Trade available in the system where account address is involved

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/otc-trades-fop
200

Successfully retrieved a list of items.

get

Get a paginated list of account's bond information in the system

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/bonds
200

Successfully retrieved a list of items.

get

Get a paginated list of account's currencies information in the system

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/currencies
200

Successfully retrieved a list of items.

get

Get a paginated list of account's equity information in the system

Path parameters
accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}
Query parameters
Responses
chevron-right
200

Successfully retrieved a list of items.

application/json
get
/accounts/{accountAddress}/equities
200

Successfully retrieved a list of items.

Last updated