Skip to main content

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:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

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​

FieldTypeDescription
previewIdstring (uuid)Optional. The preview ID from a previous preview request.
referencestringRequired. A unique client reference for the withdrawal. Min 1, max 255 characters.
descriptionstringRequired. A description for the withdrawal. Min 1, max 255 characters.
accountIdstring (uuid)Required. The account ID to withdraw from.
counterpartyIdstring (uuid)Required. The counterparty ID to withdraw to.
amountstring (decimal)Required. The amount to withdraw. Minimum: 20.00.
amountCurrencystringRequired. The currency code. Example: USD, MXN, BRL.

Response Sample​

{
"id": "00000000-0000-0000-0000-000000000000"
}

Response Schema​

FieldTypeDescription
idstring (uuid)The transaction ID for the withdrawal.

Errors​

StatusMessageMeaning
400account_id_requiredThe request names no account: a workspace-scoped key must send accountId.
403account_frozenThe account is frozen or blocked.
404counterparty_not_foundNo counterparty of this account has this counterpartyId.
409banking_operation_unsupportedThe workspace's bank does not make withdrawals.
409bank_account_not_openedThe account's bank account was never opened. See Open Bank Account.
422counterparty_incompleteThe counterparty has no account number, which ACH and domestic wire need. Update it, then retry.

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:

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!