Webhooks

When an action occurs within the Mentium system on a resource, an Event object is created to record a change to the state of the resource. All created Webhook Events follow the same format and include

Security

For security reasons, we provide a HTTP header X-Request-Signature-SHA-256 that contains a HMAC SHA256 hash based on the webhook payload and a key which is the webhook secret you provided when you created your webhook subscription. The webhook signature should be processed and validated prior to parsing the webhook payload.

Events

We currently support 4 events (more to come soon).

Resource	Event Type	Description
PaymentLink	payment_link.created	This event is triggered when you create a new payment link
PaymentLink	payment_link.updated	This event is triggered when a payment link is updated (for instance when a payment occurs or fail, the payment_link status will update)
Payment	payment.created	This event is triggered when a payment has been initiated by a customer
Payment	payment.updated	This event is triggered when a payment has been updated (for instance when a payment is received, the payment status will update)

Events payload

Property	Description
id	The event ID
subscription_id	The webhook subscription ID
type	The event type
data	The event payload
created_at	The date the event was created

For each event type, the data payload contains a different payload.

payment_link events

Status:

• PENDING: The customer hasn't attempted to pay yet

• PAYMENT_PENDING The customer has made a payment

• PAYMENT_SUCCEED The customer payment is successful

• PAYMENT_FAILED The customer payment has failed

Property	Description
id	The unique PaymentLink ID
amount	The amount of charged to the customer
customer_id	The customer ID
status	PENDING, PAYMENT_PENDING, PAYMENT_SUCCEED, PAYMENT_FAILED
expires_at	The date the PaymentLink expires
created_at	The date the PaymentLink was created

payment events

Status:

• PENDING: The payment hasn't been received yet

• PROCESSED The payment has been received

• FAILED The payment failed

• CANCELLED The paymnet was cancelled

Property	Description
id	The unique PaymentLink ID
amount	The amount of charged to the customer
status	PENDING, PROCESSED, FAILED, CANCELLED
customer_id	The customer ID
payment_link_id	The PaymentLink ID
created_at	The date the Payment was created