Get quote by quote ID

Request

Gets a quote by ID.

Security

Bearer

Path

quote_idstring, (uuid)required

Unique identifier of the quote you want to retrieve.

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

Responses

Successfully retrieved quote.

Bodyapplication/json

quote_idstring, (uuid)required

Unique identifier for the quote.

Example:"2a547e56-4aac-4375-86a8-8b3e7014801d"

created_atstring, (date-time)required

Date and time at which the quote was created, as an ISO-8601 timestamp in UTC.

Example:"2020-01-29T20:59:44.925Z"

expires_atstring, (date-time)required

Date and time after which the quote and its pricing expire, as an ISO-8601 timestamp in UTC.

Default:"300s/300000ms"

Example:"2020-01-29T21:29:44.925Z"

typestringrequired

Indicates how the amount field should be treated for calculating quote values.

Enum:"SENDER_AMOUNT""RECEIVER_AMOUNT""SENDER_INSTITUTION_AMOUNT""RECEIVER_INSTITUTION_AMOUNT""REVERSAL_AMOUNT"

Example:"SENDER_AMOUNT"

price_guaranteestringrequired

Indicates whether a quote's pricing is INDICATIVE or FIRM. An INDICATIVE quote allows for price movements between quote issuance and payment execution, such that the quoted amount and delivered amount may differ. A FIRM quote ensures that the quoted and delivered payment amounts are equal.

Default:"FIRM"

Example:"FIRM"

sender_addressstringrequired

RippleNet account name and address of the sender, in the format accountname@ripplenetaddress. For example, new_york@rn.us.ny.new_york.

Example:"sf@rn.us.ca.san_francisco"

receiver_addressstringrequired

RippleNet account name and address of the receiver, in the format accountname@ripplenetaddress. For example, new_york@rn.us.ny.new_york.

Example:"sf_gbp@rn.us.ca.san_francisco"

amountstringrequired

Amount to be sent or received, depending on the type value.

Example:"1"

currency_codestringrequired

Currency code for the amount value.

Example:"USD"

currency_code_filterstringrequired

Currency code that can be used to filter quotes at the opposite end of the quote request. For example, you can filter by this currency code to find the receiving currency for a quote with a SENDER_AMOUNT quote_type. If not sent in the request, this field value is set to null.

Example:"EUR"

service_typestringrequired

Returns null.

quote_elementsArray of objectsrequired

Transfer and exchange elements. A transfer element represents a movement of funds between two accounts. An exchange element represents the exchange of currencies between two accounts.

liquidity_warningstringrequired

Triggered when a quote causes an account to go below its minimum_allowed_balance. Otherwise, this field value is set to null.

payment_methodstring

Payout method for the quote.

Example:"LOCAL_RAILS"

payment_method_fieldsstring

JSON object containing payment method metadata.

Example:"{\"category_id\":\"bank\",\"required_originator_fields\":[{\"field_name\":\"sender_address\",\"field_label\":\"Sender address\"}]}"

payout_method_infoobject

Details about the payout method.

Response

{
  "quote_id": "2a547e56-4aac-4375-86a8-8b3e7014801d",
  "created_at": "2020-01-29T20:59:44.925Z",
  "expires_at": "2020-01-29T21:29:44.925Z",
  "type": "SENDER_AMOUNT",
  "price_guarantee": "FIRM",
  "sender_address": "sf@rn.us.ca.san_francisco",
  "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
  "amount": "1",
  "currency_code": "USD",
  "currency_code_filter": "EUR",
  "service_type": "string",
  "quote_elements": [
    { … }
  ],
  "liquidity_warning": "string",
  "payment_method": "LOCAL_RAILS",
  "payment_method_fields": "{\"category_id\":\"bank\",\"required_originator_fields\":[{\"field_name\":\"sender_address\",\"field_label\":\"Sender address\"}]}",
  "payout_method_info": {
    "payout_method_name": "Cash Payout",
    "payout_method_category": "BOOK_TRANSFER",
    "description": "local rails",
    "estimated_time_to_credit": "3 days"
  }
}