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

Acquiring

This page describes terminal order notifications for Acquiring Wallet Mode and Checkout Mode.

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.

pay_amount can differ from order_amount for underpayments or overpayments. See payment amount handling.

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.

Blockchain and payment fields

Parameter
Type
Description

sourceAddress

String

Source blockchain address.

sourceTag

String

Source address tag or memo, when applicable.

destinationAddress

String

Destination blockchain address.

destinationTag

String

Destination address tag or memo, when applicable.

txnHash

String

Blockchain transaction hash.

blockHeight

String

Block height, represented as a string.

numOfConfirms

String

Confirmation count at notification time, represented as a string.

network

String

Blockchain network identifier.

Last updated