Create liquidation configuration

Requisição

Creates a new liquidation configuration. A liquidation configuration defines a transfer path between two RippleNet accounts for liquidating payments (when they arrive in a source account) to a destination account.

Segurança

Bearer

Corpoapplication/jsonobrigatório

namestring

Display name for this Liquidaton Configuration.

source_addressstringobrigatório

Full RippleNet address of the source account in the form acccountname@host.

destination_addressstringobrigatório

Full RippleNet address of the destination account in the form acccountname@host.

liquidation_modestringobrigatório

Mode in which this Liquidation Configuration operates.

Enum:"PER_PAYMENT""SMART_LIQUIDATION_PER_PAYMENT"

price_guaranteestringobrigatório

Price guarantee for the Liquidation quote.

Enum:"FIRM""INDICATIVE"

liquidation_typestringobrigatório

Indicates the amount the liquidation is based on.

Enum:"SENDER""RECEIVER""XRP"

curl -i -X POST \
  https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/config/liquidation_config \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "source_address": "string",
    "destination_address": "string",
    "liquidation_mode": "PER_PAYMENT",
    "price_guarantee": "FIRM",
    "liquidation_type": "SENDER"
  }'

Respostas

Successfully created liquidation configuration

Corpoapplication/json

liquidation_config_idstring, (uuid)

The unique identifier for this Liquidation Configuration.

namestring

Display name for this Liquidaton Configuration.

source_addressstring

Full RippleNet address of the source account in the form accountname@host.

destination_addressstring

Full RippleNet address of the destination account in the form accountname@host.

liquidation_modestring

Mode in which this Liquidation Configuration operates.

Enum:"PER_PAYMENT""SMART_LIQUIDATION_PER_PAYMENT"

price_guaranteestring

Price guarantee for the Liquidation quote.

Enum:"FIRM""INDICATIVE"

liquidation_typestring

Indicates the amount the liquidation is based on

Enum:"SENDER""RECEIVER""XRP"

Resposta

{
  "liquidation_config_id": "ce732202-aed8-4051-a58e-204364537ee9",
  "name": "string",
  "source_address": "string",
  "destination_address": "string",
  "liquidation_mode": "PER_PAYMENT",
  "price_guarantee": "FIRM",
  "liquidation_type": "SENDER"
}