Go to payrails.com

Receive notifications

Suggest Edits

📘

Learn how to receive webhook notifications from Payrails to stay informed about the outcomes of asynchronous actions such as authorize, capture, cancel, refund, and more.

Introduction

A notification is a webhook sent by Payrails to inform you of the outcome of an asynchronous action such as authorization, capture, cancellation, refund, etc. Notifications are sent to specified endpoints on your server in JSON format using the HTTP POST method.

How to start receiving notifications from Payrails

To start receiving notifications, follow these steps:

1. Expose an Endpoint on Your Server

Create an exposed endpoint on your server that accepts HTTP requests in JSON format.

2. Configure Endpoint URL(s) in Payrails Portal

Navigate to the Payrails Portal to configure the endpoint URL(s) where you want to receive notifications. To do this, go to Configurations > Settings in the Portal menu. Add the endpoint URL(s) under the Notifications section, and click on "Save changes".

When adding a new notification URL, Payrails will generate an HMAC key for that endpoint. This HMAC key secures the communication between Payrails and your server. The HMAC key will only be revealed once for security purposes. Ensure that you securely store this HMAC key.

You can also rotate the HMAC key for a notification endpoint. When rotating the HMAC key, the previous HMAC will no longer work, and you’ll need to replace it with the newly generated HMAC in your systems. For security purposes, the new HMAC will only be revealed once.

You will now start receiving notifications for new executions at your saved URL(s), and each URL will receive for each execution the notifications detailed in our Notifications guide. Notifications for existing executions will continue to be delivered to the URLs in place when those executions are created.

You can review, add, or delete the URLs from this page anytime.

3. Accept Notifications

Notifications will be sent using the HTTP POST method in the format shown below. Each notification request contains an X-Signature header, which is a signature of the request body. The signature is calculated using the HMAC-SHA256 algorithm and a secret key.

Calculate and Verify the HMAC Signature
To verify the X-Signature header's value, calculate the HMAC signature as described above, and compare it to the header value. If they match, the notification is valid.

Example:

Secret Key: 44782DEF547AAA06C910C43932B1EB0C71FC68D9D0C057550C48EC2ACF6BA056

Request Header: X-Signature: /9RS0Gfxl2C6j1akmI5/l0y+FTygmNmEPU/2nNYMYTQ=

Here are some simple example codes in different languages for your reference. Please make sure you handle exceptions correctly and adapt them to your use case.

import java.nio.charset.StandardCharsets;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.util.Base64;

/**
* Validates if the received payload signature corresponds with the secret key.
*
* @param  payload  the payload you received, without any formatting or escaping
* @param  xSignatureHeader the X-Signature you received together with the payload
* @param  hmacSecretKey the secret HMAC key in your configuration
* @return      true if signature is valid
*/
public static boolean isValidSignature(String payload, String xSignatureHeader, String hmacSecretKey) {
    try {
        Mac hashInstance = Mac.getInstance("HmacSHA256");
        SecretKeySpec secretKey = new SecretKeySpec(hmacSecretKey.getBytes(StandardCharsets.UTF_8), "HmacSHA256");
        hashInstance.init(secretKey);

        byte[] hashed = hashInstance.doFinal(payload.getBytes(StandardCharsets.UTF_8));
        String encoded = Base64.getEncoder().encodeToString(hashed);
        return encoded.equals(xSignatureHeader);
    } catch (NoSuchAlgorithmException | InvalidKeyException e) {
        return false;
    }
}

import hashlib
import hmac
import base64

def is_valid_signature(payload, x_signature_header, hmac_secret_key):
    try:
        hash_instance = hmac.new(hmac_secret_key.encode('utf-8'), payload.encode('utf-8'), hashlib.sha256)
        hashed = hash_instance.digest()
        encoded = base64.b64encode(hashed).decode('utf-8')
        return encoded == x_signature_header
    except Exception as e:
        return False

import (
    "crypto/hmac"
    "crypto/sha256"
    "encoding/base64"
)

// isValidSignature validates if the received payload signature corresponds with the secret key.
func isValidSignature(payload, xSignatureHeader, hmacSecretKey string) bool {
    hashInstance := hmac.New(sha256.New, []byte(hmacSecretKey))
    _, err := hashInstance.Write([]byte(payload))
    if err != nil {
        return false
    }
    hashed := hashInstance.Sum(nil)
    encoded := base64.StdEncoding.EncodeToString(hashed)
    return encoded == xSignatureHeader
}

import * as crypto from 'crypto';

// isValidSignature validates if the received payload signature corresponds with the secret key.
function isValidSignature(payload: string, xSignatureHeader: string, hmacSecretKey: string): boolean {
    try {
        const hashInstance = crypto.createHmac('sha256', hmacSecretKey);
        hashInstance.update(payload);
        const hashedPayload = hashInstance.digest('base64');
        return hashedPayload === xSignatureHeader;
    } catch (error) {
        return false;
    }
}

Order of Notifications
Payrails does not guarantee the order of notifications. For example, an authorization notification might fail, followed by a successful capture notification, and then a successful retry of the authorization notification. Your endpoint should handle notifications received out of order, possibly by fetching the latest state of the object from the API.

Retry Mechanism
If the notification is valid, acknowledge it with a HTTP 200 response
If the initial notification delivery fails, Payrails will attempt to resend it up to 50 times using an exponential back-off strategy, over a period of several days.

4. Track Notifications

You can review the status and destination of notifications for each execution in the Payrails Portal or by using the Search & list events API.

Go to the Executions page, search by execution ID, and review the details page for the selected execution. The information about notifications can be found in the Execution Timeline section.

Click on any completed event in the timeline to view the corresponding notification object in the payload.

5. Understand Notification Types

Payrails sends notifications for various events related to execution and payment state changes. Consult the exhaustive list of notification types to understand the notifications you might receive.

By following this guide, you'll be well-equipped to receive and handle webhook notifications from Payrails, ensuring that you're always up-to-date with the status of your payment transactions.

Updated about 2 months ago