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:

ATM
BANK_TRANSFER (IBAN)
CRYPTO
PAY_SPOT
COUNTERPARTY

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 set to `true`, simulates the request without performing the actual withdrawal.
`autoConversion`	boolean	If set to `true`, enables automatic currency conversion.

Body Parameters

ATM Withdrawal

The ATM withdrawal type allows you to withdraw funds via an ATM. You need to provide the ATM ID and creditor account details.

Field	Type	Required	Description
`currency`	string	Yes	The currency to withdraw.
`amount`	string	Yes	The amount to withdraw in the specified currency.
`conversion`	array	No	An array of conversion objects for currency exchange.
`fromAccount`	string	Yes	The account from which funds will be withdrawn.
`externalTransactionId`	string	No	An external transaction ID for reference.
`atmId`	string	Yes	The ATM ID where the funds are being withdrawn.
`creditorAccountId`	string	Yes	The creditor’s account ID.
`rate`	object	No	The exchange rate for currency conversion.

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.
`amount`	string	Yes	The amount to withdraw in the specified currency.
`conversion`	array	No	An array of conversion objects for currency exchange.
`fromAccount`	string	Yes	The account from which funds will be withdrawn.
`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.

PAY_SPOT Withdrawal

The PAY_SPOT withdrawal type is used to send funds to a specific beneficiary account (e.g., for a bank transfer).

Field	Type	Required	Description
`currency`	string	Yes	The currency to withdraw.
`amount`	string	Yes	The amount to withdraw.
`conversion`	array	No	An array of conversion objects for currency exchange.
`fromAccount`	string	Yes	The account from which funds will be withdrawn.
`beneficiaryAccountNumber`	string	Yes	The beneficiary’s account number.
`beneficiaryName`	string	Yes	The beneficiary’s name.
`paymentCode`	int32	Yes	The payment code.
`paymentPurpose`	string	Yes	The purpose of the payment.
`modul`	string	Yes	The payment module.
`rate`	object	No	The exchange rate for currency conversion.

COUNTERPARTY Withdrawal

The COUNTERPARTY withdrawal type allows you to transfer funds to another user or counterparty. You must provide the counterparty's ID.

Field	Type	Required	Description
`currency`	string	Yes	The currency to withdraw.
`amount`	string	Yes	The amount to withdraw.
`conversion`	array	No	An array of conversion objects for currency exchange.
`fromAccount`	string	Yes	The account from which funds will be withdrawn.
`counterPartyId`	string	Yes	The counterparty ID.
`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 the dryRun 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 API allows you to initiate various types of withdrawals from your account. By specifying the correct withdrawal type and parameters, you can transfer funds to ATMs, bank accounts, cryptocurrency wallets, and more. 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.