You can expect the below object when you register a webhook for the following events:
- payment_link.create
Raw sample
{
"description": "12pcs Chocolate Box",
"capacity": null,
"active": true,
"return_url": null,
"failure_return_url": null,
"send_customer_receipt": true,
"custom_data": {},
"amount_currency": "AED",
"platform": "client",
"prefilled_customer": {},
"title": "Chocolate Box - Small",
"external_id": null,
"name": "Chocolate Box - Small",
"enable_tabby": true,
"is_widget": true,
"id": "MB-LINK-0C6885CBB3",
"amount": 3000,
"processing_fee_percentage": 0,
"processing_fee_amount": null,
"enable_message": true,
"enable_tips": false,
"enable_quantity": false,
"payment_methods": [
"card",
"wallet"
],
"rules": null,
"enable_customer_details": false,
"payment_url": "https://staging.business.mamopay.com/widget/pay/mamosandbox-acf1e5",
"save_card": "optional",
"created_at": "2023-12-28-16-21-24",
"event_type": "payment_link.create",
"subscription": null
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| description | String | Payment link description |
| capacity | Number | Payment Link capacity |
| active | String | Payment Link activity (True or false ) |
| return_url | String | The URL that the customer will be redirected to after a successful payment |
| failure_return_url | String | The URL that the customer will be redirected to after a failed payment |
| send_customer_receipt | String | Enables the sending of customer receipts |
| custom_data | Dictionary | Custom Data sent in the request |
| amount_currency | String | Currency of the payments |
| platform | String | Platform where the payment link was generated |
| title | String | Payment link title |
| prefilled_customer | Dictionary | Prefilled customer details (name - email) |
| external_id | String | External ID sent in the request |
| name | String | Payment Link name |
| enable_tabby | String | Whether the option to enable Taby is true or false |
| is_widget | String | Whether the payment link is a widget or not |
| id | String | Payment Link ID |
| amount | Number | Amount of the Payment Link |
| processing_fee_percentage | Number | Processing fee percentage sent in the request |
| processing_fee_amount | Number | Calculated processing amount |
| enable_message | String | Whether the customer can add a note or not |
| enable_tips | String | Whether the option to enable tips is allowed or not |
| enable_quantity | String | Whether the customer can add a quantity |
| payment_methods | List | List of allowed payment methods (card - wallet) |
| rules | String | Payment link rules |
| enable_customer_details | String | Whether the customers can enter their details |
| payment_url | String | Payment Link |
| save_card | String | Whether the card's details will be saved or not (optional - required - off) |
| created_at | String (Format: YYYY-MM-DD-HH-MM-SS) | The creation time of the Payment Link |
| event_type | String | Webhook event type |
| subscription | Dictionary | Subscription details in case of subscriptions (identifier-frequency_interval-end_date-payment_quantity-start_date-frequency) |