The Wise connector lets your AI agent act in each user's Wise account. Each user connects their own Wise access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 32 tools.
- Tools
- 32
- What they doRead · write · destructive
- 19 · 12 · 119 read12 write1 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Wise connection
In AgentKit > Connections, create a Wise connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'wise'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Wise:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'wise_get_exchange_rates',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "wise"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Wise:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="wise_get_exchange_rates",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Wise credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolwise_compare_pricesCompare Wise's price and delivery speed against other money transfer providers for one currency route.Read-onlyCompare Transfer Prices
Compare Wise's price and delivery speed against other money transfer providers for one currency route. Returns the route details and a list of providers with their quotes, fees, exchange rates and delivery estimates. Provide either send_amount or recipient_gets_amount, not both. Use wise_create_quote for an actionable Wise quote.
Inputs
source_currencystringrequired- Three-letter ISO 4217 code of the currency being sent. Example: GBP.
target_currencystringrequired- Three-letter ISO 4217 code of the currency being received. Example: EUR.
filterstring- Set to POPULAR to return only the most popular competing providers. Example: POPULAR.one of
POPULAR number_of_providersinteger- How many popular providers to return when filter is POPULAR. Wise defaults to 4. Example: 4.
recipient_gets_amountnumber- Amount the recipient should receive in the target currency. Provide this or send_amount, never both. Example: 1000.
send_amountnumber- Amount to send in the source currency. Provide this or recipient_gets_amount, never both. Example: 1000.
source_countrystring- ISO 3166-1 alpha-2 country code to filter providers by sending country. Example: GB.
target_countrystring- ISO 3166-1 alpha-2 country code to filter providers by receiving country. Example: DE.
wise_get_balanceGet one balance account of a Wise profile by its id.Read-onlyGet Balance
Get one balance account of a Wise profile by its id. Returns the balance's id, currency, type, name and amounts (total, reserved, cash and total worth). Use wise_list_balances to find balance ids first.
Inputs
balance_idintegerrequired- Numeric ID of the balance account. Call wise_list_balances to find it. Example: 45678901.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
wise_get_balance_statementGet the statement of a balance account over a time interval in JSON format.Read-onlyGet Balance Statement
Get the statement of a balance account over a time interval in JSON format. Returns account holder details, the list of transactions with amounts, fees and running balances, and the end-of-statement balance. The interval cannot exceed 469 days. Accounts registered outside the US, Australia, New Zealand, Singapore, Canada and Malaysia need Strong Customer Authentication, which personal API tokens cannot complete, so this call can fail with 403 for them.
Inputs
balance_idintegerrequired- Numeric ID of the balance to get the statement for. Call wise_list_balances to find it. Example: 45678901.
currencystringrequired- Three-letter ISO 4217 currency code of the balance being queried. Example: GBP.
interval_endstringrequired- Statement end time in UTC, ISO 8601. Must be within 469 days of the start. Example: 2026-09-30T23:59:59.999Z.
interval_startstringrequired- Statement start time in UTC, ISO 8601. Example: 2026-09-01T00:00:00.000Z.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
typestring- Statement layout. COMPACT gives one line per transaction; FLAT gives accounting-style lines with fees on a separate line. Example: COMPACT.one of
COMPACTFLAT
wise_get_batch_groupGet a Wise batch group by its id.Read-onlyGet Batch Group
Get a Wise batch group by its id. Returns the batch group's version, name, source currency, status, transfer ids and pay-in details. Use before wise_update_batch_group to read the current version number.
Inputs
batch_group_idstringrequired- ID of the batch group. Example: 54a6bc09-cd83-4a2c-a2b1-1c9d3d3b2d1a.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
wise_get_exchange_ratesGet current or historical Wise mid-market exchange rates, for one currency pair or for every currency.Read-onlyGet Exchange Rates
Get current or historical Wise mid-market exchange rates, for one currency pair or for every currency. Returns a list of rate entries with source, target, rate and time. Use wise_create_quote instead when you need the rate and fees for an actual transfer.
Inputs
from_timestring- Start of a rate history period, a timestamp or a date. Use with to and group. Example: 2026-03-01.
groupstring- Interval for rate history grouping: day, hour or minute. Example: day.one of
dayhourminute sourcestring- Three-letter ISO 4217 code of the currency being sent. Leave empty together with target to get all rates. Example: EUR.
targetstring- Three-letter ISO 4217 code of the currency being received. Example: USD.
timestring- Timestamp for a single historical rate, ISO 8601 with optional offset. Example: 2026-03-13T14:53:01.
to_timestring- End of a rate history period, a timestamp or a date. Use with from and group. Example: 2026-03-13.
wise_get_profileGet the details of one Wise profile by its id.Read-onlyGet Profile
Get the details of one Wise profile by its id. Returns the profile type, name, address, contact details, state and, for business profiles, the business name and registration number. Use wise_list_profiles to discover profile ids first.
Inputs
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
wise_get_quoteGet a Wise quote by its id.Read-onlyGet Quote
Get a Wise quote by its id. Returns the quote's rate, expiry, status, fees and paymentOptions. Expired quotes remain readable for about 48 hours. Use wise_create_quote to make a new quote.
Inputs
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
quote_idstringrequired- ID of the quote (GUID). Example: 11144c35-9fe8-4c32-b7fd-d05c2a7734bf.
wise_get_recipientGet one Wise recipient account by its id.Read-onlyGet Recipient
Get one Wise recipient account by its id. Returns the recipient's name, currency, country, account type, active flag and bank details. Use wise_list_recipients to find recipient ids.
Inputs
account_idintegerrequired- Numeric ID of the recipient account. Example: 40000000.
wise_get_recipient_requirementsGet the fields Wise requires to create a recipient account for the currency route of a quote.Read-onlyGet Recipient Requirements
Get the fields Wise requires to create a recipient account for the currency route of a quote. Returns a list of recipient account types, each with its title and the fields (key, type, validation, allowed values) to fill in. Use before wise_create_recipient, and pass the matching type and field values into it.
Inputs
quote_idstringrequired- ID of the quote whose currency route defines the requirements. Example: 11144c35-9fe8-4c32-b7fd-d05c2a7734bf.
address_requiredboolean- Set to true to always include the recipient address as required, even if the route does not need it. Example: true.
wise_get_total_fundsGet the combined value of all balances of a Wise profile, converted into one currency.Read-onlyGet Total Funds
Get the combined value of all balances of a Wise profile, converted into one currency. Returns total worth, total available (including overdraft), total cash and overdraft usage and limit. Use wise_list_balances to see each balance separately.
Inputs
currencystringrequired- Three-letter ISO 4217 currency code that all balances are converted into. Example: GBP.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
wise_get_transferGet one Wise transfer by its id.Read-onlyGet Transfer
Get one Wise transfer by its id. Returns the transfer's status, reference, rate, source and target amounts, recipient, quote and whether it has active issues. Use to track progress after wise_fund_transfer.
Inputs
transfer_idintegerrequired- Numeric ID of the transfer. Example: 16521632.
wise_list_activitiesList the activity feed of a Wise profile, such as transfers, card payments and balance movements.Read-onlyList Activities
List the activity feed of a Wise profile, such as transfers, card payments and balance movements. Returns a page of activities and a cursor to request the next page. Use wise_list_transfers when only transfers are needed.
Inputs
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
monetary_resource_typestring- Only return activities of this resource type. Example: TRANSFER.
next_cursorstring- Pagination cursor taken from the previous response, to fetch the next page. Example: eyJwYWdlIjoyfQ.
sincestring- Only return activities after this ISO 8601 timestamp. Example: 2026-09-01T00:00:00.000Z.
sizeinteger- Number of activities per page, from 1 to 100. The Wise default is 10. Example: 25.
statusstring- Only return activities with this status. Example: COMPLETED.
untilstring- Only return activities up to this ISO 8601 timestamp. Example: 2026-09-30T23:59:59.999Z.
wise_list_balancesList the multi-currency balance accounts of a Wise profile, filtered by balance type.Read-onlyList Balances
List the multi-currency balance accounts of a Wise profile, filtered by balance type. Returns each balance's id, currency, type, name and amounts (total, reserved, cash and total worth). Use wise_get_balance for a single balance by id. Use wise_get_total_funds for one combined total in a single currency.
Inputs
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
typesstringrequired- Comma-separated balance types to return. Allowed values are STANDARD (regular currency balances) and SAVINGS (jars). At least one type is required. Example: STANDARD,SAVINGS.
wise_list_currenciesList every currency Wise supports for creating transfers.Read-onlyList Currencies
List every currency Wise supports for creating transfers. Returns each currency's code, symbol, name, search keywords and whether it supports decimals. Use before wise_create_quote to check that a currency is supported.
Inputs
This tool takes no inputs.
wise_list_profilesList all Wise profiles (personal and business) that belong to the authenticated user.Read-onlyList Profiles
List all Wise profiles (personal and business) that belong to the authenticated user. Returns each profile's id, type (PERSONAL or BUSINESS), name, email, address and current state. Use this first to find the profile id that most other Wise tools need. Use wise_get_profile for one profile's full details.
Inputs
This tool takes no inputs.
wise_list_recipientsList recipient accounts of a Wise profile, optionally filtered by currency, type or active state.Read-onlyList Recipients
List recipient accounts of a Wise profile, optionally filtered by currency, type or active state. Returns a page of recipients and a seek position for the next page. Use wise_get_recipient for one recipient by id.
Inputs
activeboolean- Whether to return active recipients. Wise defaults to true. Example: true.
currencystring- Only return recipients for these target currencies, comma-separated. Example: USD,GBP.
owned_by_customerboolean- Only return recipients that are (true) or are not (false) owned by the customer. Leave empty for all. Example: false.
profile_idinteger- ID of the Wise profile whose recipients to list. Defaults to the personal profile. Example: 14575282.
seek_positioninteger- Pagination position taken from seekPositionForNext in the previous response. Example: 1234567.
sizeinteger- Number of recipients per page, up to 20. Example: 20.
sortstring- Sort order as field,direction where field is id or currency and direction is asc or desc. Example: id,desc.
typestring- Only return recipients of these account types, comma-separated. Example: iban,sort_code.
wise_list_transfer_paymentsList the completed payments that funded a Wise transfer.Read-onlyList Transfer Payments
List the completed payments that funded a Wise transfer. Returns each payment's id, method, amount, currency and timestamps. Use wise_get_transfer for the transfer itself.
Inputs
transfer_idintegerrequired- Numeric ID of the transfer. Example: 16521632.
wise_list_transfersList transfers of a Wise profile, filtered by status, currency or creation date.Read-onlyList Transfers
List transfers of a Wise profile, filtered by status, currency or creation date. Returns each transfer's id, status, reference, rate, source and target amounts and creation time. Use wise_get_transfer for one transfer by id.
Inputs
created_date_endstring- Only return transfers created on or before this date. Example: 2026-09-30.
created_date_startstring- Only return transfers created on or after this date. Example: 2026-09-01.
limitinteger- Maximum number of transfers to return. Example: 50.
offsetinteger- Number of transfers to skip, for paging. Example: 0.
profile_idinteger- ID of the Wise profile whose transfers to list. Defaults to the personal profile. Example: 14575282.
source_currencystring- Only return transfers sent in this ISO 4217 currency. Example: GBP.
statusstring- Only return transfers in these statuses, comma-separated, such as incoming_payment_waiting, processing, funds_converted, outgoing_payment_sent, cancelled or funds_refunded. Example: processing,outgoing_payment_sent.
target_currencystring- Only return transfers received in this ISO 4217 currency. Example: EUR.
wise_validate_transfer_requirementsCheck which extra details Wise requires before a transfer can be created for a quote and recipient.Read-onlyValidate Transfer Requirements
Check which extra details Wise requires before a transfer can be created for a quote and recipient. Returns the list of required and optional fields, such as reference, transfer purpose and source of funds, with allowed values. This only reads requirements and creates nothing. Call before wise_create_transfer, then pass the needed values into it.
Inputs
quote_uuidstringrequired- ID of the quote the transfer will use. Example: bd244a95-dcf8-4c31-aac8-bf5e2f3e54c0.
target_accountintegerrequired- ID of the recipient account. Example: 40000000.
customer_transaction_idstring- Unique ID you will use for the transfer. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
referencestring- Reference text the recipient sees on their bank statement. The maximum length depends on the currency route. Example: Invoice 4471.
source_of_fundsstring- Source of funds code. Required for some routes, such as large USD transfers. Example: verification.source.of.funds.other.
transfer_naturestring- Transfer nature code, for transfers to or from BRL. Example: MOVING_MONEY_BETWEEN_OWN_ACCOUNTS.
transfer_purposestring- Transfer purpose code. Required for some routes, such as THB; see wise_validate_transfer_requirements. Example: verification.transfers.purpose.pay.bills.
transfer_purpose_invoice_numberstring- Invoice number. Required for some routes, such as INR. Example: INV-2026-0042.
transfer_purpose_sub_transfer_purposestring- Sub-purpose code. Required for some routes, such as CNY. Example: verification.sub.transfers.purpose.pay.interpretation.service.
wise_cancel_transferCancel a Wise transfer that is still waiting for funds.WriteCancel Transfer
Cancel a Wise transfer that is still waiting for funds. Returns the transfer with its updated status. Only transfers in the incoming_payment_waiting state can be cancelled; others return 409 Conflict. Use wise_get_transfer first to check the status.
- Idempotent
Inputs
transfer_idintegerrequired- Numeric ID of the transfer to cancel. Example: 16521632.
wise_convert_between_balancesConvert money between two currency balances or move money between a balance and a savings jar in a Wise profile.WriteConvert or Move Between Balances
Convert money between two currency balances or move money between a balance and a savings jar in a Wise profile. Returns the balance movement with its id, state, source and target amounts, rate, fees and the resulting balances. For a cross-currency conversion first call wise_create_quote with pay_out set to BALANCE and pass its id as quote_id. For a same-currency move pass amount_value and amount_currency instead.
Inputs
idempotence_uuidstringrequired- Unique UUID that you generate for this request, used by Wise to avoid duplicate operations. Reuse the same value only when retrying a failed call. Example: 3f8a1c52-7d4e-4b9a-9c1e-5a2b7d6e8f90.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
amount_currencystring- Three-letter ISO 4217 currency code of the amount. Required together with amount_value. Example: GBP.
amount_valuenumber- Amount to move, as a decimal number. Required for same-currency moves; leave empty when quote_id is used. Example: 100.50.
quote_idstring- ID of a quote created with pay_out set to BALANCE. Required for cross-currency conversions; leave empty for same-currency moves. Example: 11144c35-9fe8-4c32-b7fd-d05c2a7734bf.
source_balance_idinteger- ID of the balance to take money from. Required when moving money between a balance and a jar. Example: 45678901.
target_balance_idinteger- ID of the balance to put money into. Required when moving money between a balance and a jar. Example: 45678902.
wise_create_balanceOpen a new balance account (a currency balance or a savings jar) in a Wise profile.WriteCreate Balance
Open a new balance account (a currency balance or a savings jar) in a Wise profile. Returns the new balance's id, currency, type, name and amounts. Use wise_list_balances first to check whether a STANDARD balance already exists for the currency, since only one is allowed per currency.
Inputs
currencystringrequired- Three-letter ISO 4217 currency code of the balance to open. Example: EUR.
idempotence_uuidstringrequired- Unique UUID that you generate for this request, used by Wise to avoid duplicate operations. Reuse the same value only when retrying a failed call. Example: 3f8a1c52-7d4e-4b9a-9c1e-5a2b7d6e8f90.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
typestringrequired- Type of balance to open. STANDARD is a regular currency balance (only one per currency per profile). SAVINGS is a savings jar (several allowed per currency). Example: STANDARD.one of
STANDARDSAVINGS namestring- Name of the balance. Required when type is SAVINGS; ignored for STANDARD. Example: Holiday fund.
wise_create_batch_groupCreate a Wise batch group that collects up to 1000 transfers to be funded together.WriteCreate Batch Group
Create a Wise batch group that collects up to 1000 transfers to be funded together. Returns the batch group's id, version, name, source currency, status and transfer ids. Add transfers with wise_create_batch_group_transfer, then close it with wise_update_batch_group and fund it with wise_fund_batch_group.
Inputs
namestringrequired- Descriptive name for the batch, up to 100 characters. Example: October supplier payouts.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
source_currencystringrequired- Three-letter ISO 4217 code of the currency used to fund the batch. Example: GBP.
wise_create_batch_group_transferCreate a transfer inside a Wise batch group from a quote and recipient.WriteCreate Batch Group Transfer
Create a transfer inside a Wise batch group from a quote and recipient. Returns the created transfer with its id, status, amounts and reference. Use wise_create_transfer for a standalone transfer. The batch must still be open.
Inputs
batch_group_idstringrequired- ID of the batch group to add the transfer to. Example: 54a6bc09-cd83-4a2c-a2b1-1c9d3d3b2d1a.
customer_transaction_idstringrequired- Unique ID you generate for this transfer, used to prevent duplicates. Reuse the same value only when retrying a failed call. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
quote_uuidstringrequired- ID of the quote to base the transfer on. A quote can be used for one transfer only. Example: bd244a95-dcf8-4c31-aac8-bf5e2f3e54c0.
target_accountintegerrequired- ID of the recipient account to pay. Example: 40000000.
referencestring- Reference text the recipient sees on their bank statement. The maximum length depends on the currency route. Example: Invoice 4471.
source_accountinteger- ID of the refund recipient account to return money to if the transfer fails. Usually not needed. Example: 40000001.
source_of_fundsstring- Source of funds code. Required for some routes, such as large USD transfers. Example: verification.source.of.funds.other.
transfer_purposestring- Transfer purpose code. Required for some routes, such as THB; see wise_validate_transfer_requirements. Example: verification.transfers.purpose.pay.bills.
transfer_purpose_sub_transfer_purposestring- Sub-purpose code. Required for some routes, such as CNY. Example: verification.sub.transfers.purpose.pay.interpretation.service.
wise_create_quoteCreate a Wise quote for sending money from a profile, fixing the exchange rate and fees for a short time.WriteCreate Quote
Create a Wise quote for sending money from a profile, fixing the exchange rate and fees for a short time. Returns the quote id, rate, expiry, fees and a paymentOptions list with the price of each pay-in and pay-out method. Provide either source_amount or target_amount, not both. Use the returned id with wise_create_transfer, or with wise_get_recipient_requirements to find the recipient fields needed.
Inputs
profile_idintegerrequired- Numeric ID of the sender's Wise profile (personal or business). Call wise_list_profiles to find it. Example: 14575282.
source_currencystringrequired- Three-letter ISO 4217 code of the currency being sent. Example: GBP.
target_currencystringrequired- Three-letter ISO 4217 code of the currency being received. Example: USD.
pay_instring- Funding method of the transfer. Set to BALANCE when you will fund the transfer from a Wise balance, otherwise fees on the quote will not match the transfer. Wise defaults to BANK_TRANSFER. Example: BALANCE.one of
BANK_TRANSFERBALANCE pay_outstring- Preferred payout method. Wise defaults to BANK_TRANSFER. Other values include BALANCE, SWIFT, SWIFT_OUR, ALIPAY and INTERAC. Use BALANCE for conversions between your own balances. Example: BANK_TRANSFER.
preferred_pay_instring- Preferred pay-in method to list first in the response, for example BANK_TRANSFER. Example: BANK_TRANSFER.
source_amountnumber- Amount to send in the source currency. Provide this or target_amount, never both. Example: 100.
target_accountinteger- ID of the recipient account, from wise_create_recipient or wise_list_recipients. Optional; it can be added later with wise_update_quote. Example: 12345.
target_amountnumber- Amount the recipient should receive in the target currency. Provide this or source_amount, never both. Example: 120.
transfer_naturestring- Transfer nature code, required for transfers to or from BRL so that IOF tax is calculated correctly. Accepted values are listed by wise_validate_transfer_requirements. Example: MOVING_MONEY_BETWEEN_OWN_ACCOUNTS.
wise_create_recipientCreate a Wise recipient account, the beneficiary of a transfer, from bank details.WriteCreate Recipient
Create a Wise recipient account, the beneficiary of a transfer, from bank details. Returns the recipient's id, name, currency, country, account type, active flag and a summary of its details. Call wise_get_recipient_requirements first to learn the account type and the fields required in details for the currency route.
Inputs
account_holder_namestringrequired- Full name of the recipient. Personal names need a first and last name; business names can be a single name. Example: John Doe.
currencystringrequired- Three-letter ISO 4217 code of the currency the recipient receives. Example: GBP.
detailsobjectrequired- Bank details for the route as an object, for example legalType (PRIVATE or BUSINESS), sortCode and accountNumber for GBP, or iban for EUR. The exact keys come from wise_get_recipient_requirements. Example: {"legalType": "PRIVATE", "sortCode": "040075", "accountNumber": "37778842"}.
typestringrequired- Recipient account type for the route, as listed by wise_get_recipient_requirements, such as sort_code, iban or email. Example: sort_code.
owned_by_customerboolean- Set to true when the recipient account belongs to the profile owner, for example a transfer to your own account abroad. Example: true.
profile_idinteger- ID of the Wise profile that owns the recipient. Pass the business profile ID when several users manage the business account. Defaults to the personal profile. Example: 30000000.
refundboolean- Set to true to create a refund recipient, the account Wise returns money to if a transfer fails. Example: false.
wise_create_transferCreate a Wise transfer to a recipient from a quote.WriteCreate Transfer
Create a Wise transfer to a recipient from a quote. The transfer starts as a draft and moves no money until it is funded. Returns the transfer's id, status, reference, rate, source and target amounts and customerTransactionId. Create the quote and recipient first, and check wise_validate_transfer_requirements for extra details. Fund it with wise_fund_transfer.
Inputs
customer_transaction_idstringrequired- Unique ID you generate for this transfer, used to prevent duplicates. Reuse the same value only when retrying a failed call. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
quote_uuidstringrequired- ID of the quote to base the transfer on. A quote can be used for one transfer only. Example: bd244a95-dcf8-4c31-aac8-bf5e2f3e54c0.
target_accountintegerrequired- ID of the recipient account to pay. Example: 40000000.
referencestring- Reference text the recipient sees on their bank statement. The maximum length depends on the currency route. Example: Invoice 4471.
source_accountinteger- ID of the refund recipient account to return money to if the transfer fails. Usually not needed. Example: 40000001.
source_of_fundsstring- Source of funds code. Required for some routes, such as large USD transfers. Example: verification.source.of.funds.other.
transfer_purposestring- Transfer purpose code. Required for some routes, such as THB; see wise_validate_transfer_requirements. Example: verification.transfers.purpose.pay.bills.
transfer_purpose_invoice_numberstring- Invoice number. Required for some routes, such as INR. Example: INV-2026-0042.
transfer_purpose_sub_transfer_purposestring- Sub-purpose code. Required for some routes, such as CNY. Example: verification.sub.transfers.purpose.pay.interpretation.service.
wise_fund_batch_groupFund every transfer in a completed Wise batch group from a multi-currency balance, paying them out immediately.WriteFund Batch Group From Balance
Fund every transfer in a completed Wise batch group from a multi-currency balance, paying them out immediately. Returns the batch group with its status, name, transfer ids and whether it was already paid. Complete the batch with wise_update_batch_group first and make sure the balance covers the whole batch. Profiles in the UK and EEA need Strong Customer Authentication, which personal API tokens cannot complete.
Inputs
batch_group_idstringrequired- ID of the completed batch group to fund. Example: 54a6bc09-cd83-4a2c-a2b1-1c9d3d3b2d1a.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
wise_fund_transferFund a Wise transfer from a multi-currency balance, which starts processing and moves the money.WriteFund Transfer From Balance
Fund a Wise transfer from a multi-currency balance, which starts processing and moves the money. Returns the payment result with its status, error code if any, and balance transaction id. Create the transfer with wise_create_transfer first. Profiles in the UK and EEA need Strong Customer Authentication, which personal API tokens cannot complete, so this can fail with 403 there.
Inputs
profile_idintegerrequired- Numeric ID of the profile that owns the transfer and balance. Call wise_list_profiles to find it. Example: 14575282.
transfer_idintegerrequired- Numeric ID of the transfer to fund. Example: 16521632.
balance_idinteger- ID of the balance to debit. If empty Wise uses the profile's balance in the transfer's source currency. Example: 45678901.
wise_update_batch_groupClose a Wise batch group so it can be funded, or cancel it together with all its transfers.WriteComplete or Cancel Batch Group
Close a Wise batch group so it can be funded, or cancel it together with all its transfers. Returns the batch group with its new status, version and pay-in details. Cancelling is final and only allowed before funding. Read the current version with wise_get_batch_group first; the call is rejected if the version is stale.
Inputs
batch_group_idstringrequired- ID of the batch group to update. Example: 54a6bc09-cd83-4a2c-a2b1-1c9d3d3b2d1a.
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
statusstringrequired- New status. COMPLETED closes the group for changes and allows funding. CANCELLED cancels the group and every transfer in it, and cannot be undone. Example: COMPLETED.one of
COMPLETEDCANCELLED versionintegerrequired- Current version of the batch group, from wise_get_batch_group, used to prevent conflicting updates. Example: 1234.
wise_update_quoteUpdate a Wise quote, usually to attach the recipient account so the final price and payout method are known.WriteUpdate Quote
Update a Wise quote, usually to attach the recipient account so the final price and payout method are known. Returns the updated quote with its payOut method, rate, expiry and paymentOptions. Use after wise_create_quote when the recipient was not known at creation. Pricing can change, so re-check the fees before creating the transfer.
Inputs
profile_idintegerrequired- Numeric ID of the Wise profile (personal or business) to act on. Call wise_list_profiles to find it. Example: 14575282.
quote_idstringrequired- ID of the quote to update (GUID). Example: 11144c35-9fe8-4c32-b7fd-d05c2a7734bf.
pay_outstring- Preferred payout method, such as BANK_TRANSFER, BALANCE, SWIFT, SWIFT_OUR, ALIPAY or INTERAC. Example: SWIFT_OUR.
target_accountinteger- ID of the recipient account to attach to the quote. Example: 12345.
transfer_naturestring- Transfer nature code, required for transfers to or from BRL. Example: MOVING_MONEY_BETWEEN_OWN_ACCOUNTS.
wise_deactivate_recipientDeactivate a Wise recipient account so it can no longer receive transfers.DestructiveDeactivate Recipient
Deactivate a Wise recipient account so it can no longer receive transfers. Returns the recipient with its active flag set to false. A deactivated recipient cannot be reactivated, but a new one can be created with the same details. Use wise_get_recipient first to confirm the right account.
- Idempotent
Inputs
account_idintegerrequired- Numeric ID of the recipient account to deactivate. Example: 40000000.
No tools match.
