Others

fx-controller

getExchangeRatesComparison

Required scopes - transfers

POST//transfers:8080/v1/fx/comparisons

Body

application/json

request

amount*number

sourceCurrency*CurrencyUnit

targetCurrency*CurrencyUnit

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/comparisons', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 0,
      "sourceCurrency": {},
      "targetCurrency": {}
    }),
});
const data = await response.json();

getExchangeRates

Required scopes - transfers

POST//transfers:8080/v1/fx/exchange-rates

Body

application/json

request

sourceCurrency*CurrencyUnit

targetCurrency*CurrencyUnit

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/exchange-rates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceCurrency": {},
      "targetCurrency": {}
    }),
});
const data = await response.json();

getFxProviders

Required scopes - transfers

GET//transfers:8080/v1/fx/providers

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/providers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

fx-provider-controller

getBranches

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/{countryCode}/{bankCode}/branches

Path parameters

bankCode*string

bankCode

countryCode*string

countryCode

provider*enum

provider

WISE

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/{countryCode}/{bankCode}/branches', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

getBanks

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/{countryCode}/banks

Path parameters

countryCode*string

countryCode

provider*enum

provider

WISE

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/{countryCode}/banks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

getStates

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/{countryCode}/states

Path parameters

countryCode*string

countryCode

provider*enum

provider

WISE

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/{countryCode}/states', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

getCountries

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/countries

Path parameters

provider*enum

provider

WISE

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/countries', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

getAvailableCurrencies

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/currencies

Path parameters

provider*enum

provider

WISE

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/currencies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

getCurrencyDetails

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/currencies/{sourceCurrency}

Path parameters

provider*enum

provider

WISE

sourceCurrency*string

sourceCurrency

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/currencies/{sourceCurrency}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

fx-recipients-controller

getRecipientAccounts

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/recipients

Path parameters

provider*enum

provider

WISE

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/recipients', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

createRecipient

Required scopes - transfers

POST//transfers:8080/v1/fx/{provider}/recipients

Path parameters

provider*enum

provider

WISE

Body

application/json

request

recipient*object

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/recipients', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

getRecipient

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/recipients/{id}

Path parameters

id*string

id

provider*enum

provider

WISE

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/recipients/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

deleteRecipient

Required scopes - transfers

DELETE//transfers:8080/v1/fx/{provider}/recipients/{id}

Path parameters

id*string

id

provider*enum

provider

WISE

Response

202204401403

Accepted

Body

application/json

recipientFxRecipientResponse

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/recipients/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "recipient": {
    "accountSummary": "text",
    "active": false,
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "addressLine3": "text",
      "city": "text",
      "country": "text",
      "name": "text",
      "postalCode": "text"
    },
    "commonFieldMap": {
      "accountNumberField": "text",
      "bankCodeField": "text"
    },
    "country": "text",
    "currency": "text",
    "details": {
      "reference": "text"
    },
    "displayFields": [
      {
        "label": "text",
        "value": "text"
      }
    ],
    "email": "text",
    "hash": "text",
    "isDefaultAccount": false,
    "legalEntityType": "text",
    "longAccountSummary": "text",
    "name": {
      "fullName": "text"
    },
    "ownedByCustomer": false,
    "type": "text"
  }
}

getAccountRequirements

Required scopes - transfers

POST//transfers:8080/v1/fx/{provider}/recipients/account-requirements

Path parameters

provider*enum

provider

WISE

Body

application/json

request

sendMoney*number

sourceCurrency*CurrencyUnit

targetCurrency*CurrencyUnit

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/recipients/account-requirements', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sendMoney": 0,
      "sourceCurrency": {},
      "targetCurrency": {}
    }),
});
const data = await response.json();

fx-transfer-controller

createTransfer

Required scopes - transfers

POST//transfers:8080/v1/fx/{provider}/transfers

Path parameters

provider*enum

provider

WISE

Body

application/json

request

fromAccount*InstructedAccount

quoteId*string

recipientId*string

referencestring

refundRecipientIdstring

sourceOfFundsstring

transferIdstring

transferPurposestring

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/transfers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fromAccount": {
        "format": "INTERNAL",
        "number": "text"
      },
      "quoteId": "text",
      "recipientId": "text"
    }),
});
const data = await response.json();

getTransfer

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/transfers/{id}

Path parameters

id*string

id

provider*enum

provider

WISE

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/transfers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

getTempQuote

Required scopes - transfers

POST//transfers:8080/v1/fx/{provider}/transfers/anonymous-quote

Path parameters

provider*enum

provider

WISE

Body

application/json

request

sourceAmountnumber

sourceCurrency*CurrencyUnit

targetAmountnumber

targetCurrency*CurrencyUnit

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/transfers/anonymous-quote', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceCurrency": {},
      "targetCurrency": {}
    }),
});
const data = await response.json();

createQuote

Required scopes - transfers

POST//transfers:8080/v1/fx/{provider}/transfers/quote

Path parameters

provider*enum

provider

WISE

Body

application/json

request

sourceAmount*number

sourceCurrency*CurrencyUnit

targetAmountnumber

targetCurrency*CurrencyUnit

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/transfers/quote', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceAmount": 0,
      "sourceCurrency": {},
      "targetCurrency": {}
    }),
});
const data = await response.json();

getQuote

Required scopes - transfers

GET//transfers:8080/v1/fx/{provider}/transfers/quote/{id}

Path parameters

id*string

id

provider*enum

provider

WISE

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/transfers/quote/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

updateQuote

Required scopes - transfers

PATCH//transfers:8080/v1/fx/{provider}/transfers/quote/{id}

Path parameters

id*string

id

provider*enum

provider

WISE

Body

application/json

request

recipientId*string

transferIdstring

Response

202204401403

Accepted

Body

application/json

quoteQuote

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/transfers/quote/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "recipientId": "text"
    }),
});
const data = await response.json();

Response

{
  "quote": {
    "createdTime": "2024-05-06T12:49:20.025Z",
    "expirationTime": "2024-05-06T12:49:20.025Z",
    "fee": 0,
    "formattedEstimatedDelivery": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "notices": [
      {
        "link": "text",
        "text": "text",
        "type": "text"
      }
    ],
    "payOut": "text",
    "providedAmountType": "text",
    "rate": 0,
    "rateExpirationTime": "2024-05-06T12:49:20.025Z",
    "rateType": "text",
    "sourceAmount": 0,
    "sourceCurrency": "text",
    "status": "text",
    "targetAmount": 0,
    "targetCurrency": "text"
  }
}

getTransferRequirements

Required scopes - transfers

POST//transfers:8080/v1/fx/{provider}/transfers/requirements

Path parameters

provider*enum

provider

WISE

Body

application/json

request

quoteId*string

recipientId*string

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//transfers:8080/v1/fx/{provider}/transfers/requirements', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "quoteId": "text",
      "recipientId": "text"
    }),
});
const data = await response.json();