v1

latestOpenAPI 3.0.22026-07-17191121.5 KB

admins

users

Edit an account's settings (e.g. tokens, URLs, settlement thresholds). This should not be confused with the administrator-only PUT /accounts/:username endpoint which allows changing any user parameter.

put/accounts/{username}/settings

Headers

authorizationstring required

Bearer token with the account's or 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 updated account's information