Register webhooks

After you’ve created a payment webhooks are key in receiving updates about changes in the status of the payments. In this document, we will explain the several status updates you can receive as well as how to configure a webhook.

Receiving webhooks

If the status of the payment is modified you’ll receive a webhook. The contents posted to these webhooks will look like this:

CODE

{
	"transaction_id": "cce9181c-cedd-4596-b784-6f64e7a3d408",
	"reference": "fdb892d2-cd4b-4b88-9d87-6deb43c466d1",
	"status": 0,
	"description": "Payment description",
	"shopper_reference": "53ceee12-b74d-4f4b-85ed-7f6d665fb3a2",
	"amount": 3500,
	"currency": "EUR",
	"country_code": "NL",
	"shopper_locale": "nl-NL",
	"url": "https://eu.adyen.link/PLB0CCE42848AA2519"
}

The only value that will change is the status, we’ve attempted to simplify the different payment statuses you might receive from PSPs into the following list:

Status	Code
OPEN	0
CANCELED	1
AUTHORIZED	2
EXPIRED	3
FAILED	4
PAID	5
REFUNDED	6

Configuring a webhook

To register a webhook make the following API call using the provider id of the PSP you’re configuring the webhook for. Please note that you can configure multiple webhooks, update webhooks and also delete them.

These webhooks can have authentication enabled, this way you can validate if a webhook is actually made by GoMeddo Payments, we strongly recommend implementing this.