logo

Search...

⌘ K

English

Product Guide
API Reference
Resource Download
Help Center

Payin

Payment

Create Payment

POST

Query Payment Status

POST

Refund

Create Refund

POST

Query Refund Status

POST

Settlement

Get Settlement Files

POST

Deposit

Batch Create VA Clients

POST

Batch Update VA Clients

POST

Query VA Client Deposits

POST

Webhook

Payment Notification

POST

Refund Notification

POST

Deposit Notification

POST

Exchange Rate

Get Exchange Rate Quote

POST

Payout

Wallet

Query Wallet Address

POST

Query Wallet Balance

POST

Withdraw

Withdraw Apply

POST

Withdraw Detail

POST

Fiat Withdraw

Quote

POST

Apply

POST

Cancel

POST

List

POST

Detail

POST

Batch

Batch Withdraw Apply

POST

Batch Withdraw Query

POST

Webhook

Withdraw Notification

POST

Fiat Withdraw Notification

POST

Query Order List

POST

/payout/v1/fiat-withdraw/list

Query fiat withdraw orders with filters and pagination.

Request

Header Parameters

content-type

string

REQUIRED

Fixed value: application/json

x-api-key

string

REQUIRED

Provided by Paydify, same as appId

x-api-timestamp

string

REQUIRED

Timestamp in milliseconds

x-api-signature

string

REQUIRED

Signature, see the signature algorithm

Body

withdrawOrderId

string

Filter by withdraw order ID

mchOrderId

string

Filter by merchant order ID

status

string

Filter by status

startTime

string

Start time (ISO 8601)

endTime

string

End time (ISO 8601)

pageNo

int

Page number

pageSize

int

Page size

merchantId

string

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

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

Response

Body

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

object

pageInfo

object

currentPage

integer

Current page number

pageSize

integer

Page size

totalPages

integer

Total pages

totalCount

string

Total record count (may be returned as a numeric string)

hasNext

boolean

Has next page

hasPrevious

boolean

Has previous page

list

object[]

withdrawOrderId

string

Withdraw order ID

status

string

Status

quoteMode

string

Quote mode

feeAmountFiat

string

Fee amount in fiat

chargeAmountFiat

string

Total charge amount in fiat

deductionSnapshot

object

deductionPlan

object[]

assetCode

string

Deduction asset code (e.g. USDC/USDT)

currency

string

Legacy field; same meaning as assetCode

deductAmount

string

Amount deducted for this asset

principalAmount

string

Principal portion

feeAmount

string

Fee portion

sequence

integer

Deduction priority (lower = higher priority)

withdrawAmount

string

Withdraw amount

withdrawCurrency

string

Withdraw currency

arrivalAmount

string

Arrival amount

arrivalCurrency

string

Arrival currency

createdAt

string

Created time (ISO 8601)

merchantId

string

Merchant ID the withdrawal belongs to (sub-merchant)

SHELL
SHELL
JAVA
JAVA
PYTHON
PYTHON
GO
GO
NODEJS
NODEJS
1
REQUEST

Use sandbox API credentials only. Do not paste production secrets in the browser.

Base URL

https://api.paydify-sandbox.com/crypto-payment

Parameters

Body

RESPONSE

Click the Send API Request button above and see the response here!