Wise Platform API Documentation
website·Indexed 18 days ago
https://docs.wise.com/dynamic-flowDeveloper documentation for the Wise Platform API, enabling banks and enterprises to embed multi-currency accounts, money transfers, and card management. Includes API references for balance accounts, 3DS authentication, Open Banking, and card transactions, as well as guides on error handling, versioning, and account onboarding.
What's inside Wise Platform
- PIX (Pagamentos Instantâneos) is Brazil's real-time, 24/7 payment network. Wise integrates with PIX to allow users and partners in Brazil to send and receive funds swiftly. Payments can be initiated either by the customer sending directly to Wise via a QR code/copy-paste code, or by a partner sending funds on behalf of a customer.
Overview of Wise Batch Transfers
Batch Groups allow partners to group up to 1000 transfers under a single reference. This enables multiple payments (such as monthly bills or quarterly payment runs) to be funded at once rather than individually.Overview of Relayed Authorisation
Relayed authorisation is an optional feature that allows partners to approve or decline card transactions in real time. When enabled, Wise forwards authorisation requests to the partner's endpoint for instant decisioning using internal fraud engines or spend controls.
By default, Wise manages authorisations based on pre-configured spend controls and limits. Note that the following transaction types are NOT relayed to partners:
- REFUND
- ACCOUNT_CREDIT
- CREDIT_TRANSACTION
Overview of JWE workflow with Wise Platform
Wise uses the JOSE JWE standard to ensure confidentiality for sensitive data. The end-to-end encryption process follows these steps:
- The user creates a key pair and provides the public key to Wise for response encryption.
- The user retrieves Wise's public key for request encryption.
- The user encrypts the request body using Wise's public key.
- Wise decrypts the request using its private key.
- Wise encrypts the response using the user's provided public key.
- The user decrypts the response payload.
Overview of Wise Embedded Flows
Embedded Flows are Wise-hosted frontend experiences designed for partners integrating Wise Platform. Instead of building a full custom UI and connecting every screen to APIs, partners request a flow URL from their backend and present it to the user. This is particularly useful for complex patterns like recipient creation. The flow can be integrated via an iframe, mobile WebView, or a full-page redirect.Overview of Payment Instruments and Supported Schemes
Payment instruments are saved funding sources (e.g., bank accounts) that allow automated direct debit payins to fund transfers without the payer being present. To use a payment instrument, it must first be created and then connected (activated).
Supported Schemes
Scheme Currency Region Status BACS GBP United Kingdom Live SEPA EUR Europe Live ACH USD United States Beta EFT CAD Canada Beta Overview of Bulk Settlement
Bulk settlement allows a partner to use a single bank transfer to fund multiple payouts. This process decouples transfer creation/funding from the final settlement, enabling Wise to process transfers before receiving funds based on a partner's guarantee that funds will be settled at a fixed future time.Overview of Wise user access tokens
A user access token allows an application to make requests to the Wise API on behalf of a specific Wise user. Tokens are issued after a user authorizes the partner application. Both the Authorization Code and Registration Code flows return anaccess_tokenand arefresh_token. Developers are responsible for refreshing tokens before they expire to maintain uninterrupted access.Overview of Card Kiosk Collection APIs
The Card Kiosk Collection APIs enable the printing and encryption of cards directly from a kiosk machine. Card information is sent to the card manufacturer to configure and print the card on-site. The printing process begins automatically upon receipt of the request. Users are notified of status changes via theevent.cards.card_production_status_changewebhook.Overview of Wise Balance Accounts
Balance accounts are components of a multi-currency account that hold currency balances and transaction ledgers. The API supports different balance types, primarilySTANDARDandSAVINGS(jars). To operate on a balance via the API, theinvestmentStatefield must beNOT_INVESTED. If a balance has any other investment state, it is considered un-operable and should be displayed as such in integrations.Overview of Wise Client Credentials Tokens
Client credentials tokens provide partner accounts with application-level access to the Wise Platform API for requests that are not tied to a specific Wise user. Common use cases include creating application webhook subscriptions, creating user resources during onboarding for correspondent/enterprise partners, creating un-authenticated quotes, and setting spend controls on issued cards.Overview of JSON Web Signature (JWS) in Wise Platform
Wise uses the JOSE JWS standard to digitally sign JSON content, ensuring sender identity and message integrity (non-repudiation). The general workflow is: 1. Create a key pair and provide the public key to Wise. 2. Call JWS-enabled endpoints with signed request bodies. 3. Wise verifies the signature and URL validity. 4. Wise returns an encoded and signed response. 5. The client verifies and decodes the response.