Skip to content

RippleNet Server API (4.0.0)

The RippleNet Server API provides you the ability to develop custom applications to manage or interact with your RippleNet instance.

Check out the best practices and tutorials.

Authentication

All API operations require a bearer access token for your target environment.<br>Learn how to request the access token.

API environments

The RippleNet Server API creates a dynamic [domainPrefix] that consists of {tenant}.{environment}.

Note: This example uses aperture as the tenant. Your tenant ID is different.

EnvironmentDomaing PrefixDomainBase URL
Testaperture.testripplexcurrent.comhttps://aperture.test.ripplexcurrent.com
UATaperture.uatripplexcurrent.comhttps://aperture.uat.ripplexcurrent.com
Productionaperture.prodripplexcurrent.comhttps://aperture.prod.ripplexcurrent.com
Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/

https://[domainPrefix].ripplexcurrent.com/v4/

Account configuration

Operations

Auditing

Operations

Balances and statements

Operations

Beneficiary confirmation

Operations

Diagnostics

Operations

Exchange transfers

Operations

Fees

Operations

Liquidation configuration

Operations

Non-orchestration payments

Operations

Notifications

Operations

ODL flags configuration

Operations

Orchestration payments

Operations

Payment expiration

Operations

Payout method

Operations

Platform accounts

Operations

Pool accounts

Operations

Quote expiration

Operations

Quotes

Operations

Rates

Operations

Get rates

Request

Gets a list of configured exchange rates.

Security
Bearer
Query
pageinteger

The page number for paginated results. The value is zero-based, where 0 represents the first page.<br/> Set it to 0 to get the first page of results.

Default 0
sizeinteger[ 1 .. 100 ]

Number of objects to return per page.

Default 20
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/rates?page=0&size=20' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned list of rates.

Bodyapplication/json
firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger(int64)

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

sortArray of objects

Sort details of this page

directionstring

Direction of the sort

Example: "ASC"
propertystring
ignoreCaseboolean
nullHandlingstring
Example: "NULLS_FIRST"
ascendingboolean
Example: true
descendingboolean
Example: false
contentArray of objectsrequired

Provides an array of rate objects.

rate_idstring(uuid)required

Unique identifier of the exchange rate.

Example: "328b3e50-7983-46d5-94a0-ef004d78db1d"
expiration_offsetintegerrequired

<b>(DEPRECATED)</b> This property is deprecated. Refer to expires_at to determine rate expiration. <p>Amount of time in milliseconds that the rate is valid for after the rate's created_date value. For example, if the expiration_offset value is 100000 milliseconds, the rate expires 100000 milliseconds after this created_date value. If set to 0, the rate does not expire.</p>

Example: 95000
order_typestringrequired

Order type for the exchange rate.

Enum"buy""sell"
Example: "buy"
rate_scaleintegerrequired

Number of decimal places to which the exchange rate is calculated. For example, if the rate_scale value is set to 9 and the rate value is set to 1.25, the scaled value of the rate is 1.250000000.

Default 9
Example: 9
ratenumberrequired

Exchange rate for the specified base and counter currency.

Example: 0.89
base_currencystringrequired

Base currency of the exchange rate.

Example: "USD"
counter_currencystringrequired

Counter currency of the exchange rate.

Example: "GBP"
source_currencystringrequired

If order_type is set to buy, this is set to the base currency. If order_type is set to sell, this is set to the counter currency.

Example: "USD"
destination_currencystringrequired

If order_type is set to buy, this is set to the counter currency. If order_type is set to sell, this is set to the base currency.

Example: "GBP"
source_ledgerstringrequired

Source ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
destination_ledgerstringrequired

Destination ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
source_ledger_accountstringrequired

Account on the source ledger associated with rate.

Example: "alias_usd_lon"
destination_ledger_accountstringrequired

Account on the destination ledger associated with rate.

Example: "conct_gbp_lon"
created_datestring(date-time)required

Date and time at which the exchange rate was created, as an ISO-8601 timestamp in UTC. Fiat determines a rate's expiration date and time based on this value and expiration_offset value. For example, if the expiration_offset value is 100000 milliseconds, the rate expires 100000 milliseconds after this created_date value.

expires_atstring(date-time)

The time in which this rate expires in system local timezone

lower_limitnumberrequired

For a slab-based exchange rate, indicates the lower limit of the slab.

Example: 0
upper_limitnumberrequired

For a slab-based exchange rate, indicates the upper limit of the slab.

Example: 1000
payout_methodstring

The payout method for the rate.

Example: "LOCAL_RAILS"
value_typestringrequired

Indicates whether the rate is a live exchange rate (MARGIN) or an exchange rate manually configured by Ripple (RATE). If this value is MARGIN, then margin_type will show a value.

Enum"MARGIN""RATE"
Example: "MARGIN"
margin_typestringrequired

Indicates the unit of margin applied in addition to the rate provided by Ripple. This field has a value only if value_type = MARGIN. If value_type is RATE, this field is null.

Value"BPS"
Example: "BPS"
Response
application/json
{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}

Create rate

Request

Creates an exchange rate for a specified currency pair.

Example - Applying a margin to the live FX rate:<br> A USD-GBP live FX rate of 0.80 is provided by a third-party rate provider and you want to reduce that rate by 20 BPS. In this API call, you would set "value_type": "MARGIN", then "margin_type": "BPS", and "rate": "20". After that, during the Get quotes call, the final FX rate will be calculated as 0.80*(1-(20/10000))=0.7984 and then applied during quote creation.

Security
Bearer
Bodyapplication/jsonrequired
expiration_offsetintegerrequired

Set to the amount of time in milliseconds that the rate is valid for after the rate's created_date value. Set to 0 to indicate that the rate does not expire. The value returned in the response object for this field is null. Refer to the expires_at value in the response object to verify your expiration offset timing.

Example: 95000
order_typestringrequired

Set to the order type for the exchange rate.

Enum"buy""sell"
Example: "buy"
ratenumberrequired

This value of this field represents either rate or margin based on what you specify in the value_type field.

If you specify value_type=rate, set the value of this field to the exchange rate for a base and counter currency. The rate can use up to 6 decimal places.

If you specify value_type=margin, set the value of this field depending on the unit of margin you specified in the margin_type field.

Example: 0.89
base_currencystringrequired

Set to the base currency of the exchange rate.

Example: "USD"
counter_currencystringrequired

Set to the counter currency of the exchange rate.

Example: "GBP"
ledgerobject

Use the ledger request object to create an exchange rate that applies to exchanges between a specific source ledger and destination ledger.

source_ledgerstringrequired

Set to the source ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
destination_ledgerstringrequired

Set to the destination ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
accountobject

Use the account request object to create an exchange rate that applies to exchanges between a specific source ledger account and destination ledger account.

source_ledgerstringrequired

Set to the source ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
destination_ledgerstringrequired

Set to the destination ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
source_ledger_accountstringrequired

Set to the account on the source ledger associated with the rate.

Example: "alias_usd_lon"
destination_ledger_accountstringrequired

Set to the account on the destination ledger associated with the rate.

Example: "conct_gbp_lon"
lower_limitnumber

To create a slab-based exchange rate, provide the lower limit of the slab. You must also provide an upper_limit value.

Example: 0
upper_limitnumber

To create a slab-based exchange rate, provide the upper limit of the slab. You must also provide a lower_limit value.

Example: 1000
payout_methodstring

The payout method for the rate.

Example: "LOCAL_RAILS"
value_typestring

Specify whether you want to use a live exchange rate (MARGIN) or an exchange rate manually configured by Ripple (RATE). If you set this value to MARGIN, you must also provide margin_type.

Enum"MARGIN""RATE"
Example: "MARGIN"
margin_typestring

Specify the unit of margin to be applied (BPS) in addition to the rate provided by Ripple. Specify this field only if you set value_type = MARGIN.

Value"BPS"
Example: "BPS"
curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/rates \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "expiration_offset": 95000,
    "order_type": "buy",
    "rate": 0.89,
    "base_currency": "USD",
    "counter_currency": "GBP",
    "ledger": {
      "source_ledger": "rn.eur.uk.london",
      "destination_ledger": "rn.eur.uk.london"
    },
    "account": {
      "source_ledger": "rn.eur.uk.london",
      "destination_ledger": "rn.eur.uk.london",
      "source_ledger_account": "alias_usd_lon",
      "destination_ledger_account": "conct_gbp_lon"
    },
    "lower_limit": 0,
    "upper_limit": 1000,
    "payout_method": "LOCAL_RAILS",
    "value_type": "MARGIN",
    "margin_type": "BPS"
  }'

Responses

Successfully created rate.

Bodyapplication/json
rate_idstring(uuid)required

Unique identifier of the exchange rate.

Example: "328b3e50-7983-46d5-94a0-ef004d78db1d"
expiration_offsetintegerrequired

<b>(DEPRECATED)</b> This property is deprecated. Refer to expires_at to determine rate expiration. <p>Amount of time in milliseconds that the rate is valid for after the rate's created_date value. For example, if the expiration_offset value is 100000 milliseconds, the rate expires 100000 milliseconds after this created_date value. If set to 0, the rate does not expire.</p>

Example: 95000
order_typestringrequired

Order type for the exchange rate.

Enum"buy""sell"
Example: "buy"
rate_scaleintegerrequired

Number of decimal places to which the exchange rate is calculated. For example, if the rate_scale value is set to 9 and the rate value is set to 1.25, the scaled value of the rate is 1.250000000.

Default 9
Example: 9
ratenumberrequired

Exchange rate for the specified base and counter currency.

Example: 0.89
base_currencystringrequired

Base currency of the exchange rate.

Example: "USD"
counter_currencystringrequired

Counter currency of the exchange rate.

Example: "GBP"
source_currencystringrequired

If order_type is set to buy, this is set to the base currency. If order_type is set to sell, this is set to the counter currency.

Example: "USD"
destination_currencystringrequired

If order_type is set to buy, this is set to the counter currency. If order_type is set to sell, this is set to the base currency.

Example: "GBP"
source_ledgerstringrequired

Source ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
destination_ledgerstringrequired

Destination ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
source_ledger_accountstringrequired

Account on the source ledger associated with rate.

Example: "alias_usd_lon"
destination_ledger_accountstringrequired

Account on the destination ledger associated with rate.

Example: "conct_gbp_lon"
created_datestring(date-time)required

Date and time at which the exchange rate was created, as an ISO-8601 timestamp in UTC. Fiat determines a rate's expiration date and time based on this value and expiration_offset value. For example, if the expiration_offset value is 100000 milliseconds, the rate expires 100000 milliseconds after this created_date value.

expires_atstring(date-time)

The time in which this rate expires in system local timezone

lower_limitnumberrequired

For a slab-based exchange rate, indicates the lower limit of the slab.

Example: 0
upper_limitnumberrequired

For a slab-based exchange rate, indicates the upper limit of the slab.

Example: 1000
payout_methodstring

The payout method for the rate.

Example: "LOCAL_RAILS"
value_typestringrequired

Indicates whether the rate is a live exchange rate (MARGIN) or an exchange rate manually configured by Ripple (RATE). If this value is MARGIN, then margin_type will show a value.

Enum"MARGIN""RATE"
Example: "MARGIN"
margin_typestringrequired

Indicates the unit of margin applied in addition to the rate provided by Ripple. This field has a value only if value_type = MARGIN. If value_type is RATE, this field is null.

Value"BPS"
Example: "BPS"
Response
application/json
{
  "rate_id": "328b3e50-7983-46d5-94a0-ef004d78db1d",
  "expiration_offset": 95000,
  "order_type": "buy",
  "rate_scale": 9,
  "rate": 0.89,
  "base_currency": "USD",
  "counter_currency": "GBP",
  "source_currency": "USD",
  "destination_currency": "GBP",
  "source_ledger": "rn.eur.uk.london",
  "destination_ledger": "rn.eur.uk.london",
  "source_ledger_account": "alias_usd_lon",
  "destination_ledger_account": "conct_gbp_lon",
  "created_date": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "lower_limit": 0,
  "upper_limit": 1000,
  "payout_method": "LOCAL_RAILS",
  "value_type": "MARGIN",
  "margin_type": "BPS"
}

Get rate by ID

Request

Gets a configured exchange rate by ID.

Security
Bearer
Path
rate_idstring(uuid)required

Provide the rate_id of the exchange rate you want to return.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/rates/{rate_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Sucessfully returned rate.

Bodyapplication/json
rate_idstring(uuid)required

Unique identifier of the exchange rate.

Example: "328b3e50-7983-46d5-94a0-ef004d78db1d"
expiration_offsetintegerrequired

<b>(DEPRECATED)</b> This property is deprecated. Refer to expires_at to determine rate expiration. <p>Amount of time in milliseconds that the rate is valid for after the rate's created_date value. For example, if the expiration_offset value is 100000 milliseconds, the rate expires 100000 milliseconds after this created_date value. If set to 0, the rate does not expire.</p>

Example: 95000
order_typestringrequired

Order type for the exchange rate.

Enum"buy""sell"
Example: "buy"
rate_scaleintegerrequired

Number of decimal places to which the exchange rate is calculated. For example, if the rate_scale value is set to 9 and the rate value is set to 1.25, the scaled value of the rate is 1.250000000.

Default 9
Example: 9
ratenumberrequired

Exchange rate for the specified base and counter currency.

Example: 0.89
base_currencystringrequired

Base currency of the exchange rate.

Example: "USD"
counter_currencystringrequired

Counter currency of the exchange rate.

Example: "GBP"
source_currencystringrequired

If order_type is set to buy, this is set to the base currency. If order_type is set to sell, this is set to the counter currency.

Example: "USD"
destination_currencystringrequired

If order_type is set to buy, this is set to the counter currency. If order_type is set to sell, this is set to the base currency.

Example: "GBP"
source_ledgerstringrequired

Source ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
destination_ledgerstringrequired

Destination ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
source_ledger_accountstringrequired

Account on the source ledger associated with rate.

Example: "alias_usd_lon"
destination_ledger_accountstringrequired

Account on the destination ledger associated with rate.

Example: "conct_gbp_lon"
created_datestring(date-time)required

Date and time at which the exchange rate was created, as an ISO-8601 timestamp in UTC. Fiat determines a rate's expiration date and time based on this value and expiration_offset value. For example, if the expiration_offset value is 100000 milliseconds, the rate expires 100000 milliseconds after this created_date value.

expires_atstring(date-time)

The time in which this rate expires in system local timezone

lower_limitnumberrequired

For a slab-based exchange rate, indicates the lower limit of the slab.

Example: 0
upper_limitnumberrequired

For a slab-based exchange rate, indicates the upper limit of the slab.

Example: 1000
payout_methodstring

The payout method for the rate.

Example: "LOCAL_RAILS"
value_typestringrequired

Indicates whether the rate is a live exchange rate (MARGIN) or an exchange rate manually configured by Ripple (RATE). If this value is MARGIN, then margin_type will show a value.

Enum"MARGIN""RATE"
Example: "MARGIN"
margin_typestringrequired

Indicates the unit of margin applied in addition to the rate provided by Ripple. This field has a value only if value_type = MARGIN. If value_type is RATE, this field is null.

Value"BPS"
Example: "BPS"
Response
application/json
{
  "rate_id": "328b3e50-7983-46d5-94a0-ef004d78db1d",
  "expiration_offset": 95000,
  "order_type": "buy",
  "rate_scale": 9,
  "rate": 0.89,
  "base_currency": "USD",
  "counter_currency": "GBP",
  "source_currency": "USD",
  "destination_currency": "GBP",
  "source_ledger": "rn.eur.uk.london",
  "destination_ledger": "rn.eur.uk.london",
  "source_ledger_account": "alias_usd_lon",
  "destination_ledger_account": "conct_gbp_lon",
  "created_date": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "lower_limit": 0,
  "upper_limit": 1000,
  "payout_method": "LOCAL_RAILS",
  "value_type": "MARGIN",
  "margin_type": "BPS"
}

Update rate

Request

Updates an existing exchange rate. With this call, you can change value_type from RATE to MARGIN (and vice versa), change the actual rate value of the specified value type, or both.

Example - Updating an existing margin applied to the live FX rate:<br> A USD-GBP live FX rate of 0.80 is provided by a third-party rate provider and you currently reduce that rate by 20 BPS. You now want to change it and reduce it by 10 BPS instead. To do so, set "rate": "10" in the request. Once the change is applied, the final FX rate is calculated as 0.80*(1-(10/10000))=0.7992 during the Get quotes call, and then applied during quote creation.

Security
Bearer
Path
rate_idstring(uuid)required

Provide the rate_id of the exchange rate you want to update.

Bodyapplication/jsonrequired
expiration_offsetintegerrequired

Set to the amount of time in milliseconds that the rate is valid for after the rate's created_date value. Set to 0 to indicate that the rate does not expire. The value returned in the response object for this field is null. Refer to the expires_at value in the response object to verify your expiration offset timing.

Example: 95000
order_typestringrequired

Set to the order type for the exchange rate.

Enum"buy""sell"
Example: "buy"
ratenumberrequired

This value of this field represents either rate or margin based on what you specify in the value_type field.

If you specify value_type=rate, set the value of this field to the exchange rate for a base and counter currency. The rate can use up to 6 decimal places.

If you specify value_type=margin, set the value of this field depending on the unit of margin you specified in the margin_type field.

Example: 0.89
base_currencystringrequired

Set to the base currency of the exchange rate.

Example: "USD"
counter_currencystringrequired

Set to the counter currency of the exchange rate.

Example: "GBP"
ledgerobject

Use the ledger request object to create an exchange rate that applies to exchanges between a specific source ledger and destination ledger.

source_ledgerstringrequired

Set to the source ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
destination_ledgerstringrequired

Set to the destination ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
accountobject

Use the account request object to create an exchange rate that applies to exchanges between a specific source ledger account and destination ledger account.

source_ledgerstringrequired

Set to the source ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
destination_ledgerstringrequired

Set to the destination ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
source_ledger_accountstringrequired

Set to the account on the source ledger associated with the rate.

Example: "alias_usd_lon"
destination_ledger_accountstringrequired

Set to the account on the destination ledger associated with the rate.

Example: "conct_gbp_lon"
lower_limitnumber

To create a slab-based exchange rate, provide the lower limit of the slab. You must also provide an upper_limit value.

Example: 0
upper_limitnumber

To create a slab-based exchange rate, provide the upper limit of the slab. You must also provide a lower_limit value.

Example: 1000
payout_methodstring

The payout method for the rate.

Example: "LOCAL_RAILS"
value_typestring

Specify whether you want to use a live exchange rate (MARGIN) or an exchange rate manually configured by Ripple (RATE). If you set this value to MARGIN, you must also provide margin_type.

Enum"MARGIN""RATE"
Example: "MARGIN"
margin_typestring

Specify the unit of margin to be applied (BPS) in addition to the rate provided by Ripple. Specify this field only if you set value_type = MARGIN.

Value"BPS"
Example: "BPS"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/rates/{rate_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "expiration_offset": 95000,
    "order_type": "buy",
    "rate": 0.89,
    "base_currency": "USD",
    "counter_currency": "GBP",
    "ledger": {
      "source_ledger": "rn.eur.uk.london",
      "destination_ledger": "rn.eur.uk.london"
    },
    "account": {
      "source_ledger": "rn.eur.uk.london",
      "destination_ledger": "rn.eur.uk.london",
      "source_ledger_account": "alias_usd_lon",
      "destination_ledger_account": "conct_gbp_lon"
    },
    "lower_limit": 0,
    "upper_limit": 1000,
    "payout_method": "LOCAL_RAILS",
    "value_type": "MARGIN",
    "margin_type": "BPS"
  }'

Responses

Successfully updated rate.

Bodyapplication/json
rate_idstring(uuid)required

Unique identifier of the exchange rate.

Example: "328b3e50-7983-46d5-94a0-ef004d78db1d"
expiration_offsetintegerrequired

<b>(DEPRECATED)</b> This property is deprecated. Refer to expires_at to determine rate expiration. <p>Amount of time in milliseconds that the rate is valid for after the rate's created_date value. For example, if the expiration_offset value is 100000 milliseconds, the rate expires 100000 milliseconds after this created_date value. If set to 0, the rate does not expire.</p>

Example: 95000
order_typestringrequired

Order type for the exchange rate.

Enum"buy""sell"
Example: "buy"
rate_scaleintegerrequired

Number of decimal places to which the exchange rate is calculated. For example, if the rate_scale value is set to 9 and the rate value is set to 1.25, the scaled value of the rate is 1.250000000.

Default 9
Example: 9
ratenumberrequired

Exchange rate for the specified base and counter currency.

Example: 0.89
base_currencystringrequired

Base currency of the exchange rate.

Example: "USD"
counter_currencystringrequired

Counter currency of the exchange rate.

Example: "GBP"
source_currencystringrequired

If order_type is set to buy, this is set to the base currency. If order_type is set to sell, this is set to the counter currency.

Example: "USD"
destination_currencystringrequired

If order_type is set to buy, this is set to the counter currency. If order_type is set to sell, this is set to the base currency.

Example: "GBP"
source_ledgerstringrequired

Source ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
destination_ledgerstringrequired

Destination ledger associated with the exchange rate.

Example: "rn.eur.uk.london"
source_ledger_accountstringrequired

Account on the source ledger associated with rate.

Example: "alias_usd_lon"
destination_ledger_accountstringrequired

Account on the destination ledger associated with rate.

Example: "conct_gbp_lon"
created_datestring(date-time)required

Date and time at which the exchange rate was created, as an ISO-8601 timestamp in UTC. Fiat determines a rate's expiration date and time based on this value and expiration_offset value. For example, if the expiration_offset value is 100000 milliseconds, the rate expires 100000 milliseconds after this created_date value.

expires_atstring(date-time)

The time in which this rate expires in system local timezone

lower_limitnumberrequired

For a slab-based exchange rate, indicates the lower limit of the slab.

Example: 0
upper_limitnumberrequired

For a slab-based exchange rate, indicates the upper limit of the slab.

Example: 1000
payout_methodstring

The payout method for the rate.

Example: "LOCAL_RAILS"
value_typestringrequired

Indicates whether the rate is a live exchange rate (MARGIN) or an exchange rate manually configured by Ripple (RATE). If this value is MARGIN, then margin_type will show a value.

Enum"MARGIN""RATE"
Example: "MARGIN"
margin_typestringrequired

Indicates the unit of margin applied in addition to the rate provided by Ripple. This field has a value only if value_type = MARGIN. If value_type is RATE, this field is null.

Value"BPS"
Example: "BPS"
Response
application/json
{
  "rate_id": "328b3e50-7983-46d5-94a0-ef004d78db1d",
  "expiration_offset": 95000,
  "order_type": "buy",
  "rate_scale": 9,
  "rate": 0.89,
  "base_currency": "USD",
  "counter_currency": "GBP",
  "source_currency": "USD",
  "destination_currency": "GBP",
  "source_ledger": "rn.eur.uk.london",
  "destination_ledger": "rn.eur.uk.london",
  "source_ledger_account": "alias_usd_lon",
  "destination_ledger_account": "conct_gbp_lon",
  "created_date": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "lower_limit": 0,
  "upper_limit": 1000,
  "payout_method": "LOCAL_RAILS",
  "value_type": "MARGIN",
  "margin_type": "BPS"
}

Delete rate

Request

Deletes an exchange rate. Once deleted, an exchange rate cannot be accessed.

Security
Bearer
Path
rate_idstring(uuid)required

Provide the rate_id of the exchange rate you want to delete.

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/rates/{rate_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully deleted rate.

Response
No content

Request for payment

Operations

Sender segregated account configuration

Operations

Transfers

Operations

schema

Operations

activity

Operations

Orchestration Template

Operations

diagnostics

Operations

payment

Operations

Get application info

Request

Gets application information.

Security
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/info \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched application info.

Bodyapplication/json
namestring

Application name.

Example: "Integration Module"
versionstring

Application version.

Example: "1.2.0"
Response
application/json
{
  "name": "Integration Module",
  "version": "1.2.0"
}

tenant

Operations

Orchestration internal action

Operations

Orchestration internal payments

Operations

Orchestration internal notifications

Operations