Payments webhooks

Payments webhooks trigger three events:

  • Payment transaction created
  • Payment transaction updated
  • Payment link updated

Please refer to the Webhooks section to configure them.

1. Payments - Payment transaction created

This event is triggered when a payment transaction is created.

Example:

{
  "content": {
    "payment_transaction_id" : "15e04e47-7391-4b58-bc98-a334a4e7ad13",
    "payment_request_id" : "rto4e47-201-4b58-bc98-a924a4e7ad12",
    "payment_link_id" : "rto4e47-201-4b58-bc98-a924a4e7ad12", // not in response if null
    "client_reference" : "INV124", // not in response if null
    "end_to_end_id": "REF1234" // not in response
    },
  "timestamp" : 1612783550980,
  "type" : "payment.transaction.created"
  }

2. Payments - Payment transaction updated

This event is triggered when a payment transaction is updated.

Example:

{
  "content": {
    "payment_transaction_id" : "15e04e47-7391-4b58-bc98-a334a4e7ad13",
    "payment_request_id" : "rto4e47-201-4b58-bc98-a924a4e7ad12",
    "payment_link_id" :  "rto4e47-201-4b58-bc98-a924a4e7ad12", // not in response if null
    "client_reference" :  "INV124", // not in response if null
    "end_to_end_id":  "REF1234", // not in response if null
      "status": "ACSC",
	"status_reason": "MS03"  // not in response if null
  },
  "timestamp": 1612783550980,
  "type": "payment.transaction.updated"
}

3. Payment Links - Payment Link updated

This event is triggered when a Payment Link is updated.

Example:

{
  "content": {
    "payment_link_id": "64e61033-be1e-4dd3-9564-f03e8a5b6874",
    "payment_link_status": "COMPLETED",
    "payment_link_client_reference": "INV124" // not in response if null
  },
  "timestamp": 1644507383234,
  "type": "payment.link.updated"
}