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

Fiat Withdraw

The Paydify Fiat Withdraw API allows merchants to convert crypto assets (e.g. USDC/USDT) into fiat currency and withdraw to a designated bank account.

Key Features

  • Quote Preview: Get real-time exchange rates, fees, and deduction plans with no side effects
  • Apply Withdrawal: Create a withdrawal order based on a quote session, with idempotency support
  • Order Query: Query withdrawal records by order ID, status, or time range with pagination
  • Order Detail: Retrieve full details of a single withdrawal order
  • Cancel Withdrawal: Cancel a withdrawal before processing, naturally idempotent

Integration Flow

A typical fiat withdrawal flow:

1. Quote Preview

Call POST /payout/v1/fiat-withdraw/quote to get a quote. Two quote modes are supported:

  • ARRIVAL: Specify the arrival amount in fiat; the system calculates the crypto deduction
  • DEDUCT_ASSET: Specify the crypto deduction amount; the system calculates the fiat arrival amount

The returned quoteId has an expiry (see expireAt field) and must be used before it expires.

2. Apply Withdrawal

Call POST /payout/v1/fiat-withdraw/apply with:

  • mchOrderId: Merchant order ID, used as an idempotency key — the same mchOrderId will not create duplicate orders
  • quoteId: The quote session ID returned from the quote preview

The order is created with PENDING status and processed asynchronously.

3. Query Order Status

  • List Query: POST /payout/v1/fiat-withdraw/list — filter by status, time range, or order ID with pagination
  • Detail Query: POST /payout/v1/fiat-withdraw/detail — query a single order by withdrawOrderId or mchOrderId

4. Cancel Withdrawal

Call POST /payout/v1/fiat-withdraw/cancel with withdrawOrderId. Only orders in PENDING status can be cancelled.

Order Status

Status Description
PENDING Withdrawal created, awaiting processing
PROCESSING Being processed
SETTLING Settlement in progress
COMPLETED Withdrawal complete, funds arrived
CANCELLED Cancelled
REJECTED Rejected (see rejectionReason)
FAILED Withdrawal failed (see failureReason)

Authentication

All fiat withdraw endpoints use the same authentication mechanism as Payin/Payout. See Signature Algorithm.

API Endpoints

Endpoint Description
/payout/v1/fiat-withdraw/quote Quote Preview
/payout/v1/fiat-withdraw/apply Apply Withdrawal
/payout/v1/fiat-withdraw/cancel Cancel Withdrawal
/payout/v1/fiat-withdraw/list Query Order List
/payout/v1/fiat-withdraw/detail Query Order Detail

Catalogue