Skip to main content
POST
/
api
/
v1
/
withdraw
Create Withdrawal
curl --request POST \
  --url https://sandbox.oumla.com/api/v1/withdraw \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "to": "<string>",
  "amount": "<string>",
  "from": [
    "<string>"
  ],
  "network": "BTC",
  "clientShare": "<string>"
}
'
{
  "message": "<string>",
  "success": true,
  "status": 123,
  "data": {}
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Headers

​
x-sdk-version
string
default:1.0.0

SDK version for tracking and compatibility

Body

application/json
​
to
string
required

Recipient address for withdrawal

​
amount
string
required

Withdrawal amount

​
from
string[]
required

Array of source addresses for withdrawal

​
network
enum<string>
required

Blockchain network

Available options:
BTC,
tBTC,
ETH,
tETH
​
clientShare
string
required

Client share for signing

Response

201 - application/json

Withdrawal created successfully

​
message
string
required

Response message

​
success
enum<boolean>
required

Indicates successful response

Available options:
true,
false
​
status
integer
required

HTTP status code

​
data
object

Response data