Execute Withdrawal

This endpoint executes a banking withdrawal. Use the preview ID from the Preview Withdrawal endpoint or provide the withdrawal details directly.

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

Request Body Sample

{
  "previewId": "00000000-0000-0000-0000-000000000000",
  "reference": "client-reference-123",
  "description": "Payment for services",
  "accountId": "00000000-0000-0000-0000-000000000000",
  "counterpartyId": "00000000-0000-0000-0000-000000000000",
  "amount": "100.00",
  "amountCurrency": "USD"
}

Request Body Schema

Field	Type	Description
previewId	string (uuid)	Optional. The preview ID from a previous preview request.
reference	string	Required. A unique client reference for the withdrawal. Min 1, max 255 characters.
description	string	Required. A description for the withdrawal. Min 1, max 255 characters.
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"
}

Response Schema

Field	Type	Description
id	string (uuid)	The transaction ID for the withdrawal.

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!