Payment webhooks

wbhk

payments

Sent to the webhook URI you registered in Console when:

a payment is authorised.
a payment is executed.
a payment fails.
a payment settles.
a payment is creditable, according to criteria you specified.
a payment that has been executed has not settled within a duration you specified.
an indemnity claim is made against a payment.
a payment is reversed.
a Direct Debit payment arrived in the merchant account. The payment can still be reversed at this stage. Contact your ISM or CSM to know more.

Payload

type

string

enum

required

Allowed:

event_version

integer

enum

required

The version of the event schema.

Allowed:

event_id

string

required

Unique ID of the event.

payment_id

string

required

Unique ID for the Payment

metadata

object

Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters.

payment_method

required

authorized_at

string

required

Date and time the payment was authorized

payment_source

object

Information about the source of funds, if available from the remitter's bank. Account identifiers will be those provided by the bank.

Headers

Tl-Signature

string

required

A JWS with detached content, verifiable with our public key.
See Webhook Request Signing

Response

200

Webhook Handled

Loading…