Use the Wise direct debits API to pull funds from a UK or European bank account to fund your transfers.
This guide provides step-by-step instructions for integrating with the direct debit API, from creating a payment instrument to managing transfers and webhooks.
To fund a transfer using direct debit, you need to work with two primary resources: Payment Instruments and Payins.
- A Payment Instrument is a saved pre-authorised funding source, such as a bank account, from which you can pull funds.
- A Payin is the request you initiate to pull a specific payment from that instrument.
The Direct Debit API uses the paymentInstrumentId and the payinSessionId from a new transfer to create a new Payin. Once the direct debit payin is received, the associated transfer is funded. The funds are never shown as a credit on your balance and are used immediately.
Follow these steps to implement direct debits via the API.
- Create the Payment Instrument: Send a request to
POST /v3/profiles/{{profileId}}/payment-instrumentsto initiate the authorization flow for a new funding source. - Connect the Payment Instrument: Send a request to
POST /v3/profiles/{{profileId}}/payment-instruments/{{paymentInstrumentId}}/manual-confirmationto confirm the payment instrument's details are correct.- This leads to a
CONNECTEDPayment Instrument, which then supports the submission of new Payins
- This leads to a
- Create a transfer: As with any process to send money on Wise Platform - you must create a quote, and then create a transfer using
POST /v1/transfers.- Capture the
payinSessionIdfrom the response you receive.
- Capture the
- Create a Payin: Send a request, including the
payinSessionId, toPOST /v3/profiles/{{profileId}}/payment-instruments/{{paymentInstrumentId}}/payins.- Once this payin is complete, the transfer is funded and your money is sent to the transfer recipient.
- Check status: Send a
GETrequest for either a payment instrument or a payin to retrieve its status at any time.