Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Quotes

Get quote by quote ID

Gets a quote by ID.

get/quotes/{quote_id}

Path parameters

quote_idstring uuid required

Unique identifier of the quote you want to retrieve.

Response

Successfully retrieved quote.

quote_idstring uuid required

Unique identifier for the quote.

created_atstring date-time required

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

expires_atstring date-time required

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

type'SENDER_AMOUNT' | 'RECEIVER_AMOUNT' | 'SENDER_INSTITUTION_AMOUNT' | 'RECEIVER_INSTITUTION_AMOUNT' | 'REVERSAL_AMOUNT' required

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

price_guaranteestring required

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.

sender_addressstring required

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

receiver_addressstring required

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

amountstring required

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

currency_codestring required

Currency code for the amount value.

currency_code_filterstring required

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.

service_typestring required

Returns null.

liquidity_warningstring required

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.

payment_method_fieldsstring

JSON object containing payment method metadata.

Example 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",
  "quote_elements": [
    {
      "quote_element_id": "259189e7-cb14-42e7-99ef-375f3285e356",
      "quote_element_type": "EXCHANGE",
      "quote_element_order": "1",
      "sender_address": "sf@rn.us.ca.san_francisco",
      "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
      "sending_amount": 1,
      "receiving_amount": 355,
      "sending_currency_code": "USD",
      "receiving_currency_code": "GBP",
      "fx_rate": {
        "rate": 3.25,
        "base_currency_code": "USD",
        "counter_currency_code": "GBP",
        "type": "buy"
      }
    }
  ],
  "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"
  }
}