Pular para o conteúdo

Update account

Requisição

Updates the updatable fields for an account.

Segurança
Bearer
Caminho
account_namestringobrigatório

The name of the account for which to set minimum and maximum balance limits. (To discover account names, make a Get accounts request.)

Corpoapplication/jsonobrigatório
minimum_allowed_balancenumber

Set to the minimum balance allowed for the account. Updates the value of minimum_allowed_balance for the account.

Exemplo:-1000000
maximum_allowed_balancenumber

Set to the maximum balance allowed for the account. Updates the value of maximum_allowed_balance for the account.

Exemplo:9999999999999900000
core_ledger_refstring

Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts

Exemplo:"bitso"
enableboolean

Indicates whether the account should be disabled (false) or active (true).

Padrão:true
Exemplo:true
platform_account_idstring, (uuid)

Platform account ID associated with this RippleNet account.

external_account_idstring

Used to link a customer’s account ID on their systems to their RippleNet account.

account_descriptionstring

Description associated with this RippleNet account.

curl -i -X PUT \
  'https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts/{account_name}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "minimum_allowed_balance": -1000000,
    "maximum_allowed_balance": 9999999999999900000,
    "core_ledger_ref": "bitso",
    "enable": true,
    "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad",
    "external_account_id": "string",
    "account_description": "string"
  }'

Respostas

Successfully updated the account.

Corpoapplication/json
namestringobrigatório

Account name and unique identifier on RippleNet.

Exemplo:"conct_usd_sf"
balancenumberobrigatório

Balance available in the account.

Exemplo:0
ownerstringobrigatório

RippleNet address of the owner of the account.

Exemplo:"rn.us.ca.san_francisco"
currencystringobrigatório

Currency supported by the account.

Exemplo:"USD"
disabledbooleanobrigatório

Indicates whether the account is disabled (true) or active (false).

Exemplo:false
minimum_allowed_balancenumberobrigatório

Minimum balance allowed for the account. For nostro accounts, RippleNet Server uses the greater of this value and the owner_min_allowed_balance to set the account balance minimum.

Exemplo:-1000000
maximum_allowed_balancenumberobrigatório

Maximum balance allowed for the account. For nostro accounts, RippleNet Server uses the lesser of this value and the owner_max_allowed_balance to set the account balance maximum.

Exemplo:9999999999999900000
core_ledger_refstring

Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts

Exemplo:"bitso"
rounding_modestringobrigatório

Determines whether calculations for this account are rounded up or down to maintain precision.

Padrão:"HALF_UP"
Enum:"HALF_UP""HALF_DOWN""DOWN"
Exemplo:"HALF_UP"
scaleintegerobrigatório

Number of decimal places used when calculating rounding for this account.

Exemplo:2
low_liquidity_thresholdnumberobrigatório

When the sender's account balance is less than or equal to this amount, after payment settlement execution, a low-liquidity message is logged at the INFO level.

Exemplo:1000
owner_min_allowed_balancenumberobrigatório

Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the minimum_allowed_balance to set the account balance minimum.

Exemplo:-100000
owner_max_allowed_balancenumberobrigatório

Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the maximum_allowed_balance to set the account balance maximum.

Exemplo:72036854775
platform_account_idstring, (uuid)

Platform account ID associated with this RippleNet account.

external_account_idstring

Customer's account ID on their systems associated with this RippleNet account.

account_descriptionstring

Description associated with this RippleNet account.

Resposta
{ "name": "conct_usd_sf", "balance": 0, "owner": "rn.us.ca.san_francisco", "currency": "USD", "disabled": false, "minimum_allowed_balance": -1000000, "maximum_allowed_balance": 9999999999999900000, "core_ledger_ref": "bitso", "rounding_mode": "HALF_UP", "scale": 2, "low_liquidity_threshold": 1000, "owner_min_allowed_balance": -100000, "owner_max_allowed_balance": 72036854775, "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad", "external_account_id": "string", "account_description": "string" }