curl --request POST \
--url https://api.services.payward.com/v1/accounts/{account_id}/funds/withdrawals \
--header 'API-Key: <api-key>' \
--header 'API-Nonce: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": {
"method_id": "fb3ec7fd-3280-4142-ae14-708b995bedef"
},
"destination": {
"type": "funding_address",
"address_id": "AB12345-6789A-BCDEFG"
},
"symbol": "EUR",
"amount": "10.00"
}
'{
"data": {
"withdrawal_id": "FTSBuuG-9BctU4m3Emt88submmZVKY",
"net_amount": {
"symbol": "EUR",
"name": "Euro",
"type": "fiat",
"amount": "9.50"
},
"gross_amount": {
"symbol": "EUR",
"name": "Euro",
"type": "fiat",
"amount": "10.00"
},
"fee": {
"symbol": "EUR",
"name": "Euro",
"type": "fiat",
"amount": "0.50"
}
}
}Create withdrawal
Creates a fiat or cryptocurrency withdrawal from the selected account to a registered funding address or a supported linked bank account.
curl --request POST \
--url https://api.services.payward.com/v1/accounts/{account_id}/funds/withdrawals \
--header 'API-Key: <api-key>' \
--header 'API-Nonce: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": {
"method_id": "fb3ec7fd-3280-4142-ae14-708b995bedef"
},
"destination": {
"type": "funding_address",
"address_id": "AB12345-6789A-BCDEFG"
},
"symbol": "EUR",
"amount": "10.00"
}
'{
"data": {
"withdrawal_id": "FTSBuuG-9BctU4m3Emt88submmZVKY",
"net_amount": {
"symbol": "EUR",
"name": "Euro",
"type": "fiat",
"amount": "9.50"
},
"gross_amount": {
"symbol": "EUR",
"name": "Euro",
"type": "fiat",
"amount": "10.00"
},
"fee": {
"symbol": "EUR",
"name": "Euro",
"type": "fiat",
"amount": "0.50"
}
}
}Authorizations
Your public API key. Identifies the partner making the request.
HMAC signature over the request, computed with your private key.
Monotonically increasing nonce included in the request signature.
Headers
Client-generated canonical UUIDv4 that uniquely identifies a request for safe retries.
^[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}$"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
Globally unique public identifier for an account.
14 - 42Body
Funding scope, destination, asset symbol, gross amount, and optional fee quote token for a withdrawal.
Method or network scope used for the withdrawal.
Show child attributes
Show child attributes
Destination selected for the withdrawal.
- Funding address
- Account link
Show child attributes
Show child attributes
Public asset symbol to withdraw. Fiat, crypto, and stablecoin assets are supported in this operation.
1 - 16Gross amount debited from the selected account, including the fee, represented as a string to preserve precision.
1 - 64^[0-9]+(\.[0-9]+)?$Fee token from Calculate funding fees whose fee terms this withdrawal should reuse. Requires scope.method_id for the quoted method. A different amount changes the fee charged; use the quoted amount to reproduce its fee. Omit to calculate the fee at creation. Treat this value as sensitive and do not inspect or modify it.
1 - 2000Response
Withdrawal created for the selected account.
Withdrawal created for the selected account.
Created withdrawal.
Show child attributes
Show child attributes