Pular para o conteúdo

Get a quote

Requisição

Retrieve a specific quote by its unique identifier.

Use this endpoint to:

  • Verify quote details before creating a payment
  • Check if a quote is still active (not expired)
  • Retrieve the quoteId needed for payment creation

Note: Quotes expire after a defined period. Check the quoteStatus field to confirm the quote is ACTIVE before using it to create a payment.

Segurança
Bearer
Caminho
quote-idstring, (uuid)obrigatório

The unique identifier of the quote to retrieve

Exemplo:22222222-aaaa-2222-bbbb-222222222222
curl -i -X GET \
  https://docs.ripple.com/_mock/pt-br/products/payments-direct-2/api-docs/payments-direct-api/payments-direct-2-api/v3/quotes/22222222-aaaa-2222-bbbb-222222222222 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

Valid quote found

Corpoapplication/json
quoteIdstring, (uuid), [ 1 .. 36 ] charactersobrigatório

Unique ID that represents this quote.

Exemplo:"7ea3399c-1234-5678-8d8f-d320ea406630"
quoteStatusstringobrigatório
Enum ValueDescription
EXPIRED

Expired quote

ACTIVE

Quote that you can accept to create a payment.

Exemplo:"ACTIVE"
quoteAmountTypestring

The type of amount for which you want to get a quote.

Padrão:"SOURCE_AMOUNT"
Enum ValueDescription
SOURCE_AMOUNT

Specify this value to get a quote for the amount that you want to send.

DESTINATION_AMOUNT

Specify this value to get a quote for the amount that the beneficiary should receive.

sourceAmountnumber, (double), >= 1

Amount to be sent by the originator.

Exemplo:123.45
destinationAmountnumber, (double), >= 1

Amount to be received by destination

Exemplo:2438.19
sourceCurrencystring^[a-zA-Z]{3,5}$obrigatório

The currency code of the currency that you are sending.

Exemplo:"USD"
destinationCurrencystring^[a-zA-Z]{3,5}$obrigatório

The currency code of the currency in which your beneficiary will receive this payment.

Exemplo:"MXN"
sourceCountrystring^[a-zA-Z]{2}$

The country where the payment originator is located or incorporated, specified in Alpha-2 Code format as defined in the ISO CountryCode ISO 3166-1 list.

Exemplo:"US"
destinationCountrystring^[a-zA-Z]{2}$

The country code to which you wish to send the funds. It follows ISO 3166-1 alpha-2 code

Exemplo:"MX"
payinCategorystring, [ 1 .. 128 ] charactersobrigatório

The name of payin category specified in the quote request.

Exemplo:"PRE_FUNDING"
adjustedExchangeRateobject

Foreign Exchange (FX) rate used to calculate the quote.

feesArray of objects

A summary of fees included in this quote.

taxesArray of objects

A summary of taxes included in this quote.

createdAtstring, (date-time), [ 1 .. 128 ] characters

The time when this quote was created, specified in UTC.

Exemplo:"2023-11-02T18:26:00.000123Z"
expiresAtstring, (date-time), [ 1 .. 128 ] characters

The time when this quote expires, specified in UTC.

Exemplo:"2023-11-02T18:26:00.000123Z"
paymentRailstring, [ 1 .. 50 ] characters

The payment rail used for this quote.

Exemplo:"SPEI"
Resposta
{
  "quoteId": "7ea3399c-1234-5678-8d8f-d320ea406630",
  "quoteStatus": "ACTIVE",
  "quoteAmountType": "SOURCE_AMOUNT",
  "sourceAmount": 123.45,
  "destinationAmount": 2438.19,
  "sourceCurrency": "USD",
  "destinationCurrency": "MXN",
  "sourceCountry": "US",
  "destinationCountry": "MX",
  "payinCategory": "PRE_FUNDING",
  "adjustedExchangeRate": {
    "adjustedRate": 2
  },
  "fees": [
    { … }
  ],
  "taxes": [
    { … }
  ],
  "createdAt": "2023-11-02T18:26:00.000123Z",
  "expiresAt": "2023-11-02T18:26:00.000123Z",
  "paymentRail": "SPEI"
}