API

Comparison

A comparison of what providers charge for a transfer.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Method	Route	SDK operation	Returns
`GET`	`/comparisons`	`load`	Comparison data retrieved successfully

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:

comparison, err := client.Comparison(nil).Load(map[string]any{"source_currency": "example", "target_currency": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(comparison)

Lua

Construct client as shown in the Lua setup, then call the operations:

local comparison, err = client:Comparison():load({ source_currency = "example", target_currency = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$comparison = $client->Comparison()->load(["source_currency" => "example", "target_currency" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

comparison = client.Comparison().load({"source_currency": "example", "target_currency": "example"})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

comparison = client.Comparison.load({ "source_currency" => "example", "target_currency" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const comparison = await client.Comparison().load({ source_currency: "example", target_currency: "example" })

Fields

Field	Type	Required	Description
`amount`	`number`	No	The comparison amount
`amountType`	`string`	No	Whether the amount represents a send amount or recipient gets amount
`providerCountry`	`one,string,null`	No	Provider country (ISO 3166-1 Alpha-2 code)
`providerTypes`	`array`	No	List of provider types included in the response
`providers`	`array`	No	List of providers with their estimated quotes
`sourceCountry`	`one,string,null`	No	Source country (ISO 3166-1 Alpha-2 code)
`sourceCurrency`	`one,string,null`	No	ISO 4217 source currency code
`targetCountry`	`one,string,null`	No	Target country (ISO 3166-1 Alpha-2 code)
`targetCurrency`	`one,string,null`	No	ISO 4217 target currency code

load

`GET` /comparisons

Operation ID: comparisonGet.

Authentication: bearer token (UserToken) or bearer token (PersonalToken) or bearer token (ClientCredentialsToken).

Parameters

Parameter	In	Type	Required	Description
`sourceCurrency`	`query`	`string`	Yes	ISO 4217 source currency code
`targetCurrency`	`query`	`string`	Yes	ISO 4217 target currency code
`sendAmount`	`query`	`number`	No	Amount to send in source currency. Must provide either `sendAmount` or `recipientGetsAmount`.
`recipientGetsAmount`	`query`	`number`	No	Amount to be received in target currency. Must provide either `sendAmount` or `recipientGetsAmount`.
`midMarketRate`	`query`	`number`	No	Current mid-market rate between the source and target currency
`wiseFee`	`query`	`number`	No	Wise's fee, if the Wise quote is known
`wiseEstimatedDelivery`	`query`	`string`	No	Wise's estimated delivery timestamp, if the Wise quote is known
`wiseQuoteCreatedTime`	`query`	`string`	No	Timestamp when the Wise quote was created
`payInMethod`	`query`	`string`	No	Change the pay-in method of the Wise quote only (all other quotes will remain as bank transfer)
`sourceCountry`	`query`	`string`	No	Filter by source country (ISO 3166-1 Alpha-2 code)
`targetCountry`	`query`	`string`	No	Filter by target country (ISO 3166-1 Alpha-2 code)
`providerCountry`	`query`	`string`	No	Filter by provider country (ISO 3166-1 Alpha-2 code)
`filter`	`query`	`enum: POPULAR`	No	Filter by most popular competitors
`numberOfProviders`	`query`	`integer (int32)`	No	Number of popular competitors to return if `filter` is set to `POPULAR` - default value is 4
`providerTypes`	`query`	`array of enum: bank, moneytransferprovider, travelMoney`	No	Filter by provider type
`providers`	`query`	`string`	No	Filter by specific provider aliases
`excludePartners`	`query`	`boolean`	No	Exclude Wise's partner banks - default true
`includeWise`	`query`	`boolean`	No	Overrides filters to ensure Wise data is returned, even if exclusionary filters are applied
`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: Comparison data retrieved successfully

application/json

Property	Type	Required	Description
`amount`	`number`	No	The comparison amount
`amountType`	`string`	No	Whether the amount represents a send amount or recipient gets amount
`providerCountry`	`string,null`	No	Provider country (ISO 3166-1 Alpha-2 code)
`providerTypes`	`array of string`	No	List of provider types included in the response
`providers`	`array of object`	No	List of providers with their estimated quotes
`providers[].alias`	`string`	No	Provider alias (lowercase slug name)
`providers[].id`	`integer (int64)`	No	Provider ID
`providers[].logos`	`object`	No	URLs pointing to provider logos (svg, png)
`providers[].logos.altText`	`string`	No	Alt text for the provider logo
`providers[].logos.circle`	`object`	No
`providers[].logos.circle.pngUrl`	`string,null`	No
`providers[].logos.circle.svgUrl`	`string,null`	No
`providers[].logos.inverse`	`object`	No
`providers[].logos.inverse.pngUrl`	`string,null`	No
`providers[].logos.inverse.svgUrl`	`string,null`	No
`providers[].logos.normal`	`object`	No
`providers[].logos.normal.pngUrl`	`string,null`	No
`providers[].logos.normal.svgUrl`	`string,null`	No
`providers[].logos.white`	`object`	No
`providers[].logos.white.pngUrl`	`string,null`	No
`providers[].logos.white.svgUrl`	`string,null`	No
`providers[].name`	`string`	No	Provider name (presentational / formal name)
`providers[].partner`	`boolean`	No	Whether a partner of Wise or not
`providers[].quotes`	`array of object`	No	An array of estimated quotes per provider
`providers[].quotes[].dateCollected`	`string`	No	The date of collection for the original quote
`providers[].quotes[].deliveryEstimation`	`object`	No	Delivery estimation details - that is a speed estimate
`providers[].quotes[].deliveryEstimation.duration`	`object`	No	Duration range
`providers[].quotes[].deliveryEstimation.duration.max`	`string,null`	No	Maximum quoted time for transaction delivery (ISO 8601 duration format)
`providers[].quotes[].deliveryEstimation.duration.min`	`string,null`	No	Minimum quoted time for transaction delivery (ISO 8601 duration format)
`providers[].quotes[].deliveryEstimation.providerGivesEstimate`	`boolean`	No	Whether a provider publicly surfaces a speed estimate or not
`providers[].quotes[].fee`	`number`	No	The estimated fee for the provider for this quote
`providers[].quotes[].isConsideredMidMarketRate`	`boolean`	No	Whether the provider's rate is close enough to the true mid-market rate to be classified as a mid-market rate
`providers[].quotes[].markup`	`number`	No	Percentage markup on the quoted rate compared to the mid-market rate
`providers[].quotes[].rate`	`number`	No	The live estimated exchange rate for the provider for this quote
`providers[].quotes[].receivedAmount`	`number,null`	No	The total estimated received amount for the provider for this quote (non-null only if a send amount request was made)
`providers[].quotes[].sendAmount`	`number,null`	No	The total estimated send amount for the provider for this quote (non-null only if a recipient gets amount request was made)
`providers[].quotes[].sourceCountry`	`string,null`	No	Source country (ISO 3166-1 Alpha-2 code)
`providers[].quotes[].targetCountry`	`string,null`	No	Target country (ISO 3166-1 Alpha-2 code)
`providers[].type`	`string`	No	Provider type: bank, money transfer provider, or travel money
`sourceCountry`	`string,null`	No	Source country (ISO 3166-1 Alpha-2 code)
`sourceCurrency`	`string,null`	No	ISO 4217 source currency code
`targetCountry`	`string,null`	No	Target country (ISO 3166-1 Alpha-2 code)
`targetCurrency`	`string,null`	No	ISO 4217 target currency code

Example response:

{
  "amount": 10000,
  "amountType": "SEND",
  "providerCountry": null,
  "providerTypes": [
    "bank",
    "moneyTransferProvider"
  ],
  "providers": [
    {
      "alias": "wise",
      "id": 39,
      "logos": {
        "altText": "Wise",
        "circle": {
          "pngUrl": null,
          "svgUrl": "https://dq8dwmysp7hk1.cloudfront.net/logos/wise-mark.svg"
        },
        "inverse": {
          "pngUrl": "https://wise.com/public-resources/assets/logos/wise-personal/logo_inverse.png",
          "svgUrl": "https://wise.com/public-resources/assets/logos/wise-personal/logo_inverse.svg"
        },
        "normal": {
          "pngUrl": "https://wise.com/public-resources/assets/logos/wise-personal/logo.png",
          "svgUrl": "https://wise.com/public-resources/assets/logos/wise-personal/logo.svg"
        },
        "white": {
          "pngUrl": "https://wise.com/public-resources/assets/logos/wise-personal/logo_white.png",
          "svgUrl": "https://wise.com/public-resources/assets/logos/wise-personal/logo_white.svg"
        }
      },
      "name": "Wise",
      "partner": false,
      "quotes": [
        {
          "dateCollected": "2019-10-22T14:36:43Z",
          "deliveryEstimation": {
            "duration": {
              "max": "PT20H8M16.305111S",
              "min": "PT20H8M16.305111S"
            },
            "providerGivesEstimate": true
          },
          "fee": 37.12,
          "isConsideredMidMarketRate": true,
          "markup": 0,
          "rate": 1.15989,
          "receivedAmount": 11555.84,
          "sendAmount": null,
          "sourceCountry": null,
          "targetCountry": null
        }
      ],
      "type": "moneyTransferProvider"
    },
    {
      "alias": "barclays",
      "id": 1,
      "logos": {
        "altText": "Barclays",
        "circle": {
          "pngUrl": null,
          "svgUrl": "https://dq8dwmysp7hk1.cloudfront.net/logos/barclays-mark.svg"
        },
        "inverse": {
          "pngUrl": null,
          "svgUrl": null
        },
        "normal": {
          "pngUrl": "https://dq8dwmysp7hk1.cloudfront.net/logos/barclays.png",
          "svgUrl": "https://dq8dwmysp7hk1.cloudfront.net/logos/barclays.svg"
        },
        "white": {
          "pngUrl": "https://dq8dwmysp7hk1.cloudfront.net/logos/barclays--white.png",
          "svgUrl": "https://dq8dwmysp7hk1.cloudfront.net/logos/barclays--white.svg"
        }
      },
      "name": "Barclays",
      "partner": false,
      "quotes": [
        {
          "dateCollected": "2019-10-22T14:00:04Z",
          "deliveryEstimation": {
            "duration": {
              "max": "PT24H",
              "min": "PT24H"
            },
            "providerGivesEstimate": true
          },
          "fee": 0,
          "isConsideredMidMarketRate": false,
          "markup": 2.75592858,
          "rate": 1.12792426,
          "receivedAmount": 11279.24,
          "sendAmount": null,
          "sourceCountry": "GB",
          "targetCountry": "ES"
        }
      ],
      "type": "bank"
    }
  ],
  "sourceCountry": null,
  "sourceCurrency": "GBP",
  "targetCountry": null,
  "targetCurrency": "EUR"
}

429: Rate limit exceeded. Retry after the number of seconds specified in the `Retry-After` header