Quotes

The quote resource defines the currencies involved in a transfer, the amount to send, and the profile sending the money.

The quote resource is one of the resources required when creating a transfer, along with the recipient account that is receiving the funds.

SchemasOperations

Quote

idstring, (uuid)

ID of this quote (GUID format).

Example:"11144c35-9fe8-4c32-b7fd-d05c2a7734bf"

sourceCurrencystring

Source (sending) currency code.

Example:"GBP"

targetCurrencystring

Target (receive) currency code.

Example:"USD"

sourceAmountnumber

Amount in source currency to send.

Example:100

targetAmountnumber

Amount in target currency to be received by the recipient.

Example:129.24

payOutstring

Mechanism Wise uses to deliver the transfer. Provided for information purposes.

Example:"BANK_TRANSFER"

preferredPayInstring

Preferred pay-in method.

Example:"BANK_TRANSFER"

ratenumber

Exchange rate value used for the conversion.

Example:1.30445

createdTimestring, (date-time)

Quote created timestamp.

Example:"2019-04-05T13:18:58Z"

userinteger, (int64)

User ID that created the quote.

Example:55

profileinteger, (int64)

Personal or business profile ID.

Example:101

rateTypestring

Whether the rate is fixed or floating.

Enum:"FIXED""FLOATING"

Example:"FIXED"

rateExpirationTimestring, (date-time)

Date and time the locked rate expires.

Example:"2019-04-08T13:18:57Z"

guaranteedTargetAmountAllowedboolean

Indicates whether guaranteed target amount is allowed.

Example:true

targetAmountAllowedboolean

Indicates whether target amount is allowed.

Example:true

guaranteedTargetAmountboolean

Indicates whether the target amount is guaranteed.

Example:false

providedAmountTypestring

Indicates whether the quote was created as source or target.

Enum:"SOURCE""TARGET"

Example:"SOURCE"

pricingConfigurationobject

Allows partners to override pricing configurations on a transfer level.

paymentOptionsArray of objects

List of the methods available to pay for the transfer.

statusstring

Current status of the quote.

Enum:"PENDING""ACCEPTED""FUNDED""EXPIRED"

Example:"PENDING"

expirationTimestring, (date-time)

The date and time the quote expires.

Example:"2019-04-05T13:48:58Z"

noticesArray of objects

Messages to display to the user. May be empty ([]) if there are no messages.

{
  "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,
  "guaranteedTargetAmount": false,
  "providedAmountType": "SOURCE",
  "pricingConfiguration": {
    "fee": {
      "type": "OVERRIDE",
      "variable": 0.011,
      "fixed": 15.42
    }
  },
  "paymentOptions": [
    {
      "disabled": false,
      "estimatedDelivery": "2019-04-08T12:30:00Z",
      "formattedEstimatedDelivery": "by Apr 8",
      "estimatedDeliveryDelays": [ … ],
      "fee": { … },
      "price": { … },
      "sourceAmount": 100,
      "targetAmount": 129.24,
      "sourceCurrency": "GBP",
      "targetCurrency": "USD",
      "payIn": "BANK_TRANSFER",
      "payOut": "BANK_TRANSFER",
      "allowedProfileTypes": [ … ],
      "payInProduct": "CHEAP",
      "feePercentage": 0.0092,
      "disabledReason": { … }
    }
  ],
  "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.",
      "link": null,
      "type": "WARNING"
    }
  ]
}