Withdraw Apply
Request Method and Path
POST /payout/v1/withdraw/apply
| Field Name | Type | Required | Description |
|---|
| content-type | string | Yes | application/json |
| x-api-key | string | Yes | Provided by Paydify, same as appId |
| x-api-timestamp | string | Yes | Timestamp in milliseconds |
| x-api-signature | string | Yes | Signature, see Signature Algorithm |
Request Body
| Field Name | Type | Required | Description |
|---|
| mchWithdrawId | string | Yes | Merchant order ID, must be unique |
| amount | string | Yes | Withdrawal amount, max 2 decimal places |
| currency | string | Yes | Withdrawal currency, e.g., USDT, USDC |
| network | string | Yes | Chain information, see Supported Chains and Currencies |
| address | string | Yes | Withdrawal address |
| memo | string | No | Memo/remark |
| merchantId | string | No | Merchant ID of the withdrawal owner (sub-merchant). Required when calling with a partner credential on behalf of a sub-merchant; can be omitted with a merchant-owned credential (defaults to the credential owner). Max 64 characters |
| merchantAppId | string | No | App ID under the owner merchant, used for disambiguation when the owner merchant has multiple authorized apps. Required if the credential covers multiple apps of the owner merchant; can be omitted when only one app is authorized (resolved automatically). Max 64 characters |
| Field Name | Type | Required | Description |
|---|
| x-api-key | string | Yes | Provided by Paydify, same as appId |
| x-api-timestamp | string | Yes | Timestamp in milliseconds |
| x-api-signature | string | Yes | Signature, see Signature Algorithm |
Response
| Field Name | Type | Description |
|---|
| code | string | Response code, SYS_SUCCESS indicates success |
| message | string | Response message |
| messageDetail | string | Detailed response message |
| success | boolean | Whether the request was successful |
| data.withdrawTxnId | string | Paydify withdrawal order ID |
| data.mchWithdrawId | string | Merchant-side payout order ID |
| data.state | string | Withdrawal state, initially PENDING |
Example
# Request
{
"mchWithdrawId": "MCH_WD_1756287002",
"amount": "100.00",
"currency": "USDT",
"network": "trx",
"address": "TXxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"memo": "merchant withdraw"
}
# Successful response
{
"code": "SYS_SUCCESS",
"message": null,
"messageDetail": null,
"data": {
"withdrawTxnId": "W1167515578018041857",
"mchWithdrawId": "MCH_WD_1756287002",
"state": "PENDING"
},
"success": true
}
# Failed response
{
"code": "SYS_ERROR",
"message": "System error",
"messageDetail": "Error details",
"data": null,
"success": false
}
