API
Quote
A quote for a transfer: its exchange rate and fees.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
POST |
/profiles/{profileId}/quotes |
create |
Returns a quote object |
POST |
/quotes |
create |
Returns a quote object |
GET |
/profiles/{profileId}/quotes/{quoteId} |
load |
Returns a quote object |
PATCH |
/profiles/{profileId}/quotes/{quoteId} |
update |
Returns a quote object |
Examples
One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.
Golang
Construct client as shown in the Golang setup, then call the operations:
quote, err := client.Quote(nil).Load(map[string]any{"id": "example_id", "profile_id": 1}, nil)
if err != nil {
panic(err)
}
fmt.Println(quote)
created, err := client.Quote(nil).Create(map[string]any{"sourceCurrency": "example", "targetCurrency": "example"}, nil)
if err != nil {
panic(err)
}
fmt.Println(created)
updated, err := client.Quote(nil).Update(map[string]any{"id": "example_id", "profile_id": 1, "payOut": "example"}, nil)
if err != nil {
panic(err)
}
fmt.Println(updated)
Lua
Construct client as shown in the Lua setup, then call the operations:
local quote, err = client:Quote():load({ id = "example_id", profile_id = 1 })
local created, err = client:Quote():create({ sourceCurrency = "example", targetCurrency = "example" })
local updated, err = client:Quote():update({ id = "example_id", profile_id = 1, payOut = "example" })
PHP
Construct client as shown in the PHP setup, then call the operations:
$quote = $client->Quote()->load(["id" => "example_id", "profile_id" => 1]);
$created = $client->Quote()->create(["sourceCurrency" => "example", "targetCurrency" => "example"]);
$updated = $client->Quote()->update(["id" => "example_id", "profile_id" => 1, "payOut" => "example"]);
Python
Construct client as shown in the Python setup, then call the operations:
quote = client.Quote().load({"id": "example_id", "profile_id": 1})
created = client.Quote().create({ "sourceCurrency": "example", "targetCurrency": "example" })
updated = client.Quote().update({"id": "example_id", "profile_id": 1, "payOut": "example"})
Ruby
Construct client as shown in the Ruby setup, then call the operations:
quote = client.Quote.load({ "id" => "example_id", "profile_id" => 1 })
created = client.Quote.create({ "sourceCurrency" => "example", "targetCurrency" => "example" })
updated = client.Quote.update({ "id" => "example_id", "profile_id" => 1, "payOut" => "example" })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const quote = await client.Quote().load({ id: "example_id", profile_id: 1 })
const created = await client.Quote().create({ sourceCurrency: "example", targetCurrency: "example" })
const updated = await client.Quote().update({ id: "example_id", profile_id: 1, payOut: "example" })
Fields
| Field | Type | Required | Description |
|---|---|---|---|
createdTime |
string |
No | Quote created timestamp. |
creationContext |
object |
No | Used to pass additional metadata about the intended transfer. |
expirationTime |
string |
No | The date and time the quote expires. |
guaranteedTargetAmount |
boolean |
No | Indicates whether the target amount is guaranteed. |
guaranteedTargetAmountAllowed |
boolean |
No | Indicates whether guaranteed target amount is allowed. |
id |
string |
No | ID of this quote (GUID format). |
notices |
array |
No | Messages to display to the user. |
payOut |
string |
No | Mechanism Wise uses to deliver the transfer. |
paymentMetadata |
object |
No | Optional. |
paymentOptions |
array |
No | List of the methods available to pay for the transfer. |
preferredPayIn |
string |
No | Preferred pay-in method. |
pricingConfiguration |
object |
No | Allows partners to override pricing configurations on a transfer level. |
profile |
integer |
No | Personal or business profile ID. |
providedAmountType |
string |
No | Indicates whether the quote was created as source or target. |
rate |
number |
No | Exchange rate value used for the conversion. |
rateExpirationTime |
string |
No | Date and time the locked rate expires. |
rateType |
string |
No | Whether the rate is fixed or floating. |
sourceAmount |
number |
No | Amount in source currency to send. |
sourceCurrency |
string |
No | Source (sending) currency code. |
status |
string |
No | Current status of the quote. |
targetAccount |
integer |
No | Optional. |
targetAmount |
number |
No | Amount in target currency to be received by the recipient. |
targetAmountAllowed |
boolean |
No | Indicates whether target amount is allowed. |
targetCurrency |
string |
No | Target (receive) currency code. |
user |
integer |
No | User ID that created the quote. |
create
POST /profiles/{profileId}/quotes
Operation ID: quoteCreate.
Authentication: bearer token (UserToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | Personal or business profile ID of the sender. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Request body
application/json
| Property | Type | Required | Description |
|---|---|---|---|
creationContext |
object |
No | Used to pass additional metadata about the intended transfer. |
creationContext.flow |
string |
No | Optional. Used to pass flow type for the creation flow on the quote. It should always be MASS_PAY for batch transfers funded via payin sessions. |
payOut |
string,null |
No | Optional. Preferred payout method. Default value is BANK_TRANSFER. Examples of other accepted values include BALANCE, SWIFT, SWIFT_OUR, ALIPAY, and INTERAC. |
paymentMetadata |
object |
No | Optional. Used to pass additional metadata about the intended transfer. |
paymentMetadata.transferNature |
string |
No | Optional. Used to pass transfer nature for calculating proper tax amounts (IOF) for transfers to and from BRL. Accepted values are shown dynamically in transfer requirements. |
preferredPayIn |
string,null |
No | Optional. Preferred payin method. Use BANK_TRANSFER to return this method at the top of the response's results. |
pricingConfiguration |
object |
No | Required when configured for your client ID. Includes a pricingConfiguration to be used for pricing calculations with the quote. |
pricingConfiguration.fee |
object |
No | |
pricingConfiguration.fee.fixed |
number |
No | The selected fixed fee that should be used in the pricingConfiguration. Always considered in source currency. |
pricingConfiguration.fee.type |
string |
No | Identifies the type of fee to be configured. Options include only OVERRIDE. |
pricingConfiguration.fee.variable |
number |
No | The selected variable percentage, in decimal format, that should be used in the pricingConfiguration. |
sourceAmount |
number,null |
No | Amount in source currency. Either sourceAmount or targetAmount is required, never both. |
sourceCurrency |
string |
Yes | Source (sending) currency code. |
targetAccount |
integer (int64) |
No | Optional. This is the ID of transfer recipient, found in the create recipient response. If provided, can be used as an alternative to updating the quote. |
targetAmount |
number,null |
No | Amount in target currency. |
targetCurrency |
string |
Yes | Target (receiving) currency code. |
Responses
200: Returns a quote object
application/json
| Property | Type | Required | Description |
|---|---|---|---|
createdTime |
string (date-time) |
No | Quote created timestamp. |
expirationTime |
string (date-time) |
No | The date and time the quote expires. |
guaranteedTargetAmount |
boolean |
No | Indicates whether the target amount is guaranteed. |
guaranteedTargetAmountAllowed |
boolean |
No | Indicates whether guaranteed target amount is allowed. |
id |
string (uuid) |
No | ID of this quote (GUID format). |
notices |
array of object |
No | Messages to display to the user. May be empty ([]) if there are no messages. |
notices[].link |
string,null |
No | URL that provides more details about the message. May be null if there's no URL. |
notices[].text |
string |
No | The message to display. |
notices[].type |
enum: WARNING, INFO, BLOCKED |
No | The type of message. If it is BLOCKED, don't allow the quote to be used to create the transfer. |
payOut |
string |
No | Mechanism Wise uses to deliver the transfer. Provided for information purposes. |
paymentOptions |
array of object |
No | List of the methods available to pay for the transfer. |
paymentOptions[].allowedProfileTypes |
array of enum: PERSONAL, BUSINESS |
No | Array of the profile types allowed to use this payment option. |
paymentOptions[].disabled |
boolean |
No | Indicates whether this option is enabled or not for this quote. |
paymentOptions[].disabledReason |
object |
No | Present only if a payment option is disabled. |
paymentOptions[].disabledReason.code |
string |
No | Denotes the reason a payment method is unavailable. |
paymentOptions[].disabledReason.message |
string |
No | User-friendly message to display when a method is unavailable. |
paymentOptions[].estimatedDelivery |
string (date-time) |
No | The estimated delivery time for this combination of payIn and payOut methods (assuming payIn is performed now). |
paymentOptions[].estimatedDeliveryDelays |
array of object |
No | Array of objects for delivery delays you can display to your customers. |
paymentOptions[].estimatedDeliveryDelays[].reason |
string |
No | Reason for the delivery delay. |
paymentOptions[].fee |
object |
No | Fee details for the quote. |
paymentOptions[].fee.discount |
number |
No | Any discounts that have been applied to this quote. |
paymentOptions[].fee.partner |
number |
No | Agreed-upon custom pricing, if applicable. |
paymentOptions[].fee.payIn |
number |
No | The fee for this payment option, based on the product type of the payment option. |
paymentOptions[].fee.total |
number |
No | The total fees to be paid. Use this value when displaying fees in your app. |
paymentOptions[].fee.transferwise |
number |
No | The fee to be paid _by the sender_ based on the current state of the quote. |
paymentOptions[].feePercentage |
number |
No | Fee percentage for this payment option. |
paymentOptions[].formattedEstimatedDelivery |
string |
No | A customer-friendly string for the estimated delivery date, which you can pass through to your front-end. |
paymentOptions[].payIn |
string |
No | Type of pay in method for this payment option. |
paymentOptions[].payInProduct |
string |
No | Pay-in product type. |
paymentOptions[].payOut |
string |
No | Type of pay out method for this payment option. |
paymentOptions[].price |
object |
No | Price details for the quote. |
paymentOptions[].price.calculatedOn |
object |
No | |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert |
object |
No | The amount, unrounded, that fees were calculated on and built up from. |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert.amount |
number |
No | |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert.currency |
string |
No | |
paymentOptions[].price.deferredFee |
object |
No | Deferred fee information from a pricingConfiguration override. |
paymentOptions[].price.deferredFee.amount |
number |
No | The amount of fees deferred by a pricingConfiguration override. |
paymentOptions[].price.deferredFee.currency |
string |
No | The currency of the deferred fee amount. |
paymentOptions[].price.items |
array of object |
No | Details the different elements contained in the total price. |
paymentOptions[].price.items[].explanation |
object |
No | Additional deails for a price breakdown item. |
paymentOptions[].price.items[].explanation.markdown |
string |
No | Formatted textual information about the item. |
paymentOptions[].price.items[].explanation.plainText |
string |
No | Plain text details about the item. |
paymentOptions[].price.items[].id |
string |
No | ID of the item. |
paymentOptions[].price.items[].label |
string |
No | Plain text describing the price element. |
paymentOptions[].price.items[].type |
string |
No | The type of the price item (for example, FEE or DISCOUNT). |
paymentOptions[].price.items[].value |
object |
No | Value details for the price.items object. |
paymentOptions[].price.items[].value.amount |
number |
No | Amount associated with this price. Can be negative for discounts. |
paymentOptions[].price.items[].value.currency |
string |
No | Currency of the price. |
paymentOptions[].price.items[].value.label |
string |
No | Plain text description of the price and currency. |
paymentOptions[].price.priceSetId |
integer (int64) |
No | ID of the price structure. |
paymentOptions[].price.total |
object |
No | The total fees to be paid. Use this value when displaying fees in your app. |
paymentOptions[].price.total.explanation |
object |
No | Provides more details about the price. |
paymentOptions[].price.total.label |
string |
No | Plain text describing the price structure. |
paymentOptions[].price.total.type |
string |
No | The type of the pricing element. |
paymentOptions[].price.total.value |
object |
No | Value details for the price.total object. |
paymentOptions[].price.total.value.amount |
number |
No | Amount to be paid. |
paymentOptions[].price.total.value.currency |
string |
No | Currency of the amount to be paid. |
paymentOptions[].price.total.value.label |
string |
No | Plain text version of the price. |
paymentOptions[].sourceAmount |
number |
No | Source amount when using this payment option. |
paymentOptions[].sourceCurrency |
string |
No | Source currency for this payment option. |
paymentOptions[].targetAmount |
number |
No | Target amount when using this payment option. |
paymentOptions[].targetCurrency |
string |
No | Target currency for this payment option. |
preferredPayIn |
string |
No | Preferred pay-in method. |
pricingConfiguration |
object |
No | Allows partners to override pricing configurations on a transfer level. |
pricingConfiguration.fee |
object |
No | |
pricingConfiguration.fee.fixed |
number |
No | The selected fixed fee, in source currency, that should be used in the pricingConfiguration. |
pricingConfiguration.fee.type |
string |
No | Identifies the type of fee to be configured. Options include only OVERRIDE. |
pricingConfiguration.fee.variable |
number |
No | The selected variable percentage, in decimal format, that should be used in the pricingConfiguration. |
profile |
integer (int64) |
No | Personal or business profile ID. |
providedAmountType |
enum: SOURCE, TARGET |
No | Indicates whether the quote was created as source or target. |
rate |
number |
No | Exchange rate value used for the conversion. |
rateExpirationTime |
string (date-time) |
No | Date and time the locked rate expires. |
rateType |
enum: FIXED, FLOATING |
No | Whether the rate is fixed or floating. |
sourceAmount |
number |
No | Amount in source currency to send. |
sourceCurrency |
string |
No | Source (sending) currency code. |
status |
enum: PENDING, ACCEPTED, FUNDED, EXPIRED |
No | Current status of the quote. |
targetAmount |
number |
No | Amount in target currency to be received by the recipient. |
targetAmountAllowed |
boolean |
No | Indicates whether target amount is allowed. |
targetCurrency |
string |
No | Target (receive) currency code. |
user |
integer (int64) |
No | User ID that created the quote. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.
POST /quotes
Operation ID: quoteCreateUnauthenticated.
Authentication: not required.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Request body
application/json
| Property | Type | Required | Description |
|---|---|---|---|
pricingConfiguration |
object |
No | Required when configured for your client ID. Includes a pricingConfiguration to be used for pricing calculations with the quote. |
pricingConfiguration.fee |
object |
No | |
pricingConfiguration.fee.fixed |
number |
No | The selected fixed fee that should be used in the pricingConfiguration. Always considered in source currency. |
pricingConfiguration.fee.type |
string |
No | Identifies the type of fee to be configured. Options include only OVERRIDE." |
pricingConfiguration.fee.variable |
number |
No | The selected variable percentage, in decimal format, that should be used in the pricingConfiguration. |
sourceAmount |
number,null |
No | Amount in source currency. Either sourceAmount or targetAmount is required, never both. |
sourceCurrency |
string |
Yes | Source (sending) currency code. |
targetAmount |
number,null |
No | Amount in target currency. |
targetCurrency |
string |
Yes | Target (receiving) currency code. |
Responses
200: Returns a quote object
application/json
| Property | Type | Required | Description |
|---|---|---|---|
createdTime |
string (date-time) |
No | Quote created timestamp. |
expirationTime |
string (date-time) |
No | The date and time the quote expires. |
guaranteedTargetAmount |
boolean |
No | Indicates whether the target amount is guaranteed. |
guaranteedTargetAmountAllowed |
boolean |
No | Indicates whether guaranteed target amount is allowed. |
id |
string (uuid) |
No | ID of this quote (GUID format). |
notices |
array of object |
No | Messages to display to the user. May be empty ([]) if there are no messages. |
notices[].link |
string,null |
No | URL that provides more details about the message. May be null if there's no URL. |
notices[].text |
string |
No | The message to display. |
notices[].type |
enum: WARNING, INFO, BLOCKED |
No | The type of message. If it is BLOCKED, don't allow the quote to be used to create the transfer. |
payOut |
string |
No | Mechanism Wise uses to deliver the transfer. Provided for information purposes. |
paymentOptions |
array of object |
No | List of the methods available to pay for the transfer. |
paymentOptions[].allowedProfileTypes |
array of enum: PERSONAL, BUSINESS |
No | Array of the profile types allowed to use this payment option. |
paymentOptions[].disabled |
boolean |
No | Indicates whether this option is enabled or not for this quote. |
paymentOptions[].disabledReason |
object |
No | Present only if a payment option is disabled. |
paymentOptions[].disabledReason.code |
string |
No | Denotes the reason a payment method is unavailable. |
paymentOptions[].disabledReason.message |
string |
No | User-friendly message to display when a method is unavailable. |
paymentOptions[].estimatedDelivery |
string (date-time) |
No | The estimated delivery time for this combination of payIn and payOut methods (assuming payIn is performed now). |
paymentOptions[].estimatedDeliveryDelays |
array of object |
No | Array of objects for delivery delays you can display to your customers. |
paymentOptions[].estimatedDeliveryDelays[].reason |
string |
No | Reason for the delivery delay. |
paymentOptions[].fee |
object |
No | Fee details for the quote. |
paymentOptions[].fee.discount |
number |
No | Any discounts that have been applied to this quote. |
paymentOptions[].fee.partner |
number |
No | Agreed-upon custom pricing, if applicable. |
paymentOptions[].fee.payIn |
number |
No | The fee for this payment option, based on the product type of the payment option. |
paymentOptions[].fee.total |
number |
No | The total fees to be paid. Use this value when displaying fees in your app. |
paymentOptions[].fee.transferwise |
number |
No | The fee to be paid _by the sender_ based on the current state of the quote. |
paymentOptions[].feePercentage |
number |
No | Fee percentage for this payment option. |
paymentOptions[].formattedEstimatedDelivery |
string |
No | A customer-friendly string for the estimated delivery date, which you can pass through to your front-end. |
paymentOptions[].payIn |
string |
No | Type of pay in method for this payment option. |
paymentOptions[].payInProduct |
string |
No | Pay-in product type. |
paymentOptions[].payOut |
string |
No | Type of pay out method for this payment option. |
paymentOptions[].price |
object |
No | Price details for the quote. |
paymentOptions[].price.calculatedOn |
object |
No | |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert |
object |
No | The amount, unrounded, that fees were calculated on and built up from. |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert.amount |
number |
No | |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert.currency |
string |
No | |
paymentOptions[].price.deferredFee |
object |
No | Deferred fee information from a pricingConfiguration override. |
paymentOptions[].price.deferredFee.amount |
number |
No | The amount of fees deferred by a pricingConfiguration override. |
paymentOptions[].price.deferredFee.currency |
string |
No | The currency of the deferred fee amount. |
paymentOptions[].price.items |
array of object |
No | Details the different elements contained in the total price. |
paymentOptions[].price.items[].explanation |
object |
No | Additional deails for a price breakdown item. |
paymentOptions[].price.items[].explanation.markdown |
string |
No | Formatted textual information about the item. |
paymentOptions[].price.items[].explanation.plainText |
string |
No | Plain text details about the item. |
paymentOptions[].price.items[].id |
string |
No | ID of the item. |
paymentOptions[].price.items[].label |
string |
No | Plain text describing the price element. |
paymentOptions[].price.items[].type |
string |
No | The type of the price item (for example, FEE or DISCOUNT). |
paymentOptions[].price.items[].value |
object |
No | Value details for the price.items object. |
paymentOptions[].price.items[].value.amount |
number |
No | Amount associated with this price. Can be negative for discounts. |
paymentOptions[].price.items[].value.currency |
string |
No | Currency of the price. |
paymentOptions[].price.items[].value.label |
string |
No | Plain text description of the price and currency. |
paymentOptions[].price.priceSetId |
integer (int64) |
No | ID of the price structure. |
paymentOptions[].price.total |
object |
No | The total fees to be paid. Use this value when displaying fees in your app. |
paymentOptions[].price.total.explanation |
object |
No | Provides more details about the price. |
paymentOptions[].price.total.label |
string |
No | Plain text describing the price structure. |
paymentOptions[].price.total.type |
string |
No | The type of the pricing element. |
paymentOptions[].price.total.value |
object |
No | Value details for the price.total object. |
paymentOptions[].price.total.value.amount |
number |
No | Amount to be paid. |
paymentOptions[].price.total.value.currency |
string |
No | Currency of the amount to be paid. |
paymentOptions[].price.total.value.label |
string |
No | Plain text version of the price. |
paymentOptions[].sourceAmount |
number |
No | Source amount when using this payment option. |
paymentOptions[].sourceCurrency |
string |
No | Source currency for this payment option. |
paymentOptions[].targetAmount |
number |
No | Target amount when using this payment option. |
paymentOptions[].targetCurrency |
string |
No | Target currency for this payment option. |
preferredPayIn |
string |
No | Preferred pay-in method. |
pricingConfiguration |
object |
No | Allows partners to override pricing configurations on a transfer level. |
pricingConfiguration.fee |
object |
No | |
pricingConfiguration.fee.fixed |
number |
No | The selected fixed fee, in source currency, that should be used in the pricingConfiguration. |
pricingConfiguration.fee.type |
string |
No | Identifies the type of fee to be configured. Options include only OVERRIDE. |
pricingConfiguration.fee.variable |
number |
No | The selected variable percentage, in decimal format, that should be used in the pricingConfiguration. |
profile |
integer (int64) |
No | Personal or business profile ID. |
providedAmountType |
enum: SOURCE, TARGET |
No | Indicates whether the quote was created as source or target. |
rate |
number |
No | Exchange rate value used for the conversion. |
rateExpirationTime |
string (date-time) |
No | Date and time the locked rate expires. |
rateType |
enum: FIXED, FLOATING |
No | Whether the rate is fixed or floating. |
sourceAmount |
number |
No | Amount in source currency to send. |
sourceCurrency |
string |
No | Source (sending) currency code. |
status |
enum: PENDING, ACCEPTED, FUNDED, EXPIRED |
No | Current status of the quote. |
targetAmount |
number |
No | Amount in target currency to be received by the recipient. |
targetAmountAllowed |
boolean |
No | Indicates whether target amount is allowed. |
targetCurrency |
string |
No | Target (receive) currency code. |
user |
integer (int64) |
No | User ID that created the quote. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.
load
GET /profiles/{profileId}/quotes/{quoteId}
Operation ID: quoteGet.
Authentication: bearer token (UserToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | Personal or business profile ID. |
quoteId |
path |
string (uuid) |
Yes | The quote ID (GUID format). |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
200: Returns a quote object
application/json
| Property | Type | Required | Description |
|---|---|---|---|
createdTime |
string (date-time) |
No | Quote created timestamp. |
expirationTime |
string (date-time) |
No | The date and time the quote expires. |
guaranteedTargetAmount |
boolean |
No | Indicates whether the target amount is guaranteed. |
guaranteedTargetAmountAllowed |
boolean |
No | Indicates whether guaranteed target amount is allowed. |
id |
string (uuid) |
No | ID of this quote (GUID format). |
notices |
array of object |
No | Messages to display to the user. May be empty ([]) if there are no messages. |
notices[].link |
string,null |
No | URL that provides more details about the message. May be null if there's no URL. |
notices[].text |
string |
No | The message to display. |
notices[].type |
enum: WARNING, INFO, BLOCKED |
No | The type of message. If it is BLOCKED, don't allow the quote to be used to create the transfer. |
payOut |
string |
No | Mechanism Wise uses to deliver the transfer. Provided for information purposes. |
paymentOptions |
array of object |
No | List of the methods available to pay for the transfer. |
paymentOptions[].allowedProfileTypes |
array of enum: PERSONAL, BUSINESS |
No | Array of the profile types allowed to use this payment option. |
paymentOptions[].disabled |
boolean |
No | Indicates whether this option is enabled or not for this quote. |
paymentOptions[].disabledReason |
object |
No | Present only if a payment option is disabled. |
paymentOptions[].disabledReason.code |
string |
No | Denotes the reason a payment method is unavailable. |
paymentOptions[].disabledReason.message |
string |
No | User-friendly message to display when a method is unavailable. |
paymentOptions[].estimatedDelivery |
string (date-time) |
No | The estimated delivery time for this combination of payIn and payOut methods (assuming payIn is performed now). |
paymentOptions[].estimatedDeliveryDelays |
array of object |
No | Array of objects for delivery delays you can display to your customers. |
paymentOptions[].estimatedDeliveryDelays[].reason |
string |
No | Reason for the delivery delay. |
paymentOptions[].fee |
object |
No | Fee details for the quote. |
paymentOptions[].fee.discount |
number |
No | Any discounts that have been applied to this quote. |
paymentOptions[].fee.partner |
number |
No | Agreed-upon custom pricing, if applicable. |
paymentOptions[].fee.payIn |
number |
No | The fee for this payment option, based on the product type of the payment option. |
paymentOptions[].fee.total |
number |
No | The total fees to be paid. Use this value when displaying fees in your app. |
paymentOptions[].fee.transferwise |
number |
No | The fee to be paid _by the sender_ based on the current state of the quote. |
paymentOptions[].feePercentage |
number |
No | Fee percentage for this payment option. |
paymentOptions[].formattedEstimatedDelivery |
string |
No | A customer-friendly string for the estimated delivery date, which you can pass through to your front-end. |
paymentOptions[].payIn |
string |
No | Type of pay in method for this payment option. |
paymentOptions[].payInProduct |
string |
No | Pay-in product type. |
paymentOptions[].payOut |
string |
No | Type of pay out method for this payment option. |
paymentOptions[].price |
object |
No | Price details for the quote. |
paymentOptions[].price.calculatedOn |
object |
No | |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert |
object |
No | The amount, unrounded, that fees were calculated on and built up from. |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert.amount |
number |
No | |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert.currency |
string |
No | |
paymentOptions[].price.deferredFee |
object |
No | Deferred fee information from a pricingConfiguration override. |
paymentOptions[].price.deferredFee.amount |
number |
No | The amount of fees deferred by a pricingConfiguration override. |
paymentOptions[].price.deferredFee.currency |
string |
No | The currency of the deferred fee amount. |
paymentOptions[].price.items |
array of object |
No | Details the different elements contained in the total price. |
paymentOptions[].price.items[].explanation |
object |
No | Additional deails for a price breakdown item. |
paymentOptions[].price.items[].explanation.markdown |
string |
No | Formatted textual information about the item. |
paymentOptions[].price.items[].explanation.plainText |
string |
No | Plain text details about the item. |
paymentOptions[].price.items[].id |
string |
No | ID of the item. |
paymentOptions[].price.items[].label |
string |
No | Plain text describing the price element. |
paymentOptions[].price.items[].type |
string |
No | The type of the price item (for example, FEE or DISCOUNT). |
paymentOptions[].price.items[].value |
object |
No | Value details for the price.items object. |
paymentOptions[].price.items[].value.amount |
number |
No | Amount associated with this price. Can be negative for discounts. |
paymentOptions[].price.items[].value.currency |
string |
No | Currency of the price. |
paymentOptions[].price.items[].value.label |
string |
No | Plain text description of the price and currency. |
paymentOptions[].price.priceSetId |
integer (int64) |
No | ID of the price structure. |
paymentOptions[].price.total |
object |
No | The total fees to be paid. Use this value when displaying fees in your app. |
paymentOptions[].price.total.explanation |
object |
No | Provides more details about the price. |
paymentOptions[].price.total.label |
string |
No | Plain text describing the price structure. |
paymentOptions[].price.total.type |
string |
No | The type of the pricing element. |
paymentOptions[].price.total.value |
object |
No | Value details for the price.total object. |
paymentOptions[].price.total.value.amount |
number |
No | Amount to be paid. |
paymentOptions[].price.total.value.currency |
string |
No | Currency of the amount to be paid. |
paymentOptions[].price.total.value.label |
string |
No | Plain text version of the price. |
paymentOptions[].sourceAmount |
number |
No | Source amount when using this payment option. |
paymentOptions[].sourceCurrency |
string |
No | Source currency for this payment option. |
paymentOptions[].targetAmount |
number |
No | Target amount when using this payment option. |
paymentOptions[].targetCurrency |
string |
No | Target currency for this payment option. |
preferredPayIn |
string |
No | Preferred pay-in method. |
pricingConfiguration |
object |
No | Allows partners to override pricing configurations on a transfer level. |
pricingConfiguration.fee |
object |
No | |
pricingConfiguration.fee.fixed |
number |
No | The selected fixed fee, in source currency, that should be used in the pricingConfiguration. |
pricingConfiguration.fee.type |
string |
No | Identifies the type of fee to be configured. Options include only OVERRIDE. |
pricingConfiguration.fee.variable |
number |
No | The selected variable percentage, in decimal format, that should be used in the pricingConfiguration. |
profile |
integer (int64) |
No | Personal or business profile ID. |
providedAmountType |
enum: SOURCE, TARGET |
No | Indicates whether the quote was created as source or target. |
rate |
number |
No | Exchange rate value used for the conversion. |
rateExpirationTime |
string (date-time) |
No | Date and time the locked rate expires. |
rateType |
enum: FIXED, FLOATING |
No | Whether the rate is fixed or floating. |
sourceAmount |
number |
No | Amount in source currency to send. |
sourceCurrency |
string |
No | Source (sending) currency code. |
status |
enum: PENDING, ACCEPTED, FUNDED, EXPIRED |
No | Current status of the quote. |
targetAmount |
number |
No | Amount in target currency to be received by the recipient. |
targetAmountAllowed |
boolean |
No | Indicates whether target amount is allowed. |
targetCurrency |
string |
No | Target (receive) currency code. |
user |
integer (int64) |
No | User ID that created the quote. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.
update
PATCH /profiles/{profileId}/quotes/{quoteId}
Operation ID: quoteUpdate.
Authentication: bearer token (UserToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | Personal or business profile ID. |
quoteId |
path |
string (uuid) |
Yes | The quote ID (GUID format). |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Request body
application/merge-patch+json
| Property | Type | Required | Description |
|---|---|---|---|
payOut |
string |
No | Optional. Preferred payout method. Default value is BANK_TRANSFER. Examples of other accepted values include BALANCE, SWIFT, SWIFT_OUR, ALIPAY, and INTERAC. |
paymentMetadata |
object |
No | Optional. Used to pass additional metadata about the intended transfer. |
paymentMetadata.transferNature |
string |
No | Optional. Used to pass transfer nature for calculating proper tax amounts (IOF) for transfers to and from BRL. Accepted values are shown dynamically in transfer requirements. |
pricingConfiguration |
object |
No | Required when configured for your client ID. Includes pricingConfiguration to be used for pricing calculations with the quote. If previously passed, the existing pricingConfiguration will remain and not be updated. |
pricingConfiguration.fee |
object |
No | |
pricingConfiguration.fee.fixed |
number |
No | The selected fixed fee, in source currency, that should be used in the pricingConfiguration. |
pricingConfiguration.fee.type |
string |
No | Identifies the type of fee to be configured. Options include only OVERRIDE. |
pricingConfiguration.fee.variable |
number |
No | The selected variable percentage, in decimal format, that should be used in the pricingConfiguration. |
targetAccount |
integer (int64) |
No | ID of transfer recipient, found in the create recipient response. |
Responses
200: Returns a quote object
application/json
| Property | Type | Required | Description |
|---|---|---|---|
createdTime |
string (date-time) |
No | Quote created timestamp. |
expirationTime |
string (date-time) |
No | The date and time the quote expires. |
guaranteedTargetAmount |
boolean |
No | Indicates whether the target amount is guaranteed. |
guaranteedTargetAmountAllowed |
boolean |
No | Indicates whether guaranteed target amount is allowed. |
id |
string (uuid) |
No | ID of this quote (GUID format). |
notices |
array of object |
No | Messages to display to the user. May be empty ([]) if there are no messages. |
notices[].link |
string,null |
No | URL that provides more details about the message. May be null if there's no URL. |
notices[].text |
string |
No | The message to display. |
notices[].type |
enum: WARNING, INFO, BLOCKED |
No | The type of message. If it is BLOCKED, don't allow the quote to be used to create the transfer. |
payOut |
string |
No | Mechanism Wise uses to deliver the transfer. Provided for information purposes. |
paymentOptions |
array of object |
No | List of the methods available to pay for the transfer. |
paymentOptions[].allowedProfileTypes |
array of enum: PERSONAL, BUSINESS |
No | Array of the profile types allowed to use this payment option. |
paymentOptions[].disabled |
boolean |
No | Indicates whether this option is enabled or not for this quote. |
paymentOptions[].disabledReason |
object |
No | Present only if a payment option is disabled. |
paymentOptions[].disabledReason.code |
string |
No | Denotes the reason a payment method is unavailable. |
paymentOptions[].disabledReason.message |
string |
No | User-friendly message to display when a method is unavailable. |
paymentOptions[].estimatedDelivery |
string (date-time) |
No | The estimated delivery time for this combination of payIn and payOut methods (assuming payIn is performed now). |
paymentOptions[].estimatedDeliveryDelays |
array of object |
No | Array of objects for delivery delays you can display to your customers. |
paymentOptions[].estimatedDeliveryDelays[].reason |
string |
No | Reason for the delivery delay. |
paymentOptions[].fee |
object |
No | Fee details for the quote. |
paymentOptions[].fee.discount |
number |
No | Any discounts that have been applied to this quote. |
paymentOptions[].fee.partner |
number |
No | Agreed-upon custom pricing, if applicable. |
paymentOptions[].fee.payIn |
number |
No | The fee for this payment option, based on the product type of the payment option. |
paymentOptions[].fee.total |
number |
No | The total fees to be paid. Use this value when displaying fees in your app. |
paymentOptions[].fee.transferwise |
number |
No | The fee to be paid _by the sender_ based on the current state of the quote. |
paymentOptions[].feePercentage |
number |
No | Fee percentage for this payment option. |
paymentOptions[].formattedEstimatedDelivery |
string |
No | A customer-friendly string for the estimated delivery date, which you can pass through to your front-end. |
paymentOptions[].payIn |
string |
No | Type of pay in method for this payment option. |
paymentOptions[].payInProduct |
string |
No | Pay-in product type. |
paymentOptions[].payOut |
string |
No | Type of pay out method for this payment option. |
paymentOptions[].price |
object |
No | Price details for the quote. |
paymentOptions[].price.calculatedOn |
object |
No | |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert |
object |
No | The amount, unrounded, that fees were calculated on and built up from. |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert.amount |
number |
No | |
paymentOptions[].price.calculatedOn.unroundedAmountToConvert.currency |
string |
No | |
paymentOptions[].price.deferredFee |
object |
No | Deferred fee information from a pricingConfiguration override. |
paymentOptions[].price.deferredFee.amount |
number |
No | The amount of fees deferred by a pricingConfiguration override. |
paymentOptions[].price.deferredFee.currency |
string |
No | The currency of the deferred fee amount. |
paymentOptions[].price.items |
array of object |
No | Details the different elements contained in the total price. |
paymentOptions[].price.items[].explanation |
object |
No | Additional deails for a price breakdown item. |
paymentOptions[].price.items[].explanation.markdown |
string |
No | Formatted textual information about the item. |
paymentOptions[].price.items[].explanation.plainText |
string |
No | Plain text details about the item. |
paymentOptions[].price.items[].id |
string |
No | ID of the item. |
paymentOptions[].price.items[].label |
string |
No | Plain text describing the price element. |
paymentOptions[].price.items[].type |
string |
No | The type of the price item (for example, FEE or DISCOUNT). |
paymentOptions[].price.items[].value |
object |
No | Value details for the price.items object. |
paymentOptions[].price.items[].value.amount |
number |
No | Amount associated with this price. Can be negative for discounts. |
paymentOptions[].price.items[].value.currency |
string |
No | Currency of the price. |
paymentOptions[].price.items[].value.label |
string |
No | Plain text description of the price and currency. |
paymentOptions[].price.priceSetId |
integer (int64) |
No | ID of the price structure. |
paymentOptions[].price.total |
object |
No | The total fees to be paid. Use this value when displaying fees in your app. |
paymentOptions[].price.total.explanation |
object |
No | Provides more details about the price. |
paymentOptions[].price.total.label |
string |
No | Plain text describing the price structure. |
paymentOptions[].price.total.type |
string |
No | The type of the pricing element. |
paymentOptions[].price.total.value |
object |
No | Value details for the price.total object. |
paymentOptions[].price.total.value.amount |
number |
No | Amount to be paid. |
paymentOptions[].price.total.value.currency |
string |
No | Currency of the amount to be paid. |
paymentOptions[].price.total.value.label |
string |
No | Plain text version of the price. |
paymentOptions[].sourceAmount |
number |
No | Source amount when using this payment option. |
paymentOptions[].sourceCurrency |
string |
No | Source currency for this payment option. |
paymentOptions[].targetAmount |
number |
No | Target amount when using this payment option. |
paymentOptions[].targetCurrency |
string |
No | Target currency for this payment option. |
preferredPayIn |
string |
No | Preferred pay-in method. |
pricingConfiguration |
object |
No | Allows partners to override pricing configurations on a transfer level. |
pricingConfiguration.fee |
object |
No | |
pricingConfiguration.fee.fixed |
number |
No | The selected fixed fee, in source currency, that should be used in the pricingConfiguration. |
pricingConfiguration.fee.type |
string |
No | Identifies the type of fee to be configured. Options include only OVERRIDE. |
pricingConfiguration.fee.variable |
number |
No | The selected variable percentage, in decimal format, that should be used in the pricingConfiguration. |
profile |
integer (int64) |
No | Personal or business profile ID. |
providedAmountType |
enum: SOURCE, TARGET |
No | Indicates whether the quote was created as source or target. |
rate |
number |
No | Exchange rate value used for the conversion. |
rateExpirationTime |
string (date-time) |
No | Date and time the locked rate expires. |
rateType |
enum: FIXED, FLOATING |
No | Whether the rate is fixed or floating. |
sourceAmount |
number |
No | Amount in source currency to send. |
sourceCurrency |
string |
No | Source (sending) currency code. |
status |
enum: PENDING, ACCEPTED, FUNDED, EXPIRED |
No | Current status of the quote. |
targetAmount |
number |
No | Amount in target currency to be received by the recipient. |
targetAmountAllowed |
boolean |
No | Indicates whether target amount is allowed. |
targetCurrency |
string |
No | Target (receive) currency code. |
user |
integer (int64) |
No | User ID that created the quote. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.