Respond to a drawdown request
When a bank receives a drawdown request , it responds by wiring the money that was asked for to the specified bank account.
In this tutorial, you'll learn how to:
✅ Respond to a drawdown request
If you are new to wires we recommend you read the Wires documentation before starting this tutorial.
The tutorial assumes you have a knowledge of APIs and how they work. For more information on sending API calls, see the API overview.
For this tutorial you'll need to understand these terms. These definitions are specific to this tutorial. The terms might be used slightly differently for a drawdown request.
Term | Description |
|---|---|
Originator | The entity sending the payment |
Beneficiary | The entity receiving the payment |
Sending financial institution | The financial institution that initiates the drawdown response |
Receiving financial institution | The financial institution that receives the wire |
Drawdown request | A request for someone to send a payment by wire |
The tutorial uses these API endpoints
API | Description |
|---|---|
Respond to a drawdown request by sending payment |
The tutorial uses these webhooks:
Webhook | Description |
|---|---|
Wire.Payment.Sent | Outbound wire has been transmitted to the Federal Reserve and has been successfully acknowledged. IMAD number is now available. |
Wire.Payment.Received | Inbound wire payment received successfully. |
Wire.Payment.Rejected | Outbound wire could not be processed due to compliance reasons or was rejected by the Federal Reserve. |
Make sure you have:
- Beneficiary reference ID
- Inbound drawdown request
To receive the webhook events for this tutorial both partner accounts need to register each specific webhook event type. Once you are registered, the event objects are sent to the registered URLs.
The event object contains a list of resource identifiers used to download details on each event.
In this tutorial you will respond to a drawdown request from Mastercard for 12,480,981.47 USD. An incoming drawdown request looks like the code sample below.
Call POST /v1/payments/{id}/drawdown-responses. For this call, some/all attributes are required. A full list of attributes is found here.
The id attribute must be set to the payment ID of the request that came in. In this case, 5beea7ed-e9a1-4914-9bdc-af7100eb4dbd.
A successful API call returns a JSON response with the details of the payment sent. From this point, the payment behaves like any outbound wire payment.
