Withdraw
This API allows you to submit a request to withdraw funds from your account. You can choose from different withdrawal types based on how the funds should be sent. The available withdrawal types are:
- BANK_TRANSFER (IBAN)
- CRYPTO
Each withdrawal type requires different parameters. Below, you'll find a description of the parameters for each withdrawal type.
Query Parameters
Parameter | Type | Description |
---|---|---|
dryRun | boolean | If true , the API simulates the operation without executing it. This allows you to preview exchange rates, fees, and other details before committing. The actual withdrawal will only proceed if dryRun is omitted or explicitly set to false . |
autoConversion | boolean | If set to true , enables automatic currency conversion. |
Body Parameters
BANK_TRANSFER (IBAN)
The BANK_TRANSFER withdrawal type allows you to send funds to an external bank account via IBAN. The recipient’s IBAN and SWIFT/BIC code are required.
Field | Type | Required | Description |
---|---|---|---|
currency | string | Yes | The currency to withdraw — only euro is available. |
amount | string | Yes | The amount to withdraw in the specified currency. |
fromAccount | string | Yes | The source account ID (of type BANK_ACCOUNT_VIRTUAL) for the withdrawal. |
iban | string | Yes | The recipient's IBAN number. |
bicOrSwiftCode | string | Yes | The BIC or SWIFT code of the recipient's bank. |
rate | object | No | The exchange rate for currency conversion. |
CRYPTO Withdrawal
The CRYPTO withdrawal type allows you to withdraw funds to a cryptocurrency wallet. Specify the recipient's wallet address and the blockchain.
Field | Type | Required | Description |
---|---|---|---|
currency | string | Yes | The currency to withdraw (cryptocurrency). |
amount | string | Yes | The amount to withdraw in cryptocurrency. |
conversion | array | No | An array of conversion objects for currency exchange. |
fromAccount | string | Yes | The account from which funds will be withdrawn. |
to | string | Yes | The recipient’s wallet address. |
blockchain | string | Yes | The blockchain to use for the withdrawal. |
rate | object | No | The exchange rate for currency conversion. |
Best Practices
-
Validate Inputs:
Ensure that all mandatory fields (such as amount, currency, and withdrawal type) are properly validated before submitting the request. -
Currency Validation:
Double-check that the specified currency is supported for each type of withdrawal. -
Use
dryRun
:
Use thedryRun
parameter to simulate the withdrawal request without actually performing the operation. This can be useful for testing and verifying the process.
Conclusion
The Create a Withdraw Request endpoint allows you to initiate different types of withdrawals from your account. By specifying the correct withdrawal type and parameters, you can transfer funds to bank accounts and cryptocurrency wallets. Always ensure that inputs are properly validated and that you handle errors appropriately.
If you have any questions or issues, please refer to the API documentation or contact support for further assistance.
Updated 13 days ago