Preview Withdrawal
This endpoint allows you to preview a banking withdrawal without executing it. It returns estimated fees and other withdrawal details.
The payment instrument type is determined automatically from the counterparty's configured instrumentType and wireType.
Authorization:
bearer
HTTP: bearer
HTTP Authorization Scheme: bearer
Headers:
Authorization: APIKey {YOUR_API_KEY}
Endpoint
POST
/api/v2/banking/withdrawal-preview
Request Body Sample
{
"accountId": "00000000-0000-0000-0000-000000000000",
"counterpartyId": "00000000-0000-0000-0000-000000000000",
"amount": "100.00",
"amountCurrency": "USD"
}
Request Body Schema
| Field | Type | Description |
|---|---|---|
accountId | string (uuid) | Required. The account ID to withdraw from. |
counterpartyId | string (uuid) | Required. The counterparty ID to withdraw to. |
amount | string (decimal) | Required. The amount to withdraw. Minimum: 20.00. |
amountCurrency | string | Required. The currency code. Example: USD, MXN, BRL. |
Response Sample
{
"id": "00000000-0000-0000-0000-000000000000",
"amount": "100.00",
"amountCurrency": "USD",
"estimateFee": "1.00",
"feeCurrency": "USD",
"estimateTotal": "99.00",
"totalCurrency": "USD",
"createdAt": "2023-01-01T00:00:00Z",
"expiresAt": "2023-01-01T00:15:00Z",
"instrumentType": "ach"
}
Response Schema
| Field | Type | Description |
|---|---|---|
id | string (uuid) | The preview ID. Use this to execute the withdrawal. |
amount | string (decimal) | The withdrawal amount. |
amountCurrency | string | The currency of the withdrawal. |
estimateFee | string (decimal) | The estimated fee for the withdrawal. |
feeCurrency | string | The currency of the fee. |
estimateTotal | string (decimal) | The total amount after fees. |
totalCurrency | string | The currency of the total. |
createdAt | string (datetime) | When the preview was created. |
expiresAt | string (datetime) | When the preview expires. |
instrumentType | string | The instrument type used for the withdrawal (derived from the counterparty). |
Support and Resources
If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.
Stay Updated
Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:
- Instagram: BlockWyre Instagram
- Twitter: BlockWyre Twitter
- Facebook: BlockWyre Facebook
- LinkedIn: BlockWyre LinkedIn
We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!