Skip to content

Create ODL flag configuration

Request

Create a new flag configuration to decide which flags will be passed to ODL

Security
Bearer
Bodyapplication/jsonrequired
flagstringrequired

Flag to be passed to ODL in payment/estimate requests.

flag_valuestring

flag value to be passed to ODL in payment/estimate requests.

exchangestring

Exchange name for which this flag should be added to the ODL payment/estimate request

sender_hoststring

Sender host ripplenet hostname who sends the payment for which this flag is to be applied

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/odl_flags_config \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "flag": "string",
    "flag_value": "string",
    "exchange": "string",
    "sender_host": "string"
  }'

Responses

Successfully created ODLFlag configuration

Bodyapplication/json
odl_flag_config_idstring, (uuid)

The unique identifier for this ODL Flag Configuration.

flagstring

Flag to be passed to ODL in payment/estimate requests.

flag_valuestring

flag value to be passed to ODL in payment/estimate requests.

exchangestring

Exchange name for which this flag should be added to the ODL payment/estimate request

sender_hoststring

Sender host ripplenet hostname who sends the payment for which this flag is to be applied

Response
{
  "odl_flag_config_id": "9470ee9d-472f-4159-939a-670c84b91ca6",
  "flag": "string",
  "flag_value": "string",
  "exchange": "string",
  "sender_host": "string"
}