Skip to main content

Payout

HTTP Request

POST /v5/bybitpay/payout

Request Parameters

ParameterRequiredTypeComments
merchantIdtruestringOnboarding merchant UID
merchantNamefalsestringIf not filled in, we will show users the name of your company doing KYB on the Bybit platform
clientIdfalsestringMerchant client ID
paymentTypetruestringPayment Type
merchantTradeNotruestringMerchant Order Number
amounttruestringOrder Amount
currencytruestringOrder Currency (uppercase, e.g., EUR, USD, USDT)
currencyTypetruestringCurrency Type (fiat or crypto)
combinedfalseboolWhether combined payment is supported (true or false), default false. e.g.: When merchant's USDT assets are insufficient for the order amount, can BTC or other cryptocurrency assets be exchanged for USDT
webhookUrlfalsestringAPI URL to call when order is successful or failed (max 256 characters)
payeetrue<PayeeType>Bybit payee
envtrue<EnvType>Transaction source
riskInfofalse<RiskInfoType>Risk info for order pay
mccCodetruestringMerchant category codes, ISO 18245:2023

Response Parameters

ParameterTypeComments
order<PayOrderType>Bybit PayOrder Detail

Request Example

Basic Payout (USDT)

POST /v5/bybitpay/payout HTTP/1.1
Host: api2.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1736233200000
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

{
"merchantId": "305142568",
"merchantName": "Digital Rewards Platform",
"clientId": "client_001",
"paymentType": "MERCHANT_PAYOUT",
"merchantTradeNo": "PO-2026-0001",
"amount": "100.00",
"currency": "USDT",
"currencyType": "crypto",
"mccCode": "5816",
"payee": {
"uid": "104326789"
},
"webhookUrl": "https://www.merchant.com/webhook/payout",
"env": {
"terminalType": "WEB",
"device": "payout-service",
"browserVersion": "Server/1.0",
"ip": "10.0.1.100"
},
"riskInfo": {
"terminalType": "WEB"
}
}

Payout with Combined Payment (Multi-currency)

POST /v5/bybitpay/payout HTTP/1.1
Host: api2.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1736233200000
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

{
"merchantId": "305142568",
"merchantName": "Digital Rewards Platform",
"paymentType": "MERCHANT_PAYOUT",
"merchantTradeNo": "PO-2026-0002",
"amount": "5000.00",
"currency": "USDT",
"currencyType": "crypto",
"combined": true,
"mccCode": "5816",
"payee": {
"uid": "104326790"
},
"webhookUrl": "https://www.merchant.com/webhook/payout",
"env": {
"terminalType": "WEB",
"device": "payout-service",
"browserVersion": "Server/1.0",
"ip": "10.0.1.100"
}
}

Response Example

Payout Created Response

{
"retCode": 100000,
"retMsg": "success",
"result": {
"order": {
"merchantId": "305142568",
"clientId": "client_001",
"paymentType": "MERCHANT_PAYOUT",
"merchantTradeNo": "PO-2026-0001",
"payId": "01JY2KM5QNPXR8S4HTJZT9PO01",
"status": "INIT",
"amount": "100.00",
"currency": "USDT",
"currencyType": "crypto",
"createTime": 1736233200,
"paymentTime": 0,
"finishTime": 0,
"refundOrders": []
}
}
}

Payout Success Response (via webhook or query)

{
"retCode": 100000,
"retMsg": "success",
"result": {
"order": {
"merchantId": "305142568",
"clientId": "client_001",
"paymentType": "MERCHANT_PAYOUT",
"merchantTradeNo": "PO-2026-0001",
"payId": "01JY2KM5QNPXR8S4HTJZT9PO01",
"status": "PAY_SUCCESS",
"amount": "100.00",
"currency": "USDT",
"currencyType": "crypto",
"createTime": 1736233200,
"paymentTime": 1736233260,
"finishTime": 1736233260,
"refundOrders": []
}
}
}