Creates a recipient account. A recipient is a person or institution who is the ultimate beneficiary of a transfer.
Recipient data includes:
- The personal details of an individual or basic information about a business.
- Bank details like account numbers, routing numbers, and other region-specific information.
- Address details like country and street address.
Certain fields shown in the schema are conditionally required depending on currency, type, legalType, and country.
The reference uses a GBP example for illustration purposes. As such, some fields may be null in the provided examples. To determine which fields are required for a currency, use the Retrieve recipient account requirements endpoint.
There are many variations of bank account details required, depending on recipient target currency. For example:
- GBP requires sort code and account number.
- BGN, CHF, DKK, EUR, GEL, GBP, NOK, PKR, PLN, RON, SEK require IBAN.
- USD requires routing number, account number, and account type.
- INR requires IFSC code and account number.
Recipient address data is required only if target currency is USD, PHP, THB or TRY, or if the source currency is USD or AUD.
Address fields can include:
- Country
- State (required for US, Canada, Brazil)
- City
- Address line
- Zip code
- Personal recipients: Full names must include more than one name, and both first and last name must have more than one character. Numbers are not allowed.
- Business recipients: Business names must be in full and can be a single name. The full name cannot be just a single character, but can be made up of a set of single characters (e.g.,
"A"is not permitted but"A 1"or"A1"is permitted). - Special characters
_()'*,.are allowed for personal and business names. - In general the following regex describes permitted characters:
[0-9A-Za-zÀ-ÖØ-öø-ÿ-_()'*,.\s].
Sometimes we may need to refund the transfer back to the sender. The refund recipient is the person or institution who we refund the transfer money back to when necessary.
It is not always mandatory to create a refund recipient.
- If the funds are sent over a fast local payment network, we can usually infer the refund recipient from the bank transaction that funded the transfer. Please discuss this with your Wise implementation team if you are unsure if the refund recipient is needed.
- If funds are sent using a slow domestic payment network, or you are using a bulk settlement model, we may require you to share the bank details of the source bank account.
To indicate a recipient account is a refund recipient, includ the query parameter refund=true in the request.
Use the account ID returned in the response as sourceAccount when creating transfers.
Contact us before attempting to use email recipients as it is only recommended for certain use cases.
If you don't know recipient bank account details, you can set up an email recipient. Wise then collects bank details directly from the recipient.
Wise will email your recipient with a link to collect their bank account details securely. After the bank account details have been provided, Wise completes the transfer.
Confirm this recipient type is available for your transaction by checking if the "type": "email" class is present in the response the retrieve recipient account requirements endpoint.
If planning to send multiple currencies to a single recipient, you must create a separate email recipient resource for the beneficiary, for every currency you intend to send them.
Be aware of the following:
- Testing of transfers to email recipients in sandbox is not currently possible.
- Recipients will be required to enter bank details every time a payment is made.
- We highly encourage you to provide the
profileIdif your recipient is receiving a payment from your business account, especially if you have multiple businesses or have multiple users administrating your business account. - Refer to our help page for more details about how this works and any additional constraints not mentioned here.
Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.
Recipient account type (currency/route-specific), e.g. sort_code, iban, email.
Personal or business profile ID of the sender. It is highly advised to pass the business profile ID in this field if your business account is managed by multiple users, so that the recipient can be accessed by all users authorized on the business account.
Indicates whether the recipient account is owned by the profile owner (self-transfer), such as a user sending money to their own account in another country or currency. Set to true for self-transfers. We strongly recommend setting this field, as distinguishing self-transfers from third-party transfers improves routing and processing efficiency.
- Production Environmenthttps://api.wise.com/v1/accounts
- Sandbox Environmenthttps://api.wise-sandbox.com/v1/accounts
- GBP recipient
- Email recipient
curl -i -X POST \
'https://api.wise.com/v1/accounts?refund=false' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-External-Correlation-Id: f47ac10b-58cc-4372-a567-0e02b2c3d479' \
-d '{
"currency": "GBP",
"type": "sort_code",
"profile": 30000000,
"ownedByCustomer": true,
"accountHolderName": "John Doe",
"details": {
"legalType": "PRIVATE",
"sortCode": "040075",
"accountNumber": "37778842",
"dateOfBirth": "1961-01-01"
},
"ultimateBeneficiary": {
"name": {
"fullName": "John Doe"
}
}
}'Recipient account created successfully.
Echoed back when X-External-Correlation-Id was included in the request. Learn more.
ID of the recipient. Use the returned id as sourceAccount to specify the refund recipient when creating transfers.
Account details (currency/type-specific). The keys present vary by currency route and recipient type (e.g., sort code, IBAN, SWIFT, email).
Map of key lookup fields on the account.
{ "accountNumberField": "accountNumber", "bankCodeField": "sortCode" }
Account hash for change tracking.
Lookup fields (key/label/value) for rendering a UI.
[ { "key": "details/sortCode", "label": "UK sort code", "value": "04-00-75" }, { "key": "details/accountNumber", "label": "Account number", "value": "37778842" } ]
Verification results for the recipient's details. Only populated for currencies with recipient verification enabled (CNY, KRW, INR, IDR, EUR). See the Recipient verification guides for how to handle these.
{ "id": 40000000, "creatorId": 41000000, "profileId": 30000000, "name": { "fullName": "John Doe", "givenName": null, "familyName": null, "middleName": null, "patronymicName": null, "cannotHavePatronymicName": null }, "currency": "GBP", "country": "GB", "type": "SortCode", "legalEntityType": "PERSON", "active": true, "details": { "reference": null, "sortCode": "040075", "accountNumber": "37778842", "hashedByLooseHashAlgorithm": "ad245621b974efa3ef870895c3wer419a3f01af18a8a5790b47645dba6304194" }, "commonFieldMap": { "accountNumberField": "accountNumber", "bankCodeField": "sortCode" }, "hash": "666ef880f8aa6113fa112ba6531d3ed2c26dd9fgbd7de5136bfb827a6e800479", "accountSummary": "(04-00-75) 37778842", "longAccountSummary": "GBP account ending in 8842", "displayFields": [ { "key": "details/sortCode", "label": "UK sort code", "value": "04-00-75" }, { "key": "details/accountNumber", "label": "Account number", "value": "37778842" } ], "isInternal": false, "ownedByCustomer": false, "confirmations": { "acceptedOutcomes": false, "acceptedAt": null, "quoteId": null, "outcomes": [ { … } ] } }