Skip to content

Get quote expiry

Request

Gets the time to live (ttl) of a quote expiry in seconds.

Security
Bearer
Path
quote_expiry_idinteger, (int64)required

The ID of the quote expiry you want returned.

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

Responses

Successfully returned a quote expiry.

Bodyapplication/json
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example:5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

Example:"rn.us.ca.san_francisco"
receiving_partnerstring

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example:"rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example:"USD"
idinteger

id of quote expiry object

Example:2
Response
{
  "quote_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "id": 2
}