Pular para o conteúdo

Get quotes

Requisição

Gets a list of quotes.

Segurança
Bearer
Consulta
pageinteger

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

Padrão:0
sizeinteger, [ 1 .. 100 ]

Number of objects to return per page.

Padrão:20
curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes?page=0&size=20' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respostas

Successfully returned array of quotes.

Corpoapplication/json
Array [
quote_idstring, (uuid)obrigatório

Unique identifier for the quote.

Exemplo:"2a547e56-4aac-4375-86a8-8b3e7014801d"
created_atstring, (date-time)obrigatório

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

Exemplo:"2020-01-29T20:59:44.925Z"
expires_atstring, (date-time)obrigatório

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

Padrão:"300s/300000ms"
Exemplo:"2020-01-29T21:29:44.925Z"
typestringobrigatório

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"
Exemplo:"SENDER_AMOUNT"
price_guaranteestringobrigatório

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.

Padrão:"FIRM"
Exemplo:"FIRM"
sender_addressstringobrigatório

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

Exemplo:"sf@rn.us.ca.san_francisco"
receiver_addressstringobrigatório

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

Exemplo:"sf_gbp@rn.us.ca.san_francisco"
amountstringobrigatório

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

Exemplo:"1"
currency_codestringobrigatório

Currency code for the amount value.

Exemplo:"USD"
currency_code_filterstringobrigatório

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.

Exemplo:"EUR"
service_typestringobrigatório

Returns null.

quote_elementsArray of objectsobrigatório

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_warningstringobrigatório

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.

Exemplo:"LOCAL_RAILS"
payment_method_fieldsstring

JSON object containing payment method metadata.

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

Details about the payout method.

]
Resposta
[
  {
    "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": { … }
  }
]