Sign in

v1

latestOpenAPI 3.0.22026-07-17191121.5 KB
admins

Adds a new user on the node

post/accounts

Headers

authorizationstring required

Bearer token with the administrator's authorization

Request body

usernamestring required
asset_scaleinteger required
asset_codestring required
max_packet_amountinteger
min_balanceinteger
ilp_over_http_urlstring
ilp_over_http_incoming_tokenstring
ilp_over_http_outgoing_tokenstring
ilp_over_btp_urlstring
ilp_over_btp_incoming_tokenstring
ilp_over_btp_outgoing_tokenstring
settlement_engine_urlstring
settle_thresholdinteger
settle_tointeger
routing_relationstring
round_trip_timeinteger
amount_per_minute_limitinteger
packets_per_minute_limitinteger

Example request

{
  "username": "Alice",
  "asset_scale": 9,
  "asset_code": "ABC",
  "max_packet_amount": 10000000000,
  "ilp_over_http_url": "https://example.com/accounts/our_username_on_peer/ilp",
  "ilp_over_http_incoming_token": "peer_password",
  "ilp_over_http_outgoing_token": "our_password_on_peer",
  "ilp_over_btp_url": "btps://example.com/accounts/our_username_on_peer/ilp/btp",
  "ilp_over_btp_incoming_token": "peer_password",
  "ilp_over_btp_outgoing_token": "our_password_on_peer",
  "settlement_engine_url": "http://engine.example.com",
  "settle_threshold": 1000000000,
  "settle_to": 1000000000,
  "routing_relation": "Peer",
  "round_trip_time": 500,
  "amount_per_minute_limit": 1000000000,
  "packets_per_minute_limit": 10
}

Response

The inserted account (an ID is auto-generated by the node)

idstring uuid required
usernamestring required
asset_scaleinteger required
asset_codestring required
max_packet_amountinteger required
min_balanceinteger required
ilp_over_http_urlstring required
ilp_over_http_incoming_tokenstring required
ilp_over_http_outgoing_tokenstring required
ilp_over_btp_urlstring required
ilp_over_btp_incoming_tokenstring required
ilp_over_btp_outgoing_tokenstring required
settlement_engine_urlstring required
settle_thresholdinteger required
settle_tointeger required
routing_relationstring required
round_trip_timeinteger required
amount_per_minute_limitinteger required
packets_per_minute_limitinteger required

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "username": "Alice",
  "asset_scale": 9,
  "asset_code": "ABC",
  "max_packet_amount": 10000000000,
  "ilp_over_http_url": "https://example.com/accounts/our_username_on_peer/ilp",
  "ilp_over_http_incoming_token": "peer_password",
  "ilp_over_http_outgoing_token": "our_password_on_peer",
  "ilp_over_btp_url": "btps://example.com/accounts/our_username_on_peer/ilp/btp",
  "ilp_over_btp_incoming_token": "peer_password",
  "ilp_over_btp_outgoing_token": "our_password_on_peer",
  "settlement_engine_url": "http://engine.example.com",
  "settle_threshold": 1000000000,
  "settle_to": 1000000000,
  "routing_relation": "Peer",
  "round_trip_time": 500,
  "amount_per_minute_limit": 1000000000,
  "packets_per_minute_limit": 10
}