Events
Read on when webhooks are sent from our system
When the state of a resource changes, the platform generates a new event resource to record the change. When an Event is created, a Webhook will be created to deliver the Event to any URLs specified by your active Webhook Subscriptions.
Sender Events
Event Name | KYC Status | Event Details | Remarks |
---|---|---|---|
sender_created | UNVERIFIED | When a sender has been created in Machnet platform. | This will enable widget feature for sender’s KYC process. |
sender_verified | VERIFIED | When a sender has been successfully verified through KYC process. | |
sender_suspended | SUSPENDED | When a sender suspended after KYC review. | In this case, you should restrict the user from conducting any activity in your application. |
sender_review_pending | REVIEW_PENDING | When a sender's KYC is in progress and needs to be reviewed by admin. | No action is required from the sender at this point. |
sender_document_requested | DOCUMENT_REQUESTED | When admin requests document from sender. | The sender needs to either re-upload their document or provide additional document (via KYC widget) as requested by admin. |
sender_kyc_retry_requested | RETRY_REQUESTED | When admin requests sender to re-submit information. | The sender needs to either edit their current information or provide additional information(via KYC widget) as requested by admin. |
sender_reverification_needed | RETRY | When the sender needs to provide additional information for verificaiton. | Sender needs to provide additional information to complete verification. Affiliate will need to open the widget with type: kyc. |
sender_document_expiring_soon | When the latest ID document of the sender is expiring within 5 days | Affiliate may choose to inform the user that their ID is expiring soon. However, user will only be able to update their ID document once it has expired. Affiliate can update ID document on behalf of the user through Machnet's dashboard. | |
sender_document_expired | When the latest ID document of the sender is expired | Refer to Expired ID section for details on next steps. |
Sender Tier Events
Event Name | Event Details | Remarks |
---|---|---|
tier_approved | When the requested tier upgrade has been approved. | User can now create transactions as per the new tier limits. |
tier_retry | When admin has requested to retry for tier upgrade | Affiliate can open the tier widget again so sender can re-submit tier upgrade request. |
tier_document_required | When admin requests for tier document. | Affiliate will need to open the tier widget so sender can upload the requested document. |
tier_disapproved | When admin disapproves a tier upgrade request. | Sender cannot request for tier upgrade once it has been disapproved. |
tier_canceled | When admin cancels a tier upgrade request. | Sender can request for tier upgrade again. Affiliate can open the tier widget so sender can re-submit tier upgrade request. |
tier_downgraded | When admin downgrades a sender’s tier. |
Sender Profile Edit Events
Event Name | Event Details | Remarks |
---|---|---|
sender_profile_edit_submitted | Affiliate admin has requested to edit sender profile information. | Machnet admin will need to review this request. |
sender_profile_edit_approved | Sender profile edit request has been approved. | It is suggested to sync the updated details using Get Sender By Id. |
sender_profile_edit_disapproved | Sender profile edit request has been disapproved. | |
sender_profile_edit_updated | Sender profile edit request has been updated. | Machnet admin has updated the request submitted by Affiliate admin. |
Receiver Profile Edit Events
Event Name | Event Details | |
---|---|---|
receiver_profile_edit_submitted | Affiliate admin has requested to edit reciever profile information. | Machnet admin will need to review this request. |
receiver_profile_edit_approved | Receiver profile edit request has been approved. | It is suggested to sync the updated details using Get Recipient by ID. |
receiver_profile_edit_disapproved | Receiver profile edit request has been disapproved. | |
receiver_profile_edit_updated | Receiver profile edit request has been updated. | Machnet Admin has updated the request submitted by the Affiliate Admin. |
receiver_account_edit_submitted | Admin has requested for receiver account edit. | |
receiver_account_edit_approved | Receiver account edit request has been approved. | It is suggested to sync the updated details using Get Recipient Account by ID. |
receiver_account_edit_disapproved | Receiver account edit request has been disapproved. | |
receiver_account_edit_updated | Receiver account edit request has been updated. | Machnet Admin has updated the request submitted by the Affiliate Admin. |
Transaction Events
Event Name | Transaction Status | Event Details | Remarks |
---|---|---|---|
transaction_initiated | INITIATED | When transaction has been initiated by the sender. | Transaction will undergo compliance checks. |
transaction_created | PENDING | When transaction has been successfully created in Machnet platform. | Transactions have successfully passed compliance checks. |
transaction_processed | PROCESSED | When the funds have been successfully debited from the sender's funding account. | |
transaction_failed | FAILED | When the funds cannot be debited from the sender's funding account. This usually occurs due to failure such as insufficient funds, fraudulent details etc. | |
transaction_canceled | CANCELED | When transaction has been canceled either by the customer or admin. | |
transaction_returned | RETURNED | When transaction has been returned. | |
transaction_refunded | REFUNDED | When the funds have been credited back to the sender's funding account. | |
transaction_completed | COMPLETED | When the funds have been successfully debited from the sender's funding account and credited to beneficiary’s bank account. | |
transaction_onhold | HOLD | When the sender's transaction is on hold. The hold reason is provided in the response when fetching transaction information. | This event requires admin intervention and will either be canceled or moved to Pending state. |
Transaction Delivery Events
Event Name | Delivery Status | Event Details | Remarks |
---|---|---|---|
transaction_delivery_pending | PENDING | When the transaction has been successfully created and can be forwarded for delivery. | |
transaction_delivery_requested | DELIVERY_REQUESTED | When the delivery of transaction to the beneficiary has been initiated. | |
transaction_delivery_onhold | HOLD | When the transaction delivery has been moved to hold state. | Delivery can be held due to compliance or technical reasons. Admin needs to review these transactions. |
transaction_delivery_authorized | DELIVERY_AUTHORIZED | When the transaction is authorized to deliver by the affiliate. | This status is only applicable for Affiliates conducting self-payout. Only once Delivery is Authorized should they provide the funds to the recipient. |
transaction_delivery_payout_ready | DELIVERY_PAYOUT_READY | When the transaction is ready for pick up by the recipient. | This is applicable for cash pick up transactions. |
transaction_delivery_failed | DELIVERY_FAILED | When the delivery of transaction has failed. | |
transaction_delivered | DELIVERED | When the funds have been successfully delivered to the recipient. |
Funding Source Events
Event Name | Event Details | Remarks |
---|---|---|
bank_added | When the sender's bank account has been successfully added. | Sender can send funds to the receiver using this bank account. |
bank_removed | When the sender's bank account has been removed. | |
bank_verified | When the sender's bank account has been verified. | |
bank_verification_failed | When the sender's bank verification has failed. | |
bank_login_required | When the sender needs to update their bank credentials. | Affiliate will need to re-open widget with type: bank and funding source ID so that sender can relogin into their associated bank. |
card_added | When the sender's card account has been successfully added. | Sender can send funds to the receiver using this card. |
card_removed | When the sender's card account has been removed. | Sender can no longer use this account to create transactions. Cards are also removed when they expire. If it was removed because card was expired, you will receive the webhook will contain an |
card_expiring_soon | When the sender's card is expiring soon. | This event is triggered once if the card is expiring within 5 days. You may notify the user and ask them to add a new debit card. |
duplicate_card_added | When sender adds a card that has already been added by another sender within the Affiliate or across the Machnet platform. | If the same card is being used by multiple senders, it may be a risk flag. You can take steps as necessary to address such suspicious users/cards/transactions. |
3DS Events
Events Name | Event Details | Remarks |
---|---|---|
3ds_verification_required | 3DS verification is required to forward the transaction for processing. Additional details can be found here. | User will need to be notified and 3DS verification will need to be completed by the user again. To complete 3DS verification, open widget v1.0 with |
Last updated