Wise

This page contains the details of wise endpoints and how to configure the service using the middleware.

What is Wise?

Wise (previously known as TransferWise) is an online platform that anyone can use to transfer money between two bank accounts, regardless of location. Making a domestic money transfer has always been relatively simple, but an international one can be tricky and come with more fees. Wise is one of the best solutions to transfer money internationally. You can use it to send money to someone else, or even another account of your own, in another country.

Wise User Option

The Wise integration can be with two types of users.

1. New user of Wise

2. Existing Wise users

The authorisation flow is different for each type, and the process details can be found in the User Onboarding Section.

User Onboarding

The user onboarding process is different for the mentioned two types of users. For the new users to Wise and the integration, please look at this page, and for the existing wise users, please look at this page to understand the onboarding process.

How to know if a user exists or not

To know which user flow to follow, the first thing required is to know if the user already has a Wise account with the email address associated with the bank account. Make a GET request to the following endpoint:

GEThttp://localhost:8084/v1/customers/fx/WISE/users/status

Path parameters

provider*enum

WISE

Response

202

Accepted

Body

application/json

statusenum

NOT_EXISTSREQUIRES_AUTHORIZATIONOK

typeenum

CREATEDLINKEDUNKNOWN

profileenum

UPDATE_REQUIREDOKUNKNOWN

Request

JavaScriptCurl

const response = await fetch('http://localhost:8084/v1/customers/fx/WISE/users/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "NOT_EXISTS",
  "type": "CREATED",
  "profile": "UPDATE_REQUIRED"
}

The status will contain "NOT_EXISTS" if the user doesn't have an account with the email. If it contains "OK", then it means that the account exists and is already linked with the integration. For this, follow the existing user flow. The same goes for the "REQUIRES_AUTHORIZATION" value as well.

Create a Quote

Transferring the money starts with a quote. This defines the basic information required for a Wise transfer - the currencies to send between, the amount to send and the profile of who is sending the money. In this step, the user chooses the sending and the receiving currency. To create a quote, make a POST request to the following endpoint:

POSThttp://localhost:8086/v1/fx/WISE/transfers/quote

Body

application/json

sourceCurrency*object

targetCurrency*object

sourceAmount*number

targetAmountnumber

Response

202

Accepted

Body

application/json

quoteQuote (object)

Request

JavaScriptCurl

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

Response

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

Create or Select Recipient

The recipient is the one who is receiving the money. A profile can have a saved recipient, and the user can select a recipient from the saved recipient list. The account will not have any available recipient for a new account, so you must create a recipient first. Make a POST request below to add a recipient:

POSThttp://localhost:8086/v1/fx/WISE/recipients

Path parameters

provider*enum

WISE

Body

application/json

recipient*object

Response

202

Accepted

Body

application/json

recipientFxRecipientResponse (object)

Request

JavaScriptCurl

const response = await fetch('http://localhost:8086/v1/fx/WISE/recipients', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "recipient": {}
    }),
});
const data = await response.json();

Response

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

Get existing recipients

To get the existing recipients, make a GET request to the following endpoint:

GEThttp://localhost:8086/v1/fx/WISE/recipients

Path parameters

provider*enum

WISE

Response

202

Accepted

Body

application/json

recipientsarray of FxRecipientResponse (object)

Request

JavaScriptCurl

const response = await fetch('http://localhost:8086/v1/fx/WISE/recipients', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

The response will contain a list of objects with the recipients' details.

Updating the quote with the recipient's details

After selecting the recipient, you must update the quote with the recipient's information to process the transfer. The request requires the quote id from the previous request. Make a PATCH request to the following endpoint to update the quote with the recipient id:

POSThttp://localhost:8086/v1/fx/WISE/recipients/account-requirements

Body

application/json

sourceCurrency*object

targetCurrency*object

sendMoney*number

Response

202

Accepted

Body

application/json

requirementsAccountRequirementsEnvelope (object)

Request

JavaScriptCurl

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

Response

{
  "requirements": {
    "requirements": [
      {
        "type": "text",
        "title": "text",
        "fields": [
          {
            "name": "text",
            "group": [
              {
                "key": "text",
                "name": "text",
                "type": "text",
                "refreshRequirementsOnChange": false,
                "required": false,
                "valuesAllowed": [
                  {
                    "key": "text",
                    "name": "text"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Transfer Creation and Fund Transfer

The final step of a transfer is to create the transfer with information from previous requests. To create the transfer, make a POST request to the following endpoint:

POSThttp://localhost:8086/v1/transfers

Body

application/json

any

Response

202

Accepted

Body

application/json

idstring

Request

JavaScriptCurl

const response = await fetch('http://localhost:8086/v1/transfers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "id": "text"
}

Track the Transfer Status

To get the details of a transfer, make a GET request to the following endpoint with the transfer id:

GEThttp://localhost:8086/v1/fx/WISE/transfers/{id}

Path parameters

id*string

Response

202

Accepted

Body

application/json

quoteQuote (object)

requirementsarray of TransferRequirement (object)

estimatedDeliveryDatestring

issuesarray of Issue (object)

Request

JavaScriptCurl

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

Response

{
  "quote": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "sourceCurrency": "text",
    "targetCurrency": "text",
    "sourceAmount": 0,
    "targetAmount": 0,
    "payOut": "text",
    "rate": 0,
    "createdTime": "2024-05-06T15:29:57.320Z",
    "fee": 0,
    "rateType": "text",
    "rateExpirationTime": "2024-05-06T15:29:57.320Z",
    "providedAmountType": "text",
    "status": "text",
    "expirationTime": "2024-05-06T15:29:57.320Z",
    "notices": [
      {
        "text": "text",
        "link": "text",
        "type": "text"
      }
    ],
    "formattedEstimatedDelivery": "text"
  },
  "requirements": [
    {
      "type": "text",
      "usageInfo": "text",
      "fields": [
        {
          "name": "text",
          "group": [
            {
              "key": "text",
              "name": "text",
              "type": "text",
              "refreshRequirementsOnChange": false,
              "required": false,
              "valuesAllowed": [
                {
                  "key": "text",
                  "name": "text"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "estimatedDeliveryDate": "text",
  "issues": [
    {
      "type": "text",
      "state": "text",
      "description": "text"
    }
  ]
}

Get the Updated Delivery Time