# Overview

Epay serves as a webhook-driven checkout-as-a-service. With our webhook driven platform, you get notified via your webhook URL or endpoint whenever a new payment comes through in real time and you only need to worry about how to respond when a payment is successful or not.

# Resources on Webhooks

• Webhhook vs API
• What is a webhook

# Use cases Of Webhooks

You might use webhooks as the bases to:

• Update a customer's membership record in your database when a subscription payment succeeds
• Email a customer with an event ticket or digital product when payment succeeds
• Email a customer when a payment fails
• Record payment history in your database

Before you can recieve webhook notifications, you need to register a webhook url under your settings navigation's tab. When an event such as a successful payment or a failed payment occurs, you are notified via your webhook URL.

# Quick Start

Get up and running with our webhook driven service and start your integration. Integrating Epay into your app or website can begin as soon as you Create an Account, requiring only three steps;

1. Configure your Webhook to receive webhook notifications through the specified endpoint
2. Connect your payment page so you can take payments from your customers directly into your Epay wallet
3. Receive and Handle Webhook Notifications to confirm payment transactions and fulfill purchases

# Configuring your Webhooks Settings

Webhooks are configured in the Dashboad's Settings Navigation section. Add your Webhook endpoint/URL for receiving webhooks.

You can enter any URL as the endpoint or destination for recieving notifications. However, this should be a dedicated page on your server that is setup to receive webhook notifications.

# Connecting your Payment Page

A Payment Page can represent anything you want to charge money for, including; a downloadable product, a private course, T-shirt etc .

You can simply connect your payment page to your application or website by hiding the link of the payment page behind a pay button so your customers get redirected to the payment page when they click on the pay button.

<a href="https://epaygh.com/pay/st-event-demo-app" class="btn btn-primary">Pay</a>

# Receiving a webhook Notification

Creating a webhook endpoint on your server is not different from creating any page on your website. With PHP, you might create a new .php file on your server; with a framework like Laravel, you would add a new route with the desired URL. Webhook Data is sent as JSON in a post Request body. The full notification details are included and can be used directly after, parsing the JSON.

Sample Webhook Notification

{
    "success": true,
    "transaction": {
        "reference": "EP-XSks6NGSvtd",
        "payment_method": "momo",
        "amount": "1",
        "status": "success",
        "description": "Payment for sample event",
        "customer": {
            "name": "sam",
            "email": "sam@gmail.com",
            "telephone": "054********"
        },
        "page": {
            "id": 73,
            "name": "Event Demo App",
            "description": "A demo payment page ",
            "slug": "st-event-demo-app"
        }
    }
}

# Handling a webhook Notification

Below is a sample php code as to how to handle a webhook Notification

<?php

//Retrieve the request's body and parse it as JSON
$request = @file_get_contents('php://input');
$request_body = json_decode($request); 

//Do something with $request_body with example notification body shown above

//Respond with 200
http_response_code(200); //PHP 5.4 or greater