Payment Update

webhook

https://yourwebhook.com/payment_update

Purpose

Use the payment update webhook to receive the result of an asynchronous payment request. The event reports a payment status of authorized or refused and includes the payment ID and gateway metadata.

Definitions

Parameter	Meaning
paymentId	The unique payment ID from Deliverect Pay
status	The status from the list of value supported for updates.

Payment Status

Status	Description
authorized	Payment was successfully authorized
refused	Payment was refused due to issues with the shopper's payment methods (not enough balance, wrong cvc, etc...)
failed	Payment failed to be processed due to a technical issue
pending	Payment is being processed

Payload

paymentId

string

The unique payment ID from Deliverect Pay.

status

string

enum

The status from the list of values supported for updates:

authorized — Payment was successfully authorized
refused — Payment was refused due to issues with the shopper's payment methods (not enough balance, wrong CVC, etc.)
failed — Payment failed to be processed due to a technical issue
pending — Payment is being processed

Allowed:

metadata

object

Gateway details for the payment. Included when status is authorized or refused.

Headers

User-Agent

string

required

Defaults to Deliverect/{version}

Identifies Deliverect as the sender of the webhook, in the format Deliverect/{version}.

X-Server-Authorization-HMAC-SHA256

string

required

Defaults to {signature}

HMAC-SHA256 signature of the raw request body, generated with your shared secret. Recompute the signature on receipt and compare it to this value to verify the request came from Deliverect (see the HMAC authentication guide).

Response

Purpose

Definitions

Payment Status

200200