meCash Webhook Events
meCash uses webhooks to send your application real-time notifications for key events in your payout and virtual account workflows. You can monitor these events as they happen via the Webhook Logs section on your Dashboard.
This page provides an overview of the event categories and common data fields. For detailed information and data payloads, please see the specific pages for each event type.
Viewing Webhook Events
To see a live log of the events sent to your endpoint:
- Navigate to the Developers section on your meCash Dashboard.
- On the left-side menu, click on the Webhook Logs tab.
Each log entry provides a quick summary, including the event type, the HTTP response code from your server, response time, and status. You can click on any entry to view the full JSON payload that was sent.
Event Categories
meCash webhook events are grouped into four main categories based on the type of transaction. Select a category below to see a detailed list of its specific event types and their corresponding data payloads.
💰 Collection Events & Payloads
These events notify you about the status of funds being collected and deposited into your merchant wallet.
collection.completedcollection.failed
💸 Fiat Payout Events & Payloads
These events track the lifecycle of payouts made from your account to an external fiat recipient, like a bank account.
payout.completedpayout.failedpayout.pending
💳 Virtual Account Events & Payloads
These events inform you about funding activities related to your virtual accounts.
virtualaccount.completedvirtualaccount.failed
💱 Ramp Payout Events & Payloads
These events provide updates for off-chain transfers, including both crypto-to-fiat (Off-Ramp) and crypto-to-crypto payouts.
ramp.payout.completedramp.payout.failedramp.payout.pendingramp.payout.refund
Common Transaction Details
Across all event payloads, you'll find common fields that describe the transaction's status and nature.
Transaction States
This explains the different possible statuses of a transaction within the webhook payload:
| State | Description |
|---|---|
COMPLETED | The transaction was processed successfully. |
PENDING | The transaction is still in progress. |
FAILED | The transaction could not be processed. |
Transaction Types
The type and category fields describe the nature of the transaction.
| Field | Example Value | Description |
|---|---|---|
| type | SEND | Describes an outbound transaction, like a payout. |
FUNDING | Describes an inbound transaction, like a deposit or top-up. | |
| category | OFF_RAMP | Identifies a crypto-to-fiat conversion. |
CRYPTOCURRENCY | Identifies a transaction involving only cryptocurrencies. |
Next Steps
Now that you have an overview of the event types, here are the next logical steps for your integration:
- ⚙️ Configure Your Webhook Endpoint: Learn how to set up the URL where meCash will send events.
- 🛡️ Validate Webhook Signatures: A crucial step to ensure your endpoint is secure and only processes authentic requests from meCash.