API V3Webhook events

Payment promise created/kept/broken/cancelled

Webhook triggered when a payment promise is created, kept (paid in full), broken (not paid in full after the due date and respite days) or cancelled. Contact POM to set up this webhook for your account.

Authorization

Authorization
string
header
required
OAuth 2.0 client credentials Grant

Body

application/json

The new PaymentPromise resource

id_client
integer
debtornumber
string
cid
integer
mpid
integer | null
payment_reference
string
id_request_client
string | null
event_type
enum<string>
One of:
payment_promise
payment_promise_success
payment_promise_fail
payment_promise_cancel
payment_promise_id
integer
status
enum<string>
One of:
active
fulfilled
broken
cancelled
amount
integer
Promised amount in cents
amount_paid
integer
Amount paid on the promise so far, in cents
due_date
string<date-time>
initiator
enum<string>
One of:
agent
self_service
event_date
string<date-time>
event_time
string

Example payload

{
  "id_client": 1234,
  "debtornumber": "D-1000",
  "cid": 2345678910,
  "payment_reference": "PAY-123456",
  "id_request_client": "REQ-123456",
  "payment_promise_id": 456,
  "amount": 25000,
  "amount_paid": 0,
  "due_date": "2026-10-15",
  "event_date": "2026-10-01",
  "event_time": "11:27"
}

Your response

application/json

PaymentPromise resource created

id
integer