Skip to main content
POST
/
v1
/
accounts
/
{account_id}
/
funds
/
withdrawals
curl
curl -X POST "https://api.services.payward.com/v1/accounts/W4BE9868GY65TB6523/funds/withdrawals" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -d '{
    "asset_symbol": "BTC",
    "asset_type": "crypto",
    "key": "wa_01J0M7C0Z9F8YX3GQH8E",
    "amount": "1.23"
  }'
{
  "data": {
    "ref_id": "WD-01J0M7C0Z9F8YX3GQH8E",
    "amount": "0.50000000",
    "fee": "0.00050000",
    "total": "0.50050000",
    "fee_token": null
  }
}

Authorizations

​
API-Key
string
header
required

Your public API key. Identifies the partner making the request.

​
API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

​
API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Headers

​
Idempotency-Key
string<uuid>

Client-generated UUIDv4 for safe retries. Sent as the Idempotency-Key HTTP header. Replayed responses include the Idempotent-Replayed: true header.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

​
account_id
string
required

ID of the account the request applies to. This refers to one of the accounts held by the user the request is acting on behalf of (typically the user's main account, but any of the user's accounts is accepted). Routes the request to that specific account container. Canonical identifier for an account in the Payward public API.

Required string length: 14 - 42

Body

application/json
​
asset_symbol
string
required

Ticker symbol of the asset to withdraw.

Required string length: 3 - 16
Example:

"BTC"

​
key
string
required

Saved withdrawal address key

​
amount
string<decimal128>
required

Amount to withdraw

Required string length: 1 - 64
Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"1.23"

​
asset_type
enum<string>
default:crypto

Classification of the asset. Pair with asset_symbol to disambiguate when the same ticker exists across asset classes. Defaults to crypto.

Available options:
fiat,
crypto,
stablecoin,
xstock
​
fee_token
string | null

Fee token from GET /b2b/funds/withdrawals/methods, guarantees the quoted fee for 10 minutes.

​
preview
boolean
default:false

When true, only returns quoted amount, fee, and total; no withdrawal is created.

Response

Response

​
data
object
required