WebHook

Setting up

Setting a web-hook will allow you to get notifications for order status update. You can receive notifications on events in your orders such as incoming/outgoing transactions and transactions status update. The Webhook url can be set up here:

Once your webHook url is setup, you will start receiving notification on events for your orders. All events will be sent with the following signature.

  • sign = Base64(RSA(PLATFORM_PRIVATE_KEY, SHA1(msgBody))

The public key for verifying the signature can be found here:

Data Objects

Notify Body

ParameterTypeDesc

partner_id

String

The ID of your Account allocated from MusePay.

order_no

String

The ID of the transaction.

request_id

String

The external ID of the transaction provided by the partner.

order_type

String

The transaction type. see Order Type

product_code

String

The transaction sub-type.

currency

String

The name of crypto asset associated with the transaction.

order_amount

String

The requested amount.

fee_amount

String

The service fee amount.

actual_amount

String

The actual amount that was proceed to received.

finish_time

String

The completed time of the transaction.

status

Number

The status of Transaction, see Order Status

reason

String

The failed reason of transaction.

sign

String

Base64 encoded signature string.

extra_info

JSON String

Protocol / operation specific parameters.

Extra Info

ParameterTypeDesc

description

String

extend info from the request.

txnHash

String

Blockchain hash of the transaction

customerRefId

String

The ID for the partner to associate the owner of funds(customer) with transactions

blockHeight

Number

The height (number) of the block the transaction was mined in

numOfConfirms

Number

The number of confirmations of the transaction. The number will increase until the transaction will be considered completed according to the confirmation policy.

networkFee

String

The fee paid to the network

sourceAddress

String

The source address of the transaction

destinationAddress

String

Address where the asset were transferred

destinationTag

String

Destination tag for XRP, used as memo for EOS/XLM

Retry attempts

MusePay will send a POST request to the URL(s) associated with the partner and expect a 200 response. If no response is received, MusePay will resend the request several more times with an increasing delay between each attempt, the retry attemps will be taken after [ 0,2,4,8,16,32,64] minutes.

Last updated