logo

Search...

⌘ K

English

Product Guide
API Reference
Resource Download
Help Center

Getting Started

Overview

Scenario Capabilities

Onboarding Steps

Payin Capabilities

CKP Checkout Page

Interaction

Integration Prep

Integration Steps

Deeplink Redirect

Interaction

Integration Prep

Integration Steps

QRCode Display

Interaction

Integration Prep

Integration Steps

Payout Capabilities

Capability Overview

Deposit

Crypto Withdraw / Payout

Fiat Withdraw

Receive Payout Result

Supported Chains and Currencies

Supported Chains

Supported Currencies

Appendix

Wallets / Currencies / Chains

Transaction Status

Payment Status

Refund Status

Withdraw Status

Batch Status

Error Code Description

Signature Algorithm

Query Withdraw Detail

Request Method and Path

POST /payout/v1/withdraw/detail

Request Headers

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
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)
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

Response Headers

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 order ID
data.mid string Merchant ID
data.appId string Provided by Paydify
data.currency string Withdrawal currency: USDT, USDC
data.network string Withdrawal chain information
data.address string Withdrawal address
data.txnHash string On-chain transaction hash
data.status string Withdrawal status, enum values see Withdraw Status
data.amount string Withdrawal amount
data.gasFee string Gas fee
data.processingFee string Processing fee
data.processingFeeRate string Fee rate (e.g., 0.01 means 1%)
data.totalDeductedAmount string Total deducted amount (amount + gas + fee)
data.memo string Withdrawal memo
data.createTime string Creation timestamp in milliseconds
data.finishTime string Completion timestamp in milliseconds
data.errorCode string Error code, see Error Codes
data.errorMsg string Error message

Example

# Request
{
  "mchWithdrawId": "MCH_WD_1756287002"
}

# Successful response
{
  "code": "SYS_SUCCESS",
  "message": null,
  "messageDetail": null,
  "data": {
    "withdrawTxnId": "W1167515578018041857",
    "mchWithdrawId": "MCH_WD_1756287002",
    "mid": "M10001",
    "appId": "A1111",
    "currency": "USDT",
    "network": "trx",
    "address": "TXxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "txnHash": "0xabcdef1234567890",
    "status": "SUCCESS",
    "amount": "100.00",
    "gasFee": "0.50",
    "processingFee": "1.00",
    "processingFeeRate": "0.01",
    "totalDeductedAmount": "101.50",
    "memo": "merchant withdraw",
    "createTime": "1756697092000",
    "finishTime": "1756725871000",
    "errorCode": "",
    "errorMsg": ""
  },
  "success": true
}

# Failed response
{
  "code": "SYS_ERROR",
  "message": "System error",
  "messageDetail": "Error details",
  "data": null,
  "success": false
}

Catalogue