Overview
- GET /v1/profiles
- POST /v1/profiles
- POST /v2/quotes
- GET /v1/accounts/
- GET /v1/quotes/{new-quote-id}/account-requirements
- POST /v1/quotes/{new-quote-id}/account-requirements
- PARAMETERS /v1/quotes/{new-quote-id}/account-requirements
- POST /v1/accounts
- GET /api/guid
- POST /v1/transfer-requirements
- POST /v1/transfers
- [[#post-v3profilesprofile-on-behalf-of-which-transfer-was-createdtransfersnew-transfer-idpayments|POST /v3/profiles/
/transfers/{new-transfer-id}/payments]] - [[#parameters-v3profilesprofile-on-behalf-of-which-transfer-was-createdtransfersnew-transfer-idpayments|PARAMETERS /v3/profiles/
/transfers/{new-transfer-id}/payments]] - GET /v3/profiles/{business-profile-id}/subscriptions
- POST /v3/profiles/{business-profile-id}/subscriptions
- PARAMETERS /v3/profiles/{business-profile-id}/subscriptions
- GET /v3/profiles/{business-profile-id}/subscriptions/{webhook1-id}
- DELETE /v3/profiles/{business-profile-id}/subscriptions/{webhook1-id}
- PARAMETERS /v3/profiles/{business-profile-id}/subscriptions/{webhook1-id}
- DELETE /v3/profiles/{business-profile-id}/subscriptions/{webhook2-id}
- PARAMETERS /v3/profiles/{business-profile-id}/subscriptions/{webhook2-id}
- GET /v1/simulation/transfers/{new-transfer-id}/processing
- PARAMETERS /v1/simulation/transfers/{new-transfer-id}/processing
- GET /v1/simulation/transfers/{new-transfer-id}/funds_converted
- PARAMETERS /v1/simulation/transfers/{new-transfer-id}/funds_converted
- GET /v1/simulation/transfers/{new-transfer-id}/outgoing_payment_sent
- PARAMETERS /v1/simulation/transfers/{new-transfer-id}/outgoing_payment_sent
- GET /v1/simulation/transfers/{new-transfer-id}/bounced_back
- PARAMETERS /v1/simulation/transfers/{new-transfer-id}/bounced_back
- GET /v1/simulation/transfers/{new-transfer-id}/funds_refunded
- PARAMETERS /v1/simulation/transfers/{new-transfer-id}/funds_refunded
- GET /v1/transfers/{new-transfer-id}/receipt.pdf
- PARAMETERS /v1/transfers/{new-transfer-id}/receipt.pdf
- GET /v1/borderless-accounts
- GET /v3/profiles/{profile-id}/borderless-accounts/{borderless-id}/statement.json
- PARAMETERS /v3/profiles/{profile-id}/borderless-accounts/{borderless-id}/statement.json
- GET /v1/quotes
- POST /v1/quotes
- POST /v1/borderless-accounts/{borderles-id}/conversions
- PARAMETERS /v1/borderless-accounts/{borderles-id}/conversions
- POST /oauth/token
- POST /v1/user/signup/registration_code
- POST /v1/addresses
- POST /v1/profiles/{business-profile-id}/directors
- PARAMETERS /v1/profiles/{business-profile-id}/directors
- POST /v1/profiles/{business-profile-id}/ubos
- PARAMETERS /v1/profiles/{business-profile-id}/ubos
- POST /v1/profiles/{business-profile-id}/extensions
- PARAMETERS /v1/profiles/{business-profile-id}/extensions
- GET /v2/profiles
- POST /v1/user/claim-account
- GET /v1/rates
- GET /v3/comparisons/
GET /v1/profiles
Summary: 1. Get profile list
- Get profile list
OpenAPI snippet URL
POST /v1/profiles
Summary: 1. Create business profile
| Field | Description | Format | Validation Rules (java regex) |
|---|---|---|---|
| type | ”business” | Text | Always “business” |
| details.name | Business name | Text | Must not contain: %#^@{}"!~<>\. ((^[^%#^@{}"!~<>\\]+$)) |
| details.registrationNumber | Business registration number | Text | 1 to 30 characters. |
| details.acn | Australian Company Number (only for Australian businesses) | Text | Must be valid ACN. |
| details.abn | Australian Business Number (only for Australian businesses) | Text | Must be valid ABN. |
| details.arbn | Australian Registered Body Number (only for Australian businesses) | Text | Must be valid ARBN. |
| details.companyType | Company legal form. Allowed values:
| Text | Must be one of the enum values. |
| details.companyRole | Role of person. Allowed Values:
| Text | Must be one of the enum values. |
| details.descriptionOfBusiness | Sector / filed of activity (DEPRECATED) | Text | Deprecated, use businessCategory and set this as null. |
| details.webpage (conditional) | Business webpage. Required if companyType is OTHER | Text | Valid URL. (^(?i)\\b(https?://)?((?=[a-z0-9-]{1,63}\\.)[a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,63}\\b(/.*)*$) |
| details.businessCategory | Type of business, see below for permitted values | Text | One of the below Business Category values. |
| details.businessSubCategory | Specific sub category of the business type, see below for permitted values | Text | A valid subcategory of the selected businessCategory. |
Business Category
Ensure when submitting a business profile that you submit a category and associated sub-category from the list below. You should map from the information you have about the business to one of our categories and sub-categories. If this is problematic please get in touch with us to discuss alternate solutions.
The categories and their sub-categories are as follows:
- CHARITY_NON_PROFIT
- CHARITY_ALL_ACTIVITIES
- CONSULTING_IT_BUSINESS_SERVICES
- ADVERTISING_AND_MARKETING
- ARCHITECTURE
- COMPANY_ESTABLISHMENT_FORMATION_SERVICES
- DESIGN
- FINANCIAL_CONSULTING_ACCOUNTING_TAXATION_AUDITING
- IT_DEVELOPMENT
- IT_HOSTING_SERVICES
- IT_CONSULTING_AND_SERVICES
- LEGAL_SERVICES
- MANAGEMENT_CONSULTING
- SCIENTIFIC_AND_TECHNICAL_CONSULTING
- SOFTWARE_AS_A_SERVICE
- TRANSLATION_AND_LANGUAGE_SERVICES
- CONSULTING_OTHER
- SERVICES_OTHER
- FREELANCE_PLATFORMS
- RECRUITMENT_SERVICES
- MAINTENANCE_SERVICES
- FREELANCE_PLATFORMS
- DESIGN_MARKETING_COMMUNICATIONS
- ADVERTISING_AND_MARKETING
- ARCHITECTURE
- AUDIO_AND_VIDEO
- DESIGN
- PHOTOGRAPHY
- PRINT_AND_ONLINE_MEDIA
- TELECOMMUNICATIONS_SERVICES
- TRANSLATION_AND_LANGUAGE_SERVICES
- MEDIA_COMMUNICATION_ENTERTAINMENT
- ADULT_CONTENT
- AUDIO_AND_VIDEO
- FINE_ARTS
- ARTS_OTHER
- EVENTS_AND_ENTERTAINMENT
- GAMBLING_BETTING_AND_ONLINE_GAMING
- NEWSPAPERS_MAGAZINES_AND_BOOKS
- PERFORMING_ARTS
- PHOTOGRAPHY
- TELECOMMUNICATIONS_SERVICES
- VIDEO_GAMING
- EDUCATION_LEARNING
- SCHOOLS_AND_UNIVERSITIES,
- TEACHING_AND_TUTORING
- ONLINE_LEARNING
- FINANCIAL_SERVICES_PRODUCTS_HOLDING_COMPANIES
- CROWDFUNDING
- CRYPTOCURRENCY_FINANCIAL_SERVICES
- FINANCIAL_CONSULTING_ACCOUNTING_TAXATION_AUDITING
- HOLDING_COMPANIES
- INSURANCE
- INVESTMENTS
- MONEY_SERVICE_BUSINESSES
- FINANCIAL_SERVICES_OTHER
- FOOD_BEVERAGES_TOBACCO
- ALCOHOL
- FOOD_MANUFACTURING_RETAIL
- RESTAURANTS_AND_CATERING
- SOFT_DRINKS
- TOBACCO
- VITAMINS_AND_DIETARY_SUPPLEMENTS
- HEALTH_PHARMACEUTICALS_PERSONAL_CARE
- HEALTH_AND_BEAUTY_PRODUCTS_AND_SERVICES,
- DENTAL_SERVICES,
- DOCTORS_AND_MEDICAL_SERVICES,
- ELDERLY_OR_OTHER_CARE_HOME,
- FITNESS_SPORTS_SERVICES,
- MEDICAL_EQUIPMENT,
- NURSING_AND_OTHER_CARE_SERVICES,
- PHARMACEUTICALS,
- PHARMACY,
- VITAMINS_AND_DIETARY_SUPPLEMENTS
- PUBLIC_GOVERNMENT_SERVICES
- PUBLIC_ALL_SERVICES
- MAINTENANCE_SERVICES
- GOVERNMENT_SERVICES
- TELECOMMUNICATIONS_SERVICES
- UTILITY_SERVICES
- REAL_ESTATE_CONSTRUCTION
- ARCHITECTURE
- CONSTRUCTION
- REAL_ESTATE_DEVELOPMENT
- REAL_ESTATE_SALE_PURCHASE_AND_MANAGEMENT
- RETAIL_WHOLESALE_MANUFACTURING
- AGRICULTURE_SEEDS_PLANTS
- FINE_ARTS
- ARTS_OTHER
- AUTOMOTIVE_SALES_SPARE_PARTS_TRADE
- AUTOMOTIVE_MANUFACTURING
- CHEMICALS
- CLOTHING
- ELECTRICAL_PRODUCTS
- FIREARMS_WEAPONS_AND_MILITARY_GOODS_SERVICES
- HOME_ACCESSORIES_FURNITURE
- FINE_JEWELLERY_WATCHES
- FASHION_JEWELLERY
- HEALTH_AND_BEAUTY_PRODUCTS_AND_SERVICES
- LEGAL_HIGHS_AND_RELATED_ACCESSORIES
- MACHINERY
- PETS
- PRECIOUS_STONES_DIAMONDS_AND_METALS
- SPORTING_EQUIPMENT
- MANUFACTURING_OTHER
- RETAIL_WHOLESALE_MARKETPLACE_AUCTION
- RETAIL_WHOLESALE_OTHER
- TOYS_AND_GAMES
- TRAVEL_TRANSPORT_TOUR_AGENCIES
- ACCOMMODATION_HOTELS
- PASSENGER_TRANSPORT
- FREIGHT_TRANSPORT
- RIDESHARING_TRANSPORT_SHARING_SERVICES
- TRANSPORT
- TRAVEL_AGENCIES
- TOUR_OPERATORS
- TRAVEL_OR_TOUR_ACTIVITIES_OTHER
- OTHER
- OTHER_NOT_LISTED_ABOVE
OpenAPI snippet URL
POST /v2/quotes
Summary: 1. Create Quote
Note: profile ID used in this call will define whether transfer is made on behalf of the person or business.
OpenAPI snippet URL
GET /v1/accounts/
Summary: 1. Load accounts
- Load accounts
OpenAPI snippet URL
GET /v1/quotes/{new-quote-id}/account-requirements
Summary: 1. Get recipient creation dynamic form
- Get recipient creation dynamic form
OpenAPI snippet URL
POST /v1/quotes/{new-quote-id}/account-requirements
Summary: 2. Update form if any field require refresh
POST /account-requirements
OpenAPI snippet URL
PARAMETERS /v1/quotes/{new-quote-id}/account-requirements
OpenAPI snippet URL
POST /v1/accounts
Summary: 3. Create account
- Create account
OpenAPI snippet URL
GET /api/guid
Summary: 4. Generate GUID for idempotency
You don’t have to use an API for this - you can almost certainly do it in code. This is just for testing convenience.
OpenAPI snippet URL
POST /v1/transfer-requirements
Summary: 2. Get transfer extra info dynamic form
- Get transfer extra info dynamic form
OpenAPI snippet URL
POST /v1/transfers
Summary: 5. Create transfer
A transfer is a payment order to recipient account based on a quote. Once created, a transfer needs to be funded within the next five working days. Otherwise, it will be automatically canceled.
OpenAPI snippet URL
POST /v3/profiles//transfers/{new-transfer-id}/payments
Summary: 1. Fund transfer
The only way to fund your transfers via API is to fund them from balance. Note that based on the user origin this call might be the subject for SCA, more details in API Documentation
OpenAPI snippet URL
PARAMETERS /v3/profiles//transfers/{new-transfer-id}/payments
OpenAPI snippet URL
GET /v3/profiles/{business-profile-id}/subscriptions
Summary: 3. List webhook subscriptions
- List webhook subscriptions
OpenAPI snippet URL
POST /v3/profiles/{business-profile-id}/subscriptions
Summary: 1. Create subsription for transfer state change
- Create subsription for transfer state change
OpenAPI snippet URL
PARAMETERS /v3/profiles/{business-profile-id}/subscriptions
OpenAPI snippet URL
GET /v3/profiles/{business-profile-id}/subscriptions/{webhook1-id}
Summary: 4. Get webhook subscription by ID
- Get webhook subscription by ID
OpenAPI snippet URL
DELETE /v3/profiles/{business-profile-id}/subscriptions/{webhook1-id}
Summary: 5. Delete webhook subscription for transfer state change
- Delete webhook subscription for transfer state change
OpenAPI snippet URL
PARAMETERS /v3/profiles/{business-profile-id}/subscriptions/{webhook1-id}
OpenAPI snippet URL
DELETE /v3/profiles/{business-profile-id}/subscriptions/{webhook2-id}
Summary: 6. Delete webhook subscription for borderless deposit
- Delete webhook subscription for borderless deposit
OpenAPI snippet URL
PARAMETERS /v3/profiles/{business-profile-id}/subscriptions/{webhook2-id}
OpenAPI snippet URL
GET /v1/simulation/transfers/{new-transfer-id}/processing
Summary: 1. Set as processing
- Set as processing
OpenAPI snippet URL
PARAMETERS /v1/simulation/transfers/{new-transfer-id}/processing
OpenAPI snippet URL
GET /v1/simulation/transfers/{new-transfer-id}/funds_converted
Summary: 2. Set as funds_converted
- Set as funds_converted
OpenAPI snippet URL
PARAMETERS /v1/simulation/transfers/{new-transfer-id}/funds_converted
OpenAPI snippet URL
GET /v1/simulation/transfers/{new-transfer-id}/outgoing_payment_sent
Summary: 3. Set as outgoing_payment_sent
- Set as outgoing_payment_sent
OpenAPI snippet URL
PARAMETERS /v1/simulation/transfers/{new-transfer-id}/outgoing_payment_sent
OpenAPI snippet URL
GET /v1/simulation/transfers/{new-transfer-id}/bounced_back
Summary: 4. Set as bounced_back
- Set as bounced_back
OpenAPI snippet URL
PARAMETERS /v1/simulation/transfers/{new-transfer-id}/bounced_back
OpenAPI snippet URL
GET /v1/simulation/transfers/{new-transfer-id}/funds_refunded
Summary: 5. Set as funds_refunded
- Set as funds_refunded
OpenAPI snippet URL
PARAMETERS /v1/simulation/transfers/{new-transfer-id}/funds_refunded
OpenAPI snippet URL
GET /v1/transfers/{new-transfer-id}/receipt.pdf
Summary: Get reciept PDF
Download transfer confirmation receipt in PDF format for transfers that are in status outgoing_payment_sent.
OpenAPI snippet URL
PARAMETERS /v1/transfers/{new-transfer-id}/receipt.pdf
OpenAPI snippet URL
GET /v1/borderless-accounts
Summary: GET List of balances
Get a list of multi currency account balances
OpenAPI snippet URL
GET /v3/profiles/{profile-id}/borderless-accounts/{borderless-id}/statement.json
Summary: GET balance statement
GET balance statement
OpenAPI snippet URL
PARAMETERS /v3/profiles/{profile-id}/borderless-accounts/{borderless-id}/statement.json
OpenAPI snippet URL
GET /v1/quotes
Summary: Get pricing and speed
Is currency route supported?
If we don’t support a route then this endpoint will respond with an error code “error.route.not.supported”.
How much does a transfer cost?
The TransferWise fee is included in the response.
How long does my transfer take?
Estimated delivery time is included in the response. This can vary quite a lot for different currency routes. For example transfers often only take a few hours from EUR to GBP, while sending money from USD can take 1-2 business days. This endpoint allows you to find out the estimated delivery time for each currency route.
See more at Get Temporary Quote
OpenAPI snippet URL
POST /v1/quotes
Summary: 1. Create Quote
Note: For currencies conversion quote should have type BALANCE_CONVERSION. Profile ID used in this call will define whether transfer is made on behalf of the person or business.
OpenAPI snippet URL
POST /v1/borderless-accounts/{borderles-id}/conversions
Summary: 4. Initiate currencies conversion
Convert funds between your borderless account currencies. Quote which is used in this call must have type “BALANCE_CONVERSION”.
Note that this call needs an extra field in header called “X-idempotence-uuid”.
OpenAPI snippet URL
PARAMETERS /v1/borderless-accounts/{borderles-id}/conversions
OpenAPI snippet URL
POST /oauth/token
Summary: 1. Client Credentials Token
Get a client credentials token using your client id and secret.
OpenAPI snippet URL
POST /v1/user/signup/registration_code
Summary: 2. Create User
Create a new user account without any profiles. Subsequently the profile creation endpoints must be used to complete the customer’s account creation.
It is advised to generate a UUID for the registration code input. The registration code is sensitive information that should be used and stored according to security standards that also apply to passwords.
In case the user you are trying to create already exists in Wise, you’ll receive an error. This means the user is already a Wise customer, so you don’t need to onboard them using this API. Instead you can just redirect them to our authorization page in order to link their account with Wise.
OpenAPI snippet URL
POST /v1/addresses
Summary: 2. Create business address
- Create business address
OpenAPI snippet URL
POST /v1/profiles/{business-profile-id}/directors
Summary: 3. Create business directors
- Create business directors
OpenAPI snippet URL
PARAMETERS /v1/profiles/{business-profile-id}/directors
OpenAPI snippet URL
POST /v1/profiles/{business-profile-id}/ubos
Summary: 4. Create business UBOs
- Create business UBOs
OpenAPI snippet URL
PARAMETERS /v1/profiles/{business-profile-id}/ubos
OpenAPI snippet URL
POST /v1/profiles/{business-profile-id}/extensions
Summary: 5. Set account purpose
End point to setup account purpose.
List of available values:
- “INVESTING_IN_FUNDS_STOCKS_BONDS_OPTIONS_FUTURES_OR_OTHER"
- "DISTRIBUTING_COMPANY_PROFITS_OR_PAYING_DIVIDENDS"
- "PAYING_RENT_MORTGAGE_BANK_LOAN_INSURANCE_CREDIT"
- "PAYING_FOR_GOODS_SERVICES_ABROAD"
- "PAYING_RENT_UTILITIES_OR_PROPERTY_CHARGES"
- "PAYING_SUPPLIERS_CONTRACTORS_EMPLOYEES"
- "PAYING_TAX_ON_PROFIT_OR_PROPERTY"
- "TRANSFER_WITHIN_COMPANY_OR_GROUP”
OpenAPI snippet URL
PARAMETERS /v1/profiles/{business-profile-id}/extensions
OpenAPI snippet URL
GET /v2/profiles
Summary: 3. Get profile list
You can get the list of profiles created earlier.
OpenAPI snippet URL
POST /v1/user/claim-account
Summary: 1. Generate Claim Account Code
Use the Registration Code from Step 1.2 to generate a Claim Account Code
OpenAPI snippet URL
GET /v1/rates
Summary: Get current exchange rates
TransferWise updates exchange rates in nearly real-time – at least once per minute. This allows you to track and see the current mid-market exchange rate for any currency route.
See more at Exchange Rates.List
OpenAPI snippet URL
GET /v3/comparisons/
Summary: Get price comparison
API to build a transparent price comparison page based on data collected by TransferWise
OpenAPI snippet URL