For the complete documentation index, see llms.txt. This page is also available as Markdown.

Query Fiat Payout

Retrieves a payout order and its latest status.

POST /v1/fiatpayout/payouts/query

Request Body

Name
Type
Required
Description

request_id

String

Conditional

Payout identifier supplied by the organization. Provide either request_id or order_no.

order_no

String

Conditional

Payout order number generated by MusePay. Provide either order_no or request_id.

Request Example

{
  "request_id": "ORD-20260505-001"
}

Response Body

Name
Type
Description

order_no

String

Payout order number generated by MusePay.

request_id

String

Payout identifier supplied by the organization.

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.

status

Number

Current order status.

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.

Payout Status Notifications

MusePay sends an order webhook whenever the payout status changes. The notification uses the standard order webhook payload and the existing order status values.

Use order_no or request_id as the idempotency key when processing a notification, and return HTTP 200 after the notification has been processed successfully.

Last updated