Webhooks

Getting started

QuickaPay offers a simple way to allow you to receive events upon an invoice receiving a payment. You configure these notifications via webhook or email events.

Webhook Configuration

Enable Invoice Raising API Access and configure Webhook URI to the destination Webhook URL where the POST request will be sent.

Settings > API Access > Add API Access

Webhook Object

When a webhook event has been sent the request body will contain a object with information on the webhook event. The event will be sent to the configured Notification Webhook.

Attribute

Type

Description

event

string

The webhook event type enum.

gid

string

The UUID given to the webhook object.

timestamp

int64

The unix timestamp when the webhook was sent.

payload

object

The webhook event object described below.

Invoice Status Change Event Object

Whenever an invoice has received any given payment the following will be the payload field of the webhook object. The webhook event payload is found in the webhook object defined above.

Attribute

Type

Description

supplier_name

string

The invoice supplier name.

invoice_reference

string

Your provided customer reference for the invoice.

invoice_link

string

The URL of the invoice.

invoice_id

string

The UUID of the invoice.

settlement_token

string

The settlement token of the invoice.

method

string

The Payment Method enum used to pay the invoice.

status

string

The current Invoice Status enum of the invoice.

paid_amount

string

The amount paid on the invoice.

remitted_amount

string

The remitted amount of the invoice.

timestamp

int64

The unix timestamp when the payload was sent.