Fiat Payout

This page describes terminal notifications for fiat payout orders. A successful create response means the request was accepted; use the webhook or query endpoint for the final result.

Notifications are sent by HTTP POST. Follow the setup and retry guidance, verify signatures, process notifications idempotently, and return HTTP 200. This payload is distinct from the query API response.

Notify body

Parameter	Type	Description
partner_id	String	Partner account ID allocated by MusePay.
customer_ref_id	String	Customer reference, when available.
order_no	String	MusePay order ID.
request_id	String	Order reference supplied by the partner.
order_type	String	Transaction type; see Order Type.
product_code	String	Transaction product code.
currency	String	Currency code reported for the order.
order_amount	String	Requested order amount.
pay_amount	String	Actual payment amount.
fee_amount	String	Service fee amount.
settle_currency	String	Settlement currency code.
actual_amount	String	Net settlement amount in settle_currency.
finish_time	String	Order update time at notification, expressed as a Unix millisecond timestamp string.
status	Number	Terminal order status: 99 (success), 44 (failed), or 88 (closed). See Order Status.
reason	String	Failure or closure reason, when available.
extra_info	JSON String	JSON-encoded string containing optional order-specific fields.
sign	String	Base64-encoded signature; see Webhook setup.

Amounts are decimal strings. The payout payment amount and fiat settlement amount can use different currencies; actual_amount is denominated in settle_currency and must not be directly subtracted from pay_amount.

Extra Info

extra_info is a JSON string and must be parsed separately. All fields below are optional and depend on the order data; empty-string fields are omitted. Field names are case-sensitive.

Common fields

Parameter	Type	Description
payType	String	Payment type.
paymentMethod	String	Payment method associated with the order.
productName	String	Product name supplied for the payment.
customerRefId	String	Customer reference supplied by the partner.
description	String	Description supplied with the request.
remark	String	Order remark.
email	String	Email associated with the order.
exchangeRate	String	Exchange rate recorded for the order; interpret it with the order currency pair.
symbol	String	Currency pair associated with the exchange rate.
rateTime	Number	Exchange-rate timestamp in Unix milliseconds.

Payout and account fields

Parameter	Type	Description
country	String	Country associated with the payout.
payerAccount	String	Payer account.
payerAccountName	String	Payer account holder name.
payerBankSwiftCode	String	Payer bank SWIFT code.
beneficiaryName	String	Beneficiary name.
beneficiaryBankCode	String	Beneficiary bank code.
beneficiaryWallet	String	Beneficiary wallet identifier.
beneficiaryAccountNumber	String	Beneficiary account number.
beneficiaryAccountType	String	Beneficiary account type.
beneficiaryEmail	String	Beneficiary email.
beneficiaryPhoneAreaCode	String	Beneficiary phone country/area code.
beneficiaryPhone	String	Beneficiary phone number.
documentId	String	Identity document number recorded for the order.
documentType	String	Identity document type recorded for the order.
bankRoutingCode	String	Bank routing code.
userInfo	Object	Additional information associated with the fiat payout. Keys and values are strings; contents vary by payout and the object may be empty.