API Reference

Create a withdraw request

post
https://platform-api.sandbox.testessential.net/wallet/withdraw

Submits a request to withdraw funds, supporting wallet-to-wallet transfers (send by wallet), IBAN withdrawals and transfers via mobile phone numbers.

Query Params
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.

boolean

enable automatic currency conversion.

Body Params
string
required

currency of the withdrawal in ISO 4217 format, for IBAN withdrawal only euro is available.

string
required

the amount of money being withdrawn.

conversion
array of objects

conversion parameters.

conversion
string
required

the type of withdrawal.

meta
object

arbitrary json object.

string
required

the ID of the source account of type CHECKING for for CRYPTO and CRYPTO_BY_PHONE operations or type BANK_ACCOUNT_VIRTUAL for BANK_TRANSFER operations.

string
string

IBAN number for the bank transfer.

string

BIC or SWIFT code of the bank.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 5 months ago