Create Fiat Payout
Every request must contain common parameters.
Confirms a valid payout quote and starts payout processing.
POST /v1/fiatpayout/payouts/create
Request Body
purpose_code
String
Yes
Remittance purpose code. Preserve leading zeroes.
description
String
No
Payout description or reference. Do not include sensitive information.
The quote must belong to the requesting partner_id, must not be expired, and must still be in its initial state. A quote can be confirmed only once; repeated confirmation is rejected.
Request Example
{
"order_no": "ORDER-1",
"purpose_code": "02",
"description": "monthly support"
}Response Body
order_no
String
Payout order number generated by MusePay.
request_id
String
Identifier supplied when the quote was created.
pay_amount
String
Amount deducted from the source balance.
pay_currency
String
Source asset code.
receive_currency
String
Fiat currency received by the beneficiary.
receive_amount
String
Fiat amount received by the beneficiary.
fee_amount
String
Payout fee.
fee_currency
String
Currency in which the fee is charged.
exchange_rate
String
Exchange rate applied to the payout.
failure_reason
String
Failure reason, when available.
create_time
Number
Order creation time, as a 13-digit Unix timestamp in milliseconds.
finish_time
Number
Order completion time, as a 13-digit Unix timestamp in milliseconds. Returned when available.
Last updated