Wise
Wise lets you send, spend, and receive money internationally.
От сообщества: Добавлен пользователем или импортирован; проверьте владельца перед подключениемРаботаетНужен API-ключГлобальныйБесплатноМожет изменять данные
Что умеет
- Spend.Profiles.3dsecure.Challenge Result.Create: Once the customer has accepted or rejected the push notification for a 3DS challenge, you can use this endpoint to notify us of the result. You must ca
- Profiles.Activities.List: List of activities belonging to user profile. Activities represent snapshots of performed actions and can be filtered by various parameters to narrow down the results.
- Profiles.Additional Verification.Upload Evidences.Create V3: Uploads verification evidence for a specific profile. The request body varies significantly between **Personal** and **Business** profiles.
Какие данные видит
Нужен ли аккаунт
Нужен API-ключ из настроек сервиса
Wise lets you send, spend, and receive money internationally.
Список инструментов сервера (60)
Технические названия из tools/list. Нужны только разработчикам.
| spend.profiles.3dsecure.challenge_result.create | Once the customer has accepted or rejected the push notification for a 3DS challenge, you can use this endpoint to notify us of the result. You must call this endpoint before the expiration time, otherwise it will return a 400 error. You can find the expiration information from the [3DS challenge webhook event](/guides/developer/webhooks/event-types#3ds-challenge). Only the first call to this endpoint will be processed. Any subsequent duplicate requests will be ignored, although you will still receive a success response. {% admonition type="warning" %} This endpoint is SCA protected when it applies. If your profile is registered within the UK and/or EEA, SCA most likely applies to you. For more information, please read [implementing SCA](/guides/developer/auth-and-security/sca-and-2fa). {% /admonition %} |
| profiles.activities.list | List of activities belonging to user profile. Activities represent snapshots of performed actions and can be filtered by various parameters to narrow down the results. |
| profiles.additional_verification.upload_evidences.create_v3 | Uploads verification evidence for a specific profile. The request body varies significantly between **Personal** and **Business** profiles. |
| profiles.additional_verification.upload_evidences.create_v5 | Uploads verification evidence for a specific profile. The request body varies significantly between **Personal** and **Business** profiles. Submitting an evidence that was already uploaded will result in an attempt to update the evidence. |
| profiles.verification_status.upload_document.create | Uploads verification documents for review. You can upload multiple files at once. A valid document must fulfil these requirements: - The document must be clear. - The document needs to be a .jpg, .png., or .pdf file type up to 10MB in size. |
| profiles.verification_status.required_evidences.list | Fetches the required evidences for a profile to complete additional customer verification. If one or more evidences are returned, the customer should submit those evidences using the upload-evidences endpoint. See the [Supported Evidences guide](/guides/product/kyc/partner-kyc/supported-evidences) for the list of possible evidence types and how to submit them. |
| addresses.list | List of addresses belonging to user profile. |
| addresses.create | Adds address info to user profile. List of required fields are different for different countries. Use the [address requirements endpoint](#operation/addressRequirementsGet) to dynamically discover required fields. For updating personal profiles, consider using [the personal profile update endpoint](/api-reference/profile/profilepersonalupdate) instead. It allows submitting the address information alongside other profile data. **State field** is required for US, CA, BR, and AU addresses. **Occupations** is required for CA, IN, JP, ID, IL, MX, and within the US for the state NM. |
| addresses.get | Get address info by ID. |
| address_requirements.list | Returns the list of fields required to create a valid address. Use this as a starting point to discover required fields. The response contains 4 required top-level fields: - `country` (select field with list of values) - `city` (text field) - `postCode` (text field) - `firstLine` (text field) If a field has `refreshRequirementsOnChange: true`, call the POST endpoint with that field's value to discover additional required fields. For a step-by-step walkthrough, see the [Address Requirements guide](/guides/developer/api-guides/address-requirements). |
| address_requirements.create | Returns the list of fields required to create a valid address, based on the provided context. Use this endpoint to dynamically discover additional required fields based on selected values. For example: - Posting `{"details": {"country": "US"}}` will add "state" to the list of fields. - Posting `{"details": {"country": "CA"}}` will add "occupations" to the list of fields. Continue calling this endpoint with field values until all fields with `refreshRequirementsOnChange: true` have been populated. For a step-by-step walkthrough, see the [Address Requirements guide](/guides/developer/api-guides/address-requirements). |
| profiles.balances.list | Retrieves the user's multi-currency account balance accounts. Returns all balance accounts the profile has in the types specified. The `types` parameter must include at least one type. To return more than one type, comma-separate the values. |
| profiles.balances.create | Opens a balance within the specified profile, in the currency and type specified in the request. For `STANDARD` balances, only one can be created per currency. For `SAVINGS` balances, multiple in the same currency can be opened. When creating a `SAVINGS` type balance, a `name` is required. |
| profiles.balances.get | Returns a balance based on the specified balance ID. |
| profiles.balances.delete | Closes a balance account for the user's profile. Balance accounts must have a zero balance to be closed. Bank account details for the balance will also be deactivated and may not be restored. |
| profiles.balance_movements.create | This endpoint allows conversion and movement of funds between balance accounts. **Convert across balance accounts:** Convert funds between two `STANDARD` balance accounts in different currencies. Requires a quote created with `"payOut": "BALANCE"`. **Move money between balances:** - Add money to a same-currency jar (move from `STANDARD` to `SAVINGS` without conversion) - Add money to another-currency jar (convert money using a quote) - Withdraw money from a jar (move from `SAVINGS` to `STANDARD` without conversion) Either `amount` or `quoteId` is required. Use `quoteId` for cross-currency movements. |
| profiles.balance_capacity.get | Returns the deposit limit for a profile based on regulatory requirements. Useful for personal profiles located in countries that have hold limits. We advise calling this API before depositing money into an account if the profile is located in Singapore or Malaysia. |
| profiles.excess_money_account.create | If a balance goes over the regulatory hold limit, excess funds are automatically moved to another account at the end of the day. Use this endpoint to specify a recipient where excess money will be transferred. Primarily used for Singapore and Malaysia customers. |
| profiles.total_funds.get | Provides an overview of your account's total valuation and available liquidity across all balances. Returns total worth, total available (including overdraft), total cash, and overdraft details. #### Example (Assuming GBP and USD has 1:1 exchange rate) | Scenario | GBP balance | USD balance | Total Worth | Total Available | Overdraft Usage | Overdraft Limit | | ---------------------------------------- | ----------- | ----------- | ----------- | --------------- | --------------- | --------------- | | Positive account value with no overdraft | 2000 | 0 | 2000 | 2000 | 0 | 0 | | Positive account value with overdraft | 2000 | -100 | 1900 | 2400 | 100 | 500 | | Negative account value with overdraft | 0 | -100 | -100 | 400 | 100 | 500 | |
| borderless_accounts.list | {% admonition type="warning" %} This endpoint is deprecated. Use the [v4 Balances endpoint](/api-reference/balance/balanceget) instead. {% /admonition %} Get available balances for all activated currencies in your multi-currency account. |
| borderless_accounts.conversions.create | {% admonition type="warning" %} This endpoint is deprecated. Use the [balance movements endpoint](/api-reference/balance/balancemovement) to move and convert between balances instead. {% /admonition %} Convert funds between your multi-currency account currencies. Quote which is used in this call must be created with `"payOut": "BALANCE"`. Note that this call needs an extra field in header called `X-idempotence-uuid`. |
| profiles.balances.hold_limit_breach.create_v1 | Returns a list of hold limit breaches for a profile. A hold limit breach occurs when a balance exceeds the regulatory hold limit for that profile's country (e.g. Singapore, Malaysia). You can optionally filter by `state` and `closing_reason`. |
| profiles.balances.hold_limit_breach.create_v1_2 | Closes an open hold limit breach by performing a one-time refund to a specified recipient. The recipient will receive the excess amount that caused the breach. Only breaches with `state: OPEN` can be closed via this endpoint. |
| profiles.balance_statements.statement_json.get | Retrieve a statement for the specified balance account. The response format depends on the URL path: - `statement.json` - JSON format - `statement.csv` - CSV format - `statement.pdf` - PDF format (includes Wise branding) - `statement.xlsx` - Excel format - `statement.xml` - CAMT.053 XML format - `statement.mt940` - MT940 format - `statement.qif` - QIF format The period between `intervalStart` and `intervalEnd` cannot exceed 469 days (around 1 year 3 months). {% admonition type="warning" %} This endpoint is SCA protected when it applies. If your profile is registered within the UK and/or EEA, SCA most likely applies to you. The additional authentication is only required once every 90 days, viewing the statement on the website or in the mobile app counts towards that as well. [Learn more](/guides/developer/auth-and-security/sca-and-2fa) {% /admonition %} |
| profiles.account_details_orders.list_v1 | Returns the bank account assignment requests for a profile and multi-currency account. {% admonition type="warning" %} This endpoint is deprecated. Please use the [v3 endpoint](/api-reference/bank-account-details/bankaccountdetailsorderslist) instead. {% /admonition %} |
| profiles.account_details_orders.create | Creates an order which will issue account details. It should use the same currency as the balance previously created. Fulfilling all the requirements will complete the order, reaching status `DONE`. The possible values for a requirement status are: - `PENDING_USER`: The requirement has some pending action from the user. - `PENDING_TW`: The requirement has some pending action from Wise. - `DONE`: The requirement is completed. The more common requirements are: - `VERIFICATION`: The user needs to be fully verified before completing this requirement. - `TOP_UP`: A fee will be charged and must be paid through wise.com before completing this requirement. |
| profiles.bank_details.create | Creates and assigns a pair of local account details and international account details (where available) that are linked to the target balance specified in the request. {% admonition type="warning" %} Please reach out to our Support Team for access to this endpoint. {% /admonition %} |
| profiles.account_details.list | Returns a list with all the `AVAILABLE` and `ACTIVE` account details for the given profile, including examples. Account receive options can also include local and international details to receive money on the currency balance. Example bank account details are returned for any currency where bank account details have not been requested and issued. Examples will always include an `id` of `null`. |
| profiles.account_details_orders.list_v3 | Returns the bank account assignment requests for a profile and multi-currency account. The response includes bank-details orders in the following statuses: `PENDING_USER`, `PENDING_TW`, `REQUIREMENTS_FULFILLED`, `DONE`. |
| profiles.account_details.payments.returns.create | Creates a return for a payment received to bank account details. When you create a return, you must provide the ID of the payment you wish to return as well as the ID of the profile that received the payment. In addition, you can provide a `reason` for the return in the request body. When returning SWIFT payments, `reason` is a required field. |
| profiles.batch_groups.create | Create a new batch group. A batch group can hold up to 1000 transfers that will be funded together. After creating the group, add transfers to it, then complete the group to receive pay-in details. |
| profiles.batch_groups.get | Get an existing batch group by ID. |
| profiles.batch_groups.update | Update a batch group's status to complete or cancel it. **Complete a batch group:** Set `status` to `COMPLETED` to close the group for modifications and allow funding to proceed. Once completed, `payInDetails` will be populated with funding instructions. **Cancel a batch group:** Set `status` to `CANCELLED` to cancel all transfers in the batch. Only batches that are not funded can be cancelled. Cancellation is final and cannot be undone. The `version` parameter is required for concurrency control. The operation will be rejected if the provided version does not match the server's current version. |
| profiles.batch_groups.transfers.create | Create a transfer in the batch group using a previously created recipient account and quote. For the request body format, see [transfer creation](/api-reference/transfer#create). For quote and recipient creation, see [quote creation](/api-reference/quote/quotecreate) and [recipient creation](/api-reference/recipient/recipientcreate). |
| profiles.batch_payments.payments.create | Funds all transfers in a batch group from a multi-currency account balance. Transfers are paid out immediately. The batch group must first be completed, and there must be enough funds in the account for the whole batch. Otherwise, an insufficient funds error will be returned. {% admonition type="warning" %} This endpoint is SCA protected when it applies. If your profile is registered within the UK and/or EEA, SCA most likely applies to you. For more information, please read [implementing SCA](/guides/developer/auth-and-security/sca-and-2fa). {% /admonition %} |
| profiles.batch_groups.payment_initiations.create | Funds all transfers in a batch group via direct debit. The batch group must be in the `COMPLETED` state. To use this funding method, you need to link an external bank account first. See [direct debit account creation](/api-reference/direct-debit-account/directdebitaccountcreate) for more information. {% admonition type="warning" %} This endpoint is SCA protected when it applies. If your profile is registered within the UK and/or EEA, SCA most likely applies to you. For more information, please read [implementing SCA](/guides/developer/auth-and-security/sca-and-2fa). {% /admonition %} |
| profiles.batch_groups.payment_initiations.get | Get payment initiation info by ID. In addition to [webhooks](/api-reference/webhook-event/eventbatchpaymentinitiationsstatechange), this endpoint can be used for polling the status of a payment initiation. |
| settlements.create | Sends the settlement journal to Wise. There are two types of settlement: - **Same Currency Settlement** — Settle in the same currency as the transfers (e.g., settle USD transfers with USD). - **Cross Currency Settlement** — Settle in a different currency (e.g., settle PHP transfers with USD). In this case, you must specify `settlementCurrency` and include `exchangeRate` on every transfer. {% admonition type="info" %} You must use a client credentials token to authenticate this call. {% /admonition %} |
| spend.profiles.cards.list | Returns a paginated list of cards that belong to a specific profile. |
| spend.profiles.cards.get | Retrieves details for a specific card by its token. |
| spend.profiles.cards.status.update | Update the status of a card. For cards issued with an `INACTIVE` status, updating to `ACTIVE` will activate the card and move the card order status to `COMPLETED`. **Available status transitions:** - `ACTIVE` - The card is active and usable - `FROZEN` - The card is temporarily frozen; all authorization requests will be declined - `BLOCKED` - The card is **irreversibly** blocked and is no longer usable |
| spend.profiles.cards.reset_pin_count.create | If the wrong PIN has been entered more than 3 times, future transactions on the card will be blocked with a `PIN_ENTRY_TRIES_EXCEEDED` error message. Use this endpoint to reset the PIN count to 0 and unblock transactions. {% admonition type="info" %} In some cases, you may also need to reset the PIN count directly at the ATM. {% /admonition %} |
| spend.profiles.cards.spending_permissions.list | Retrieves the current spending permissions configured for a card. |
| spend.profiles.cards.spending_permissions.update_v3 | Enable or disable a single spending permission on a card. {% admonition type="warning" %} This endpoint is deprecated. Please use the [v4 endpoint](/api-reference/card/cardpermissionsbulkupdate) instead. {% /admonition %} |
| spend.profiles.cards.spending_permissions.update_v4 | Enable or disable multiple spending permissions on a card in a single request. This is the recommended endpoint for updating card permissions as it allows updating multiple permissions atomically. |
| cards.client_side_encryption.fetch_encrypting_key.list | Fetches Wise's RSA public key required for encrypting sensitive card data requests. This key is used in the [sensitive card details flow](/guides/product/issue-cards/sensitive-card-details) to create JWE (JSON Web Encryption) payloads. |
| cards.sensitive_card_data.details.create | Fetches the card's Primary Account Number (PAN), security code (CVV2), expiry date, and cardholder name. Requires an encrypted JWE payload for security. See the [sensitive card details guide](/guides/product/issue-cards/sensitive-card-details) for implementation details. To retrieve sensitive card details, the card must be in either `ACTIVE` or `FROZEN` status. A 403 response will be returned for cards in any other status. {% admonition type="warning" %} This endpoint is SCA protected when applicable. If your profile is registered within the UK and/or EEA, SCA most likely applies. For more information, see [implementing SCA](/guides/developer/auth-and-security/sca-and-2fa). {% /admonition %} |
| cards.sensitive_card_data.pin.create | Fetches the card's PIN. Requires an encrypted JWE payload for security. See the [sensitive card details guide](/guides/product/issue-cards/sensitive-card-details) for implementation details. {% admonition type="warning" %} This endpoint is SCA protected when applicable. If your profile is registered within the UK and/or EEA, SCA most likely applies. For more information, see [implementing SCA](/guides/developer/auth-and-security/sca-and-2fa). {% /admonition %} |
| spend.profiles.cards.phone_number.update | {% admonition type="warning" %} This endpoint is deprecated for partners onboarded after 1/3/2025. For new and existing partners, your clientId will need to be approved by our support team to make the `phoneNumber` optional in the [create card order endpoint](/api-reference/card-order/cardordercreate). See [3DS for more information](/guides/product/issue-cards/3ds). {% /admonition %} Updates the phone number of a card. The new phone number must be a valid phone number. |
| spend.profiles.cards.production.get | Retrieves the current production status of a card at a kiosk machine. **Best practice**: Subscribe to the [card production status change](/api-reference/webhook-event/eventcardscardproductionstatuschange) webhook for real-time notifications. Use this endpoint only when you need to synchronously check the status. |
| spend.profiles.cards.production.update | Sends the card production request to a kiosk machine. To confirm that card information has been successfully created, listen to the [card-production-status-change](/api-reference/webhook-event/eventcardscardproductionstatuschange) webhook with status `READY`. {% admonition type="warning" %} Cards that were created over 60 days ago will result in a 422 error code and cannot be retried. This is due to the data being obfuscated on our side. In this case, a new card order has to be created. {% /admonition %} |
| spend.profiles.card_orders.list | Retrieves a list of card orders created for the specified `profileId`. |
| spend.profiles.card_orders.create | Creates a new card order. The `program` field value is retrieved from the [retrieve all card programs](/api-reference/card-order/cardorderprogramsget) endpoint. {% admonition type="warning" %} This request requires an extra field in the header, `X-idempotence-uuid`. This should be generated and used for any subsequent retries in the event that the initial request fails. {% /admonition %} When you issue a card under a business profile, the cardholder will automatically default to the [business representative](/api-reference/profile/profilebusinesscreate). If the cardholder is not the business representative, create a cardholder [personal profile](/api-reference/profile/profilepersonalcreate) and add the profileId of the cardholder profile to the `cardHolderProfileId` field on the card order request. For country-specific address fields and validation rules, see the [card address validation guide](/guides/developer/api-guides/card-address-validation). |
| spend.profiles.card_orders.get | Retrieves a card order based on the `cardOrderId`. |
| spend.profiles.card_orders.availability.list | Retrieves the list of available card programs for each `profileId`. |
| spend.profiles.card_orders.requirements.list | Retrieves all card requirements for a `cardOrderId`. A valid card order needs all its requirements status to be `COMPLETED`. The type of requirements are: - `PIN (optional)`: [Set a PIN](/api-reference/card-order/cardorderpresetpin) on a virtual or physical card order. Contact the team if you need this feature. - `VERIFICATION`: Verify your customer by providing KYC evidences. Refer to the [KYC guide](/guides/product/kyc). - `ADDRESS`: Provide a valid address for your card order. Refer to [address validation](/api-reference/card-order/cardordervalidateaddress). A requirement **status** has the following values: - `NOT_INITIATED` - `NEEDS_ACTION` - `PENDING` - `COMPLETED` - `FAILED` |
| spend.profiles.card_orders.status.update | Updates the status of a card order based on its `cardOrderId`. The status can be updated to one of the following: 1. `CANCELLED` 2. `COMPLETED` (deprecated) The behaviour for card order cancellation differs across card order statuses: - `PLACED`: Card order can be cancelled with no further action required. - `REQUIREMENTS_FULFILLED`, `CARD_DETAILS_CREATED`, `PRODUCED`: Card order can be cancelled, and its associated card will be blocked. However, the physical card may have already been produced and may be in delivery. If so, the card will still reach the end user's address. This should be communicated to the end user to prevent confusion. - `COMPLETED`, `RETURNED`: Card orders in these statuses cannot be cancelled. {% admonition type="info" %} Updating a card order status to `COMPLETED` is deprecated. Check with our team whether this is supported in your integration. {% /admonition %} |
| spend.address.validate | Validates the format of an address for a card order. Make sure to follow country-specific address fields and validation as described in the [card address validation guide](/guides/developer/api-guides/card-address-validation). For virtual cards, the address field will be used as a billing address. It will be used for AVS checks in countries where it is required. For physical cards, the address field will be used as a delivery address. It will be used to deliver your card and for AVS checks in countries where it is required. {% admonition type="warning" %} We do not support PO BOX addresses. {% /admonition %} |
| cards.sensitive_card_data.preset_pin.create | Sets a PIN during the card order flow. This endpoint will be accessible for partners that require to set a PIN during the card order flow. Please follow [this guide](/guides/product/issue-cards/sensitive-card-details) to use this endpoint. To use this endpoint, make sure to set the `api token` and the `card order id` in the headers. |
| spend.profiles.cards.transactions.get_v3 | {% admonition type="warning" %} This endpoint is deprecated. Use the [V4 Get card transaction](/api-reference/card-transaction/cardtransactionget) endpoint instead. {% /admonition %} Retrieve a card transaction by its ID. Use in conjunction with the [V2.0.0 card transaction state change webhook](/guides/developer/webhooks/event-types#cards-transaction-state-change). When a refund happens, a separate transaction will be added with a `REFUND` transaction type. |