Payout Quote

Every request must contain common parameters.

Creates a quote for converting the source asset into the fiat currency received by the beneficiary. The beneficiary and payout route are captured when the quote is created.

POST /v1/fiatpayout/payouts/quote

Request Body

Name	Type	Required	Description
request_id	String	Yes	Unique identifier supplied by the organization. Used as the quote request's idempotency key.
quote_mode	String	Yes	Quote mode. Use source to specify pay_amount, or dest to specify receive_amount.
pay_currency	String	Yes	Source asset code.
pay_amount	String	Conditional	Source amount. Required when quote_mode is source; must be greater than zero.
receive_currency	String	Yes	Fiat currency received by the beneficiary, as an ISO 4217 currency code.
receive_amount	String	Conditional	Destination amount. Required when quote_mode is dest; must be greater than zero.
beneficiary_country	String	Yes	Beneficiary country or region as an ISO 3166-1 alpha-2 code.
beneficiary_bank_id	String	Yes	bank_code returned by Supported Banks.
account_type	String	Yes	Beneficiary account type: PERSONAL for an individual or ENTERPRISE for an organization.
beneficiary_relationship	String	Yes	Beneficiary relationship: own or third.
clear_network	String	Yes	Clearing network returned by Supported Networks.
beneficiaryFields	Object	No	Bank-specific fields keyed by the values returned from Required Beneficiary Fields. The field name is case-sensitive.
individual_beneficiary	Object	Conditional	Required when account_type is PERSONAL.
enterprise_beneficiary	Object	Conditional	Required when account_type is ENTERPRISE.

Provide only the beneficiary object that matches account_type.

Beneficiary Fields

The following fields apply to both individual_beneficiary and enterprise_beneficiary:

Name	Type	Required	Description
account_no	String	Yes	Beneficiary bank account number.
bank_name	String	Yes	Beneficiary bank name.
address	String	Yes	Beneficiary address.

Additional fields for individual_beneficiary:

Name	Type	Required	Description
full_name	String	No	Full legal name. When present, it is used as the beneficiary name.
first_name	String	No	Given name. Used with middle_name and last_name when full_name is absent.
middle_name	String	No	Middle name.
last_name	String	No	Family name.
nationality	String	No	Nationality as an ISO 3166-1 alpha-2 code.
gender	String	No	male or female.
date_of_birth	String	No	Date of birth in yyyy-MM-dd format.

Additional field for enterprise_beneficiary:

Name	Type	Required	Description
company_name	String	No	Legal organization name.

Request Example

{
  "request_id": "request-1",
  "quote_mode": "source",
  "pay_currency": "USDT",
  "pay_amount": "100.00",
  "receive_currency": "USD",
  "beneficiary_country": "US",
  "beneficiary_bank_id": "bank-1",
  "account_type": "PERSONAL",
  "beneficiary_relationship": "third",
  "clear_network": "ACH",
  "beneficiaryFields": {
    "routing_number": "110000"
  },
  "individual_beneficiary": {
    "account_no": "123456789",
    "bank_name": "Example Bank",
    "address": "New York",
    "full_name": "Alice Smith"
  }
}

Response Body

Name	Type	Description
request_id	String	Identifier supplied in the quote request.
order_no	String	Quote order number generated by MusePay. Use this value to create the payout.
transaction_time	Number	Quote creation time, as a 13-digit Unix timestamp in milliseconds.
quote_mode	String	Quote mode used for the request.
pay_amount	String	Amount deducted from the source balance.
pay_currency	String	Source asset code.
fee_amount	String	Payout fee.
fee_currency	String	Currency in which the fee is charged.
exchange_rate	String	Exchange rate from pay_currency to receive_currency.
receive_amount	String	Fiat amount received by the beneficiary.
receive_currency	String	Beneficiary currency.
expire_time	Number	Quote expiration time, as a 13-digit Unix timestamp in milliseconds.

{
  "code": "200",
  "message": "success",
  "data": {
    "request_id": "request-1",
    "order_no": "ORDER-1",
    "transaction_time": 1700000000000,
    "quote_mode": "source",
    "pay_amount": "100.00",
    "pay_currency": "USDT",
    "fee_amount": "1.25",
    "fee_currency": "USDT",
    "exchange_rate": "0.99",
    "receive_amount": "98.75",
    "receive_currency": "USD",
    "expire_time": 1700000900000
  }
}