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
Card Account Transactions
Parameter | Type | Desc |
---|---|---|
type | String | APPLY_AUDIT: Card Apply Message CARD_TOP_UP: Card Top-Up Order Message CARD_TO_WALLET: Card To-Wallet Order Message CARD_BILL_TRANSACTION: Card Bill Transaction Message |
data | Object | Operation specific message. See Below. |
sign | String | Base64 encoded signature string. |
Card Apply Message
Parameter | Type | Desc |
---|---|---|
applyId | String | The ID of the card application. |
request_id | String | The external ID of the card apply provided by the partner. |
status | Number | The status of application, see Apply Status |
Card Order Message
Parameter | Type | Desc |
---|---|---|
orderNo | String | The ID of the transaction. |
requestId | String | The external ID of the transaction provided by the partner. |
orderType | String | top-up or to-wallet |
orderCurrency | String | The currency associated with the card order. |
orderAmount | String | The order amount that was proceed to be received. |
fee | String | The service fee amount. |
paymentAmount | String | The actual amount that was paid. |
feeCurrency | String | The fee currency |
status | Number | The status of Transaction, see Top Up Status |
rate | String | The exchange rate if involved. |
Card Bill Transaction Message
Parameter | Type | Desc |
---|---|---|
detailId | String | Card account transaction id |
cardId | String | Card id of the card that was used to make the transaction. |
txCreatedAt | Long | Date / Time of transaction at which it was initially recorded into the account |
txStatus | String | The status of the card bill transaction . see Transaction Status |
txPostedAt | Long | Date / Time of transaction at which it was posted into the account |
txType | String | see Transaction Type |
txCurrency | String | Currency of transaction in card account base currency |
txAmount | Number | The service fee amount. |
txMerchant | Object | This field will provide information about the merchant where the transaction occurred (for "charge" transactions only). |
txAuthorization | Object | Authorization info, applies to |
txEntryType | String | The type of entry representing whether the transaction resulted in a credit to or debit from the card account balance.
A |
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