To manage certain aspects of the 3D Secure (3DS) authentication, you will need to integrate with the following APIs.
Wise Platform API
The Wise Platform API is a REST-based interface that enables programmatic access to Wise's payment infrastructure. All endpoints return JSON-formatted responses and use standard HTTP methods and status codes.
We strongly recommend first reading our Getting Started Guide to help you set up credentials and make your first call.
Before you begin
To use this API reference effectively, you should have:
- Received Valid API credentials from Wise (Client ID and Client Secret)
- Understand OAuth 2.0 authentication
- Be familiar with RESTful API concepts
Core API resources
| Resource | Purpose |
|---|---|
| Quote | Exchange rate and fee calculations |
| Recipient | Beneficiary account management |
| Transfer | Payment creation and execution |
| Balance | Multi-currency account operations |
| Profile | Account ownership details |
| Rate | Current and historical exchange rates |
Not sure which workflow to build?
Start with our Integration Guides for step-by-step implementation examples.
Additional Customer Verification
In certain situations, additional evidence is required to verify customers and ensure we’re compliant with the KYC regulations.
Additional Verification APIs support a list of evidences that can be found in the Supported Evidences guide.
If you use the Customer Account with Partner KYC model and your customers are primarily based in the EU, refer to this Onboarding EU customers guide for instructions on how to use these APIs.
If you use the Customer Account with Partner KYC model and you are onboarding high risk business customers based primarily based in the US, refer to this Onboarding High Risk US Businesses guide for instructions on how to use these APIs.
Balance
Create and manage balance accounts within a multi-currency account.
Each profile can hold multiple balance accounts in different currencies. A STANDARD balance is limited to one per currency, while SAVINGS balances (Jars) allow multiple in the same currency. Creating the first balance for a profile automatically creates the multi-currency account.
Balances include an investmentState field. Only balances with NOT_INVESTED can be operated on via the API. Invested balances should be shown but not actionable.
For a complete guide on multi-currency accounts, see Multi-Currency Accounts.
Bank Account Details
Bank account details allow users to receive money into their Wise Multi-Currency Account. Each currency balance can have local bank details (for domestic payments) and international bank details (for SWIFT payments) where available.
Bank account details can be retrieved for existing balances, or new details can be ordered for currencies where they're available but not yet issued.
Batch Group
A batch group is a named collection of up to 1000 transfers that can be managed as a single unit. Batch groups are primarily used for funding multiple transfers with a single payment.
Workflow:
- Create a batch group with a source currency
- Add transfers to the group (up to 1000)
- Complete the batch group to close it for modifications
- Fund the batch group from a balance or via direct debit
Individual transfers in the group follow standard transfer lifecycle and can be tracked separately.
Batch Group
Batch version, used for concurrency control. This number is updated whenever there is a change to the batch group state (its status, the identity of the transfers in the batch, etc).
Some API operations require this version in requests, and operations may be rejected when the requested version does not match the server's version.
The version is a signed integer and is not ordered with respect to any previous version.
Source currency code (ISO 4217 Alphabetic Code). This currency is expected to be used for funding the batch group.
Current batch group status:
NEW— New batch group with zero or more transfers. Able to have more transfers added to it. Transfers in aNEWgroup cannot yet be funded and paid out.COMPLETED— The batch group has had all desired transfers added and is now closed to further changes. Transfers in the group can now be funded and paid out. Note:COMPLETEDdoes not imply payouts have been successfully completed.MARKED_FOR_CANCELLATION— Cancellation of the transfers in the batch group was requested.PROCESSING_CANCEL— Transfers in the group are being cancelled.CANCELLED— Transfers in the group have been cancelled.
The IDs of all transfers successfully added to the group.
List of pay-in details describing how the batch group can be funded. Provided only when the batch group is in the COMPLETED state.
Currently supported types: bank_transfer.
The reference that should be used when funding the transfers in the batch group. This reference should be treated as an opaque value and there should be no attempt to decode or decompose it.
The total pay-in amount for all transactions in the batch when paying in with this reference and method.
Name of the bank branch. Provided only when the currency route requires it (such as JPY).
Bank account type. Provided only when the currency route requires it.
Bank identifier or routing number, depending on pay-in type and currency.
Address for the receiving bank. Provided only when the currency route requires it.
Wise's address. Provided only when the currency route requires it.
ISO 13616 International Bank Account Number (when available).
Basic Bank Account Number (BBAN). Provided only when the currency route requires it (such as NOK).
Financial Institution number (3 digits). Provided only when the currency route requires it (such as CAD).
Branch Transit Number (5 digits). Provided only when the currency route requires it (such as CAD).
Beneficiary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).
Intermediary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).
Faster Payment System identifier. Provided only when the currency route requires it (such as HKD).
{ "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88", "version": 123, "name": "My batch group", "sourceCurrency": "GBP", "status": "COMPLETED", "transferIds": [ 234, 456 ], "payInDetails": [ { "type": "bank_transfer", "reference": "B5323", "amount": 12504.54, "currency": "NOK", "name": "TransferWise Ltd", "branchName": null, "accountNumber": "9910728", "accountType": null, "bankCode": "8301", "bankAddress": { … }, "transferWiseAddress": { … }, "iban": null, "bban": "83019910728", "institutionNumber": null, "transitNumber": null, "beneficiaryBankBIC": null, "intermediaryBankBIC": null, "fpsIdentifier": null, "clearingNumber": null } ] }
Source currency code (ISO 4217 Alphabetic Code). This currency is expected to be used for funding the batch group.
- Production Environmenthttps://api.wise.com/v3/profiles/{profileId}/batch-groups
- Sandbox Environmenthttps://api.wise-sandbox.com/v3/profiles/{profileId}/batch-groups
curl -i -X POST \
https://api.wise.com/v3/profiles/12345678/batch-groups \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"sourceCurrency": "GBP",
"name": "My batch group"
}'Batch group created successfully.
Note that payInDetails is empty for newly created batch groups.
Batch version, used for concurrency control. This number is updated whenever there is a change to the batch group state (its status, the identity of the transfers in the batch, etc).
Some API operations require this version in requests, and operations may be rejected when the requested version does not match the server's version.
The version is a signed integer and is not ordered with respect to any previous version.
Source currency code (ISO 4217 Alphabetic Code). This currency is expected to be used for funding the batch group.
Current batch group status:
NEW— New batch group with zero or more transfers. Able to have more transfers added to it. Transfers in aNEWgroup cannot yet be funded and paid out.COMPLETED— The batch group has had all desired transfers added and is now closed to further changes. Transfers in the group can now be funded and paid out. Note:COMPLETEDdoes not imply payouts have been successfully completed.MARKED_FOR_CANCELLATION— Cancellation of the transfers in the batch group was requested.PROCESSING_CANCEL— Transfers in the group are being cancelled.CANCELLED— Transfers in the group have been cancelled.
The IDs of all transfers successfully added to the group.
List of pay-in details describing how the batch group can be funded. Provided only when the batch group is in the COMPLETED state.
Currently supported types: bank_transfer.
The reference that should be used when funding the transfers in the batch group. This reference should be treated as an opaque value and there should be no attempt to decode or decompose it.
The total pay-in amount for all transactions in the batch when paying in with this reference and method.
Name of the bank branch. Provided only when the currency route requires it (such as JPY).
Bank account type. Provided only when the currency route requires it.
Bank identifier or routing number, depending on pay-in type and currency.
Address for the receiving bank. Provided only when the currency route requires it.
Wise's address. Provided only when the currency route requires it.
ISO 13616 International Bank Account Number (when available).
Basic Bank Account Number (BBAN). Provided only when the currency route requires it (such as NOK).
Financial Institution number (3 digits). Provided only when the currency route requires it (such as CAD).
Branch Transit Number (5 digits). Provided only when the currency route requires it (such as CAD).
Beneficiary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).
Intermediary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).
Faster Payment System identifier. Provided only when the currency route requires it (such as HKD).
{ "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88", "version": 0, "name": "My batch group", "sourceCurrency": "GBP", "status": "NEW", "transferIds": [], "payInDetails": [] }
- Production Environmenthttps://api.wise.com/v3/profiles/{profileId}/batch-groups/{batchGroupId}
- Sandbox Environmenthttps://api.wise-sandbox.com/v3/profiles/{profileId}/batch-groups/{batchGroupId}
curl -i -X GET \
https://api.wise.com/v3/profiles/12345678/batch-groups/54a6bc09-cef9-49a8-9041-f1f0c654cd88 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Batch group retrieved successfully.
Batch version, used for concurrency control. This number is updated whenever there is a change to the batch group state (its status, the identity of the transfers in the batch, etc).
Some API operations require this version in requests, and operations may be rejected when the requested version does not match the server's version.
The version is a signed integer and is not ordered with respect to any previous version.
Source currency code (ISO 4217 Alphabetic Code). This currency is expected to be used for funding the batch group.
Current batch group status:
NEW— New batch group with zero or more transfers. Able to have more transfers added to it. Transfers in aNEWgroup cannot yet be funded and paid out.COMPLETED— The batch group has had all desired transfers added and is now closed to further changes. Transfers in the group can now be funded and paid out. Note:COMPLETEDdoes not imply payouts have been successfully completed.MARKED_FOR_CANCELLATION— Cancellation of the transfers in the batch group was requested.PROCESSING_CANCEL— Transfers in the group are being cancelled.CANCELLED— Transfers in the group have been cancelled.
The IDs of all transfers successfully added to the group.
List of pay-in details describing how the batch group can be funded. Provided only when the batch group is in the COMPLETED state.
Currently supported types: bank_transfer.
The reference that should be used when funding the transfers in the batch group. This reference should be treated as an opaque value and there should be no attempt to decode or decompose it.
The total pay-in amount for all transactions in the batch when paying in with this reference and method.
Name of the bank branch. Provided only when the currency route requires it (such as JPY).
Bank account type. Provided only when the currency route requires it.
Bank identifier or routing number, depending on pay-in type and currency.
Address for the receiving bank. Provided only when the currency route requires it.
Wise's address. Provided only when the currency route requires it.
ISO 13616 International Bank Account Number (when available).
Basic Bank Account Number (BBAN). Provided only when the currency route requires it (such as NOK).
Financial Institution number (3 digits). Provided only when the currency route requires it (such as CAD).
Branch Transit Number (5 digits). Provided only when the currency route requires it (such as CAD).
Beneficiary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).
Intermediary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).
Faster Payment System identifier. Provided only when the currency route requires it (such as HKD).
{ "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88", "version": 123, "name": "My batch group", "sourceCurrency": "GBP", "status": "COMPLETED", "transferIds": [ 234, 456 ], "payInDetails": [ { "type": "bank_transfer", "reference": "B5323", "amount": 12504.54, "currency": "NOK", "name": "TransferWise Ltd", "branchName": null, "accountNumber": "9910728", "accountType": null, "bankCode": "8301", "bankAddress": { … }, "transferWiseAddress": { … }, "iban": null, "bban": "83019910728", "institutionNumber": null, "transitNumber": null, "beneficiaryBankBIC": null, "intermediaryBankBIC": null, "fpsIdentifier": null, "clearingNumber": null } ] }
Request
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.
Status to update to:
COMPLETED— Close the group and allow fundingCANCELLED— Cancel the group and all transfers
- Production Environmenthttps://api.wise.com/v3/profiles/{profileId}/batch-groups/{batchGroupId}
- Sandbox Environmenthttps://api.wise-sandbox.com/v3/profiles/{profileId}/batch-groups/{batchGroupId}
curl -i -X PATCH \
https://api.wise.com/v3/profiles/12345678/batch-groups/54a6bc09-cef9-49a8-9041-f1f0c654cd88 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"status": "COMPLETED",
"version": 1234
}'Batch group updated successfully.
Batch version, used for concurrency control. This number is updated whenever there is a change to the batch group state (its status, the identity of the transfers in the batch, etc).
Some API operations require this version in requests, and operations may be rejected when the requested version does not match the server's version.
The version is a signed integer and is not ordered with respect to any previous version.
Source currency code (ISO 4217 Alphabetic Code). This currency is expected to be used for funding the batch group.
Current batch group status:
NEW— New batch group with zero or more transfers. Able to have more transfers added to it. Transfers in aNEWgroup cannot yet be funded and paid out.COMPLETED— The batch group has had all desired transfers added and is now closed to further changes. Transfers in the group can now be funded and paid out. Note:COMPLETEDdoes not imply payouts have been successfully completed.MARKED_FOR_CANCELLATION— Cancellation of the transfers in the batch group was requested.PROCESSING_CANCEL— Transfers in the group are being cancelled.CANCELLED— Transfers in the group have been cancelled.
The IDs of all transfers successfully added to the group.
List of pay-in details describing how the batch group can be funded. Provided only when the batch group is in the COMPLETED state.
Currently supported types: bank_transfer.
The reference that should be used when funding the transfers in the batch group. This reference should be treated as an opaque value and there should be no attempt to decode or decompose it.
The total pay-in amount for all transactions in the batch when paying in with this reference and method.
Name of the bank branch. Provided only when the currency route requires it (such as JPY).
Bank account type. Provided only when the currency route requires it.
Bank identifier or routing number, depending on pay-in type and currency.
Address for the receiving bank. Provided only when the currency route requires it.
Wise's address. Provided only when the currency route requires it.
ISO 13616 International Bank Account Number (when available).
Basic Bank Account Number (BBAN). Provided only when the currency route requires it (such as NOK).
Financial Institution number (3 digits). Provided only when the currency route requires it (such as CAD).
Branch Transit Number (5 digits). Provided only when the currency route requires it (such as CAD).
Beneficiary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).
Intermediary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).
Faster Payment System identifier. Provided only when the currency route requires it (such as HKD).
{ "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88", "version": 123, "name": "My batch group", "sourceCurrency": "GBP", "status": "COMPLETED", "transferIds": [ 234, 456 ], "payInDetails": [ { "type": "bank_transfer", "reference": "B5323", "amount": 12504.54, "currency": "NOK", "name": "TransferWise Ltd", "branchName": null, "accountNumber": "9910728", "accountType": null, "bankCode": "8301", "bankAddress": { … }, "transferWiseAddress": { … }, "iban": null, "bban": "83019910728", "institutionNumber": null, "transitNumber": null, "beneficiaryBankBIC": null, "intermediaryBankBIC": null, "fpsIdentifier": null, "clearingNumber": null } ] }
Request
Create a transfer in the batch group using a previously created recipient account and quote.
For the request body format, see transfer creation. For quote and recipient creation, see quote creation and recipient creation.
Unique identifier you generate for this transfer attempt.
Transfer purpose code.
Sub-purpose code for the transfer.
- Production Environmenthttps://api.wise.com/v3/profiles/{profileId}/batch-groups/{batchGroupId}/transfers
- Sandbox Environmenthttps://api.wise-sandbox.com/v3/profiles/{profileId}/batch-groups/{batchGroupId}/transfers
curl -i -X POST \
https://api.wise.com/v3/profiles/12345678/batch-groups/54a6bc09-cef9-49a8-9041-f1f0c654cd88/transfers \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"targetAccount": 67890,
"sourceAccount": 12345,
"quoteUuid": "bd244a95-dcf8-4c31-aac8-bf5e2f3e54c0",
"customerTransactionId": "a]1b2c3d4-e5f6-7890-abcd-ef1234567890",
"details": {
"reference": "to my friend",
"transferPurpose": "verification.transfers.purpose.pay.bills",
"transferPurposeSubTransferPurpose": "verification.sub.transfers.purpose.pay.interpretation.service",
"sourceOfFunds": "verification.source.of.funds.other"
}
}'Transfer created successfully. Returns a transfer object.
Transfer object. See Transfer API reference for full details.
{}
Request
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.
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.
- Production Environmenthttps://api.wise.com/v3/profiles/{profileId}/batch-payments/{batchGroupId}/payments
- Sandbox Environmenthttps://api.wise-sandbox.com/v3/profiles/{profileId}/batch-payments/{batchGroupId}/payments
curl -i -X POST \
https://api.wise.com/v3/profiles/12345678/batch-payments/54a6bc09-cef9-49a8-9041-f1f0c654cd88/payments \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"type": "BALANCE"
}'Batch group funded successfully.
If this batch was submitted as a file, this is the given file name.
The source currency of the batch. Note that if there are insufficient funds, an automatic conversion from another currency can occur.
Current batch group status.
Whether this batch was submitted over the API or as a file.
{ "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88", "name": "My batch group", "fileName": null, "alreadyPaid": true, "shortId": 12345, "userId": 33333333, "profileId": 44444444, "sourceCurrency": "GBP", "status": "COMPLETED", "groupType": "API", "transferIds": [ 100001, 100002, 100003 ] }
Request
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 for more information.
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.
Direct debit account ID. See direct debit account creation.
- Production Environmenthttps://api.wise.com/v1/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations
- Sandbox Environmenthttps://api.wise-sandbox.com/v1/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations
curl -i -X POST \
https://api.wise.com/v1/profiles/12345678/batch-groups/54a6bc09-cef9-49a8-9041-f1f0c654cd88/payment-initiations \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"type": "DIRECT_DEBIT",
"accountId": 1,
"reference": "B1234567"
}'Payment initiation created successfully. You need to save payment initiation ID for tracking its status later.
Payment reference that will be passed to the network. Can be used for reconciliation.
Payment initiation status:
NEW— Payment initiation createdPROCESSING— Payment is being processedCOMPLETED— Payment completed successfullyFAILED— Payment failedCHARGED_BACK— Payment was charged back
Transfer ID of the direct debit payment. Present only after the direct debit is initiated.
{ "id": 12345, "batchGroupId": "068e186d-9632-4937-b753-af3e53f4d0b0", "reference": "B1234567", "userId": 33333333, "profileId": 44444444, "type": "DIRECT_DEBIT", "status": "NEW", "accountId": 1, "transferId": null, "createdTime": "2022-01-01T19:51:41.423404Z" }
Request
Get payment initiation info by ID. In addition to webhooks, this endpoint can be used for polling the status of a payment initiation.
- Production Environmenthttps://api.wise.com/v1/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}
- Sandbox Environmenthttps://api.wise-sandbox.com/v1/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}
curl -i -X GET \
https://api.wise.com/v1/profiles/12345678/batch-groups/54a6bc09-cef9-49a8-9041-f1f0c654cd88/payment-initiations/12345 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Payment initiation retrieved successfully.
Payment reference that will be passed to the network. Can be used for reconciliation.
Payment initiation status:
NEW— Payment initiation createdPROCESSING— Payment is being processedCOMPLETED— Payment completed successfullyFAILED— Payment failedCHARGED_BACK— Payment was charged back
Transfer ID of the direct debit payment. Present only after the direct debit is initiated.
{ "id": 12345, "batchGroupId": "068e186d-9632-4937-b753-af3e53f4d0b0", "reference": "B1234567", "userId": 33333333, "profileId": 44444444, "type": "DIRECT_DEBIT", "status": "NEW", "accountId": 1, "transferId": null, "createdTime": "2022-01-01T19:51:41.423404Z" }
Bulk Settlement
Bulk settlement allows partners to settle multiple transfers in a single bank transfer at the end of a settlement period. This model splits transfer creation/funding from final settlement, allowing Wise to process transfers before receiving funds based on a partner's guarantee.
Use the settlement journal endpoint to submit a list of transfers to be settled, along with the settlement reference that matches your bank transfer payment.
Card
Manage your customers' cards programmatically. These APIs allow you to retrieve card details, control card status, manage spending permissions, and access sensitive card data securely.
Key capabilities:
- List and retrieve card details for a profile
- Update card status (active, frozen, blocked)
- Control spending permissions (e-commerce, ATM, contactless, etc.)
- Access sensitive card data (PAN, CVV, PIN) via encrypted JWE payloads
Sensitive card details: Wise is a PCI DSS compliant provider and stores all card data securely. The scope for PCI compliance depends on your use case and will impact how you integrate. For all sensitive card details endpoints, follow the detailed guide.
For ordering new cards, see the Card Order API. For transaction history, see the Card Transaction API.