v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
quote

Retrieve a quote by ID

Get quote info by ID. If the quote has expired (not used to create a transfer within 30 minutes of quote creation), it will only be accessible for approximately 48 hours via this endpoint.

get/v3/profiles/{profileId}/quotes/{quoteId}

Path parameters

profileIdinteger required

Personal or business profile ID.

quoteIdstring uuid required

The quote ID (GUID format).

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Returns a quote object.

idstring uuid

ID of this quote (GUID format).

sourceCurrencystring

Source (sending) currency code.

targetCurrencystring

Target (receive) currency code.

sourceAmountnumber

Amount in source currency to send.

targetAmountnumber

Amount in target currency to be received by the recipient.

payOutstring

Mechanism we use to deliver the transfer. Not usually of interest to the user.

preferredPayInstring

Preferred pay-in method.

ratenumber

Exchange rate value used for the conversion.

createdTimestring date-time

Quote created timestamp.

userinteger

User ID who created the quote.

profileinteger

Personal or business profile ID.

rateType'FIXED' | 'FLOATING'

Whether the rate is fixed or floating.

rateExpirationTimestring date-time

Time the locked rate will expire.

guaranteedTargetAmountAllowedboolean

Whether guaranteed target amount is allowed.

targetAmountAllowedboolean

Whether target amount is allowed.

guaranteedTargetAmountboolean

Whether the target amount is guaranteed.

providedAmountType'SOURCE' | 'TARGET'

Whether the quote was created as source or target.

status'PENDING' | 'ACCEPTED' | 'FUNDED' | 'EXPIRED'

Current status of this quote.

expirationTimestring date-time

The time the quote expires.

Example response

{
  "id": "11144c35-9fe8-4c32-b7fd-d05c2a7734bf",
  "sourceCurrency": "GBP",
  "targetCurrency": "USD",
  "sourceAmount": 100,
  "targetAmount": 129.24,
  "payOut": "BANK_TRANSFER",
  "preferredPayIn": "BANK_TRANSFER",
  "rate": 1.30445,
  "createdTime": "2019-04-05T13:18:58Z",
  "user": 55,
  "profile": 101,
  "rateType": "FIXED",
  "rateExpirationTime": "2019-04-08T13:18:57Z",
  "guaranteedTargetAmountAllowed": true,
  "targetAmountAllowed": true,
  "providedAmountType": "SOURCE",
  "pricingConfiguration": {
    "fee": {
      "type": "OVERRIDE",
      "variable": 0.011,
      "fixed": 15.42
    }
  },
  "paymentOptions": [
    {
      "estimatedDelivery": "2019-04-08T12:30:00Z",
      "formattedEstimatedDelivery": "by Apr 8",
      "estimatedDeliveryDelays": [
        {
          "reason": "sample reason"
        }
      ],
      "fee": {
        "transferwise": 3.04,
        "discount": 2.27,
        "total": 0.77
      },
      "price": {
        "priceSetId": 238,
        "total": {
          "type": "TOTAL",
          "label": "Total fees",
          "value": {
            "amount": 0.77,
            "currency": "GBP",
            "label": "0.77 GBP"
          }
        },
        "items": [
          {
            "type": "FEE",
            "label": "fee",
            "value": {
              "currency": "GBP",
              "label": "0 GBP"
            }
          }
        ],
        "deferredFee": {
          "amount": 14.79,
          "currency": "BRL"
        },
        "calculatedOn": {
          "unroundedAmountToConvert": {
            "amount": 179.97342,
            "currency": "BRL"
          }
        }
      },
      "sourceAmount": 100,
      "targetAmount": 129.24,
      "sourceCurrency": "GBP",
      "targetCurrency": "USD",
      "payIn": "BANK_TRANSFER",
      "payOut": "BANK_TRANSFER",
      "allowedProfileTypes": [
        "PERSONAL",
        "BUSINESS"
      ],
      "payInProduct": "CHEAP",
      "feePercentage": 0.0092
    }
  ],
  "status": "PENDING",
  "expirationTime": "2019-04-05T13:48:58Z",
  "notices": [
    {
      "text": "You can have a maximum of 3 open transfers with a guaranteed rate. After that, they'll be transferred using the live rate. Complete or cancel your other transfers to regain the use of guaranteed rate.",
      "type": "WARNING"
    }
  ]
}