# Wise

> Read Wise profiles, balances, transfers, exchange rates and statements, and manage balance accounts.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/wise

## Actions

### Cancel transfer

Cancel a transfer that is still waiting for its incoming payment. A transfer held for compliance reasons, or already converted, can't be cancelled.

**Inputs**

- Transfer id (`transfer_id`, number, required): The transfer ID

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "business": 1,
    "created": "example",
    "customerTransactionId": "example",
    "details": {
      "reference": "example"
    },
    "hasActiveIssues": false,
    "id": 1,
    "payinSessionId": "example",
    "quote": 1,
    "quoteUuid": "example",
    "rate": 1.0,
    "reference": "example",
    "sourceAccount": 1,
    "sourceCurrency": "example",
    "sourceValue": 1.0,
    "status": "example",
    "targetAccount": 1,
    "targetCurrency": "example",
    "targetValue": 1.0,
    "transferRequest": 1,
    "user": 1
  }
}
```

### Close balance

Close a balance account. The balance must be zero, and its bank account details are switched off and may not be restored.

**Inputs**

- Profile (`profile_id`, number, required): The profile ID.
- Balance (`balance_id`, number, required): The balance ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Compare rates

Compare the price and speed of money transfer providers for a currency route. Give either the amount sent or the amount the recipient gets, not both.

**Inputs**

- Source currency (`source_currency`, text, required): ISO 4217 source currency code
- Target currency (`target_currency`, text, required): ISO 4217 target currency code
- Send amount (`send_amount`, number): Amount to send in source currency. Must provide either sendAmount or recipientGetsAmount.
- Recipient gets amount (`recipient_gets_amount`, number): Amount to be received in target currency. Must provide either sendAmount or recipientGetsAmount.
- Mid market rate (`mid_market_rate`, number): Current mid-market rate between the source and target currency
- Wise fee (`wise_fee`, number): Wise's fee, if the Wise quote is known
- Wise estimated delivery (`wise_estimated_delivery`, text): Wise's estimated delivery timestamp, if the Wise quote is known
- Wise quote created time (`wise_quote_created_time`, text): Timestamp when the Wise quote was created
- Pay in method (`pay_in_method`, text): Change the pay-in method of the Wise quote only (all other quotes will remain as bank transfer)
- Source country (`source_country`, text): Filter by source country (ISO 3166-1 Alpha-2 code)
- Target country (`target_country`, text): Filter by target country (ISO 3166-1 Alpha-2 code)
- Provider country (`provider_country`, text): Filter by provider country (ISO 3166-1 Alpha-2 code)
- Filter (`filter`, text): Filter by most popular competitors. One of: `POPULAR`.
- Number of providers (`number_of_providers`, number): Number of popular competitors to return if filter is set to POPULAR - default value is 4
- Provider types (`provider_types`, list): Filter by provider type. One or more of: `bank`, `moneytransferprovider`, `travelMoney`.
- Providers (`providers`, text): Filter by specific provider aliases
- Exclude partners (`exclude_partners`, true/false): Exclude Wise's partner banks - default true
- Include wise (`include_wise`, true/false): Overrides filters to ensure Wise data is returned, even if exclusionary filters are applied

**Outputs**

- `data` (object): V4 comparison response containing price and speed estimates from various money transfer providers.

**Example output**

```json
{
  "data": {
    "amount": 1.0,
    "amountType": "example",
    "providerCountry": "example",
    "providerTypes": [],
    "providers": [],
    "sourceCountry": "example",
    "sourceCurrency": "example",
    "targetCountry": "example",
    "targetCurrency": "example"
  }
}
```

### Create balance

Open a balance in a profile, in the currency and type you choose. You can have only one standard balance per currency but several savings balances, and a savings balance needs a name.

**Inputs**

- Profile (`profile_id`, number, required): The profile ID.
- Currency (`currency`, text, required): Currency code (ISO 4217 Alphabetic Code).
- Type (`type`, text, required): Type of balance account. - STANDARD - Standard balance account. Only one per currency per profile. - SAVINGS - Savings balance (Jar). Multiple allowed per currency. One of: `STANDARD`, `SAVINGS`.
- Name (`name`, text): Name of the balance. Required for SAVINGS type balances.
- Request id (`request_id`, text): Optional UUID for safe manual retries. Leave empty to create one automatically.

**Outputs**

- `data` (object): Represents a balance account within a profile.

**Example output**

```json
{
  "data": {
    "amount": {
      "currency": "example",
      "value": 1.0
    },
    "cashAmount": {
      "currency": "example",
      "value": 1.0
    },
    "creationTime": "example",
    "currency": "example",
    "icon": {
      "type": "EMOJI",
      "value": "example"
    },
    "id": 1,
    "investmentState": "NOT_INVESTED",
    "modificationTime": "example",
    "name": "example",
    "reservedAmount": {
      "currency": "example",
      "value": 1.0
    },
    "totalWorth": {
      "currency": "example",
      "value": 1.0
    },
    "type": "STANDARD",
    "visible": false
  }
}
```

### Get address

Get one address by its ID.

**Inputs**

- Address id (`address_id`, number, required): The unique identifier of the address.

**Outputs**

- `data` (object): Represents a physical address associated with a profile.

**Example output**

```json
{
  "data": {
    "details": {
      "city": "example",
      "country": "example",
      "firstLine": "example",
      "occupations": [],
      "postCode": "example",
      "state": "example"
    },
    "id": 1,
    "profile": 1
  }
}
```

### Get address requirements

Get the fields needed to create a valid address, such as country, city, post code and first line. Some fields add further required fields once filled in.

**Inputs**: None.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### Get balance

Get one balance by its ID.

**Inputs**

- Profile (`profile_id`, number, required): The profile ID.
- Balance (`balance_id`, number, required): The balance ID.

**Outputs**

- `data` (object): Represents a balance account within a profile.

**Example output**

```json
{
  "data": {
    "amount": {
      "currency": "example",
      "value": 1.0
    },
    "cashAmount": {
      "currency": "example",
      "value": 1.0
    },
    "creationTime": "example",
    "currency": "example",
    "icon": {
      "type": "EMOJI",
      "value": "example"
    },
    "id": 1,
    "investmentState": "NOT_INVESTED",
    "modificationTime": "example",
    "name": "example",
    "reservedAmount": {
      "currency": "example",
      "value": 1.0
    },
    "totalWorth": {
      "currency": "example",
      "value": 1.0
    },
    "type": "STANDARD",
    "visible": false
  }
}
```

### Get balance capacity

Get how much a profile can hold, based on its country's rules. Useful before adding money for profiles in countries with hold limits, such as Singapore or Malaysia.

**Inputs**

- Profile (`profile_id`, number, required): The profile ID.
- Currency (`currency`, text, required): Currency code (ISO 4217 Alphabetic Code). The deposit limit will be returned in this currency.

**Outputs**

- `data` (object): Deposit limit information for a profile.

**Example output**

```json
{
  "data": {
    "depositLimit": {
      "amount": 1.0,
      "currency": "example"
    },
    "hasLimit": false
  }
}
```

### Get balance statement

Get a statement for a balance account, in the format the request asks for (JSON, CSV, PDF, Excel, CAMT.053 XML, MT940 or QIF). The period can be at most 469 days. For profiles registered outside the US, Australia, New Zealand, Singapore, Canada and Malaysia, Wise asks for Strong Customer Authentication once every 90 days.

**Inputs**

- Profile (`profile_id`, number, required): The profile ID.
- Balance (`balance_id`, number, required): The balance ID to get the statement for.
- Currency (`currency`, text, required): Currency of the balance statement requested (ISO 4217 Alphabetic Code).
- Interval start (`interval_start`, date and time, required): Statement start time in UTC.
- Interval end (`interval_end`, date and time, required): Statement end time in UTC.
- Type (`type`, text): Statement type: - COMPACT - Single statement line per transaction - FLAT - Accounting statements where transaction fees are on a separate line. One of: `COMPACT`, `FLAT`.
- Statement locale (`statement_locale`, text): Language for the statement. Supports 2 character language codes.

**Outputs**

- `data` (object): Balance statement containing transactional activities.

**Example output**

```json
{
  "data": {
    "accountHolder": {
      "address": {
        "addressFirstLine": "example",
        "city": "example",
        "countryName": "example",
        "postCode": "example",
        "stateCode": "example"
      },
      "firstName": "example",
      "lastName": "example",
      "type": "PERSONAL"
    },
    "bankDetails": {},
    "endOfStatementBalance": {
      "currency": "example",
      "value": 1.0
    },
    "issuer": {
      "city": "example",
      "country": "example",
      "firstLine": "example",
      "name": "example",
      "postCode": "example",
      "stateCode": "example"
    },
    "query": {
      "accountId": 1,
      "currency": "example",
      "intervalEnd": "example",
      "intervalStart": "example"
    },
    "transactions": []
  }
}
```

### Get batch group

Get a batch group by its ID.

**Inputs**

- Profile (`profile_id`, number, required): The ID of the profile that the batch group is associated with.
- Batch group id (`batch_group_id`, text, required): The batch group ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "id": "example",
    "name": "example",
    "payInDetails": [],
    "payinSessionId": "example",
    "sourceCurrency": "example",
    "status": "NEW",
    "transferIds": [],
    "version": 1
  }
}
```

### Get current user

Get the details of the Wise user this connection belongs to.

**Inputs**: None.

**Outputs**

- `data` (object): Represents a Wise user account.

**Example output**

```json
{
  "data": {
    "active": false,
    "details": {
      "address": {
        "city": "example",
        "countryCode": "example",
        "firstLine": "example",
        "occupation": "example",
        "postCode": "example",
        "state": "example"
      },
      "avatar": "example",
      "dateOfBirth": "example",
      "firstName": "example",
      "lastName": "example",
      "occupation": "example",
      "phoneNumber": "example",
      "primaryAddress": 1
    },
    "email": "example",
    "id": 1,
    "name": "example"
  }
}
```

### Get exchange rates

Get the latest exchange rates for every currency or one currency pair, the rate at a past moment, or a pair's rate history over a period by day, hour or minute.

**Inputs**

- Source (`source`, text): Source (send) currency code.
- Target (`target`, text): Target (receive) currency code.
- Time (`time`, date and time): Timestamp to get historic exchange rate. Supports only Timestamp (combined date and time). Timezone offset is supported but optional. Supported examples: 2019-03-13T14:53:01 or 2019-03-13T14:53:01+0100.
- From (`from_value`, date and time): Period start date/time to get exchange rate history. Supports Timestamp (combined date and time) or Date (date only). Supported examples: 2019-03-13T14:53:01 or 2019-03-13.
- To (`to`, date and time): Period end date/time to get exchange rate history. Supports Timestamp (combined date and time) or Date (date only). Timezone offset is supported but optional. Supported examples: 2019-03-13T14:53:01+0100 or 2019-03-13+0100.
- Group (`group`, text): Interval for history grouping. One of: `day`, `hour`, `minute`.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### Get hold limit breaches

List the times a profile's balance went over its country's hold limit, such as in Singapore or Malaysia. You can filter by state and closing reason.

**Inputs**

- Profile (`profile_id`, number, required): The profile ID.
- State (`state`, text): Filter by breach state. One of OPEN, CLOSED
- Closing reason (`closing_reason`, text): Filter by closing reason. One of AUTOMATICALLY_RESOLVED, MANUALLY_RESOLVED

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### Get profile

Get one profile by its ID.

**Inputs**

- Profile (`profile_id`, number, required): Profile ID.

**Outputs**

- `data` (object): A profile represents an identity that can send and receive money through Wise. There are two types: **Personal** (an individual) and **Business** (a company). The fields returned vary depending on the profile type.

**Example output**

```json
{
  "data": {
    "address": {
      "addressFirstLine": "example",
      "city": "example",
      "countryIso2Code": "example",
      "countryIso3Code": "example",
      "id": 1,
      "postCode": "example",
      "stateCode": "example"
    },
    "avatar": "example",
    "contactDetails": {
      "email": "example",
      "phoneNumber": "example"
    },
    "createdAt": "example",
    "currentState": "HIDDEN",
    "dateOfBirth": "example",
    "email": "example",
    "firstName": "example",
    "fullName": "example",
    "id": 1,
    "lastName": "example",
    "phoneNumber": "example",
    "preferredName": "example",
    "publicId": "example",
    "secondaryAddresses": [],
    "type": "PERSONAL",
    "updatedAt": "example",
    "userId": 1
  }
}
```

### Get total funds

Get an overview of your account's value across all balances: total worth, total available (including overdraft), total cash, and overdraft details.

**Inputs**

- Profile (`profile_id`, number, required): The profile ID.
- Currency (`currency`, text, required): Currency code (ISO 4217 Alphabetic Code). All values will be converted to this currency.

**Outputs**

- `data` (object): Total funds overview for a profile.

**Example output**

```json
{
  "data": {
    "overdraft": {
      "available": {
        "currency": "example",
        "value": 1.0
      },
      "availableByCurrency": [],
      "limit": {
        "currency": "example",
        "value": 1.0
      },
      "used": {
        "currency": "example",
        "value": 1.0
      }
    },
    "totalAvailable": {
      "currency": "example",
      "value": 1.0
    },
    "totalCash": {
      "currency": "example",
      "value": 1.0
    },
    "totalWorth": {
      "currency": "example",
      "value": 1.0
    }
  }
}
```

### Get transfer

Get one transfer by its ID.

**Inputs**

- Transfer id (`transfer_id`, number, required): The transfer ID

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "business": 1,
    "created": "example",
    "customerTransactionId": "example",
    "details": {
      "reference": "example"
    },
    "hasActiveIssues": false,
    "id": 1,
    "payinSessionId": "example",
    "quote": 1,
    "quoteUuid": "example",
    "rate": 1.0,
    "reference": "example",
    "sourceAccount": 1,
    "sourceCurrency": "example",
    "sourceValue": 1.0,
    "status": "example",
    "targetAccount": 1,
    "targetCurrency": "example",
    "targetValue": 1.0,
    "transferRequest": 1,
    "user": 1
  }
}
```

### Get user

Get a user's details by their ID.

**Inputs**

- User id (`wise_user_id`, number, required): The user ID.

**Outputs**

- `data` (object): Represents a Wise user account.

**Example output**

```json
{
  "data": {
    "active": false,
    "details": {
      "address": {
        "city": "example",
        "countryCode": "example",
        "firstLine": "example",
        "occupation": "example",
        "postCode": "example",
        "state": "example"
      },
      "avatar": "example",
      "dateOfBirth": "example",
      "firstName": "example",
      "lastName": "example",
      "occupation": "example",
      "phoneNumber": "example",
      "primaryAddress": 1
    },
    "email": "example",
    "id": 1,
    "name": "example"
  }
}
```

### List account detail orders

List the requests to assign bank account details to a profile, whether pending or done.

**Inputs**

- Profile (`profile_id`, number, required): The ID of the profile to list bank account detail orders for.
- Currency (`currency`, text, required): Currency code (ISO 4217 Alphabetic Code).

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List activities

List a profile's activities, a record of actions taken, with filters to narrow them down.

**Inputs**

- Profile (`profile_id`, number, required): The unique identifier of the profile.
- Monetary resource type (`monetary_resource_type`, text): Type of Activity Monetary Resource. One of: `ACCRUAL_CHARGE` (Accrual charge), `ACQUIRING_PAYMENT` (Acquiring payment), `ASSETS_WITHDRAWAL` (Assets withdrawal), `BALANCE_CASHBACK` (Balance cashback), `BALANCE_INTEREST` (Balance interest), `BALANCE_TRANSACTION` (Balance transaction), `BANK_DETAILS_ORDER` (Bank details order), `BATCH_TRANSFER` (Batch transfer), `CARD_CASHBACK` (Card cashback), `CARD_ORDER` (Card order), and 13 more.
- Status (`status`, text): Status of the Activity. - REQUIRES_ATTENTION - Requires an end user attention. - IN_PROGRESS - Indicates that this activity has yet to be completed. (Example: In progress Top Up) - UPCOMING - Indicates that this activity is scheduled to happen in the future. By default these activities will only be shown 2 days before the date. (Example: A scheduled transfer) - COMPLETED - Indicates that this activity is at its end state. (Example: A completed Top Up) - CANCELLED - Indicates that this activity i. One of: `REQUIRES_ATTENTION` (Requires attention), `IN_PROGRESS` (In progress), `UPCOMING`, `COMPLETED`, `CANCELLED`.
- Since (`since`, date and time): Filter activity list after a certain timestamp. Use ISO 8601 format.
- Until (`until`, date and time): Filter activity list until a certain timestamp. Use ISO 8601 format.
- Next cursor (`next_cursor`, text): Pagination cursor returned from a previous response. Use the cursor value from the response to fetch the next page of activities.
- Size (`size`, number): Desired size of query. Min 1, max 100, and default value is 10 if not specified. From 1 to 100. Default: `10`.

**Outputs**

- `data` (object): Response containing a list of activities for a profile.

**Example output**

```json
{
  "data": {
    "activities": [],
    "cursor": "example"
  }
}
```

### List addresses

List the addresses on the user's profile.

**Inputs**

- Profile (`profile`, number): The profile ID to list addresses for.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List balances

List a profile's balance accounts of the types you choose. Choose at least one type.

**Inputs**

- Profile (`profile_id`, number, required): The profile ID.
- Types (`types`, list, required): Balance types to include. One or more of: `STANDARD`, `SAVINGS`.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List currencies

List the currencies you can send transfers in, with their names in English.

**Inputs**: None.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List profiles

List all of the user's profiles, personal and business.

**Inputs**: None.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List transfer payments

List the completed payments that funded a transfer. There is usually just one.

**Inputs**

- Transfer id (`transfer_id`, number, required): The transfer ID

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List transfers

List a profile's transfers, by default for the personal profile. You can filter by time period and payment status, such as failed payments since last week.

**Inputs**

- Profile (`profile`, number): User profile ID. If parameter is omitted, defaults to user's personal profile
- Status (`status`, text): Comma separated list of one or more status codes to filter transfers. See Transfer statuses for complete list of statuses.
- Source currency (`source_currency`, text): Source currency code
- Target currency (`target_currency`, text): Target currency code
- Created date start (`created_date_start`, date and time): Starting date to filter transfers, inclusive of the provided date
- Created date end (`created_date_end`, date and time): Ending date to filter transfers, inclusive of the provided date
- Limit (`limit`, number): Maximum number of records to be returned in response
- Offset (`offset`, number): Starting record number

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```
