Single payment webhook examples

READ Status

Payment request read/viewed by Payer

{
  "eventId": "READ",
  "callBackUrl": https://webhook.site/019ac2ab-fab1-453e-a6d4-9f0cf7c652af,
  "smartRequestId": "a1b8c501-88c3-4868-9e7d-bab4868e4348",
  "amountDue": "6.00",
  "status": "PENDING",
  "paymentStatus": "UNPAID",
  "billerReference": "testing",
  "updatedDate": "08/25/2022 09:09:41",
  "billerParticipantId": "5311"
}

PAYALL Status

Payment request authorised by Payer and payment successfully made in full

{
  "eventId": "PAYALL",
  "callBackUrl": https://webhook.site/019ac2ab-fab1-453e-a6d4-9f0cf7c652af,
  "smartRequestId": "f921b837-f878-45e9-bfe6-628435d949f2",
  "amountDue": "5.00",
  "status": "CLOSED",
  "paymentStatus": "FULLPAID",
  "billerReference": "testing",
  "updatedDate": "08/25/2022 10:04:18",
  "billerParticipantId": "5311"
}

PAYPARTIAL Status

Payment request authorised by Payer and Partial payment successfully made.

amountDue is the original amount of the payment request
amountPaid is the total amount paid against this payment request to date
partialPaymentAmount is the latest part payment amount

partialPaymentsRemaining shows how many more payments that could be made against this payment request. Where allowed, up to 5 partial payments can be made (the final one being PAYALL) per payment request. The example below is the 2nd part payment (£1.45) against a transaction, where previous part payment was for £1.20.

{
  "eventId": "PAYPARTIAL",
  "callBackUrl": https://webhook.site/019ac2ab-fab1-453e-a6d4-9f0cf7c652af,
  "smartRequestId": "a1b8c501-88c3-4868-9e7d-bab4868e4348",
  "amountDue": "6.00",
  "status": "PENDING",
  "paymentStatus": "PARTPAID",
  "billerReference": "testing",
  "updatedDate": "08/25/2022 10:06:33",
  "billerParticipantId": "5311",
  "partialPaymentsRemaining": "3",
  "paymentDate": "01/01/0001 00:00:00",
  "amountPaid": "2.65",
  "partialPaymentAmount": "1.45"
}

DECLINE Status

Payment request cancelled/declined by payer within Ordo user journey .
If Partial Payments have been made before the payer declined, the Payment Status would be ‘PARTPAID’.

{
  "eventId": "DECLINE",
  "callBackUrl": https://webhook.site/019ac2ab-fab1-453e-a6d4-9f0cf7c652af,
  "smartRequestId": "a1b8c501-88c3-4868-9e7d-bab4868e4348",
  "amountDue": "6.00",
  "status": "DECLINED",
  "paymentStatus": "PARTPAID",
  "billerReference": "testing",
  "updatedDate": "08/25/2022 10:07:12",
  "billerParticipantId": "5311"
}

WITHDRAW Status

Payment request withdrawn by merchant
If Partial Payments have been made, the Payment Status would be ‘PARTPAID’.

{
  "eventId": "WITHDRAW",
  "callBackUrl": https://webhook.site/019ac2ab-fab1-453e-a6d4-9f0cf7c652af,
  "smartRequestId": "c2326a39-fceb-48b0-a749-50835a1ba835",
  "amountDue": "5.00",
  "status": "WITHDRWN",
  "paymentStatus": "UNPAID",
  "billerReference": "testing",
  "updatedDate": "08/24/2022 14:08:13",
  "billerParticipantId": "5310"
}

EXPIRE Status

Payment request reaches the merchant-set expiry date.
This only occurs if the payment request has not been closed, by full payment/decline/withdrawal ahead of the expiry date. If Partial Payments have been made, the Payment Status would be ‘PARTPAID’.

{
  "eventId": "EXPIRE",
  "callBackUrl": https://webhook.site/019ac2ab-fab1-453e-a6d4-9f0cf7c652af,
  "smartRequestId": "ab04e122-356b-49e1-9070-46c3d0ee8209",
  "amountDue": "0.02",
  "status": "EXPIRED",
  "paymentStatus": "UNPAID",
  "billerReference": "test expired",
  "updatedDate": "08/23/2022 11:09:54",
  "billerParticipantId": "5311"
}

BLOCK Status

Payer, who has registered with Ordo, views a payment request from within the Ordo service rather than by following the payment link, they have an option to not just Decline, but also request that Ordo don’t send any further payment requests to them. This is a very narrow edge-case.
In this event, if the Payer chooses to decline a payment request, they are also presented with an option to block that Biller from sending future payment requests. To date, this has only ever been exercised by Ordo ourselves while live proving functionality.

{
  "eventId": "BLOCK",
  "callBackUrl": https://webhook.site/019ac2ab-fab1-453e-a6d4-9f0cf7c652af,
  "smartRequestId": "f7da2658-088f-47a6-b664-4f0f948f331b",
  "amountDue": "6.00",
  "status": "DECLINED",
  "paymentStatus": "UNPAID",
  "billerReference": "DECLINEBLOCK",
  "updatedDate": "08/24/2022 13:12:41",
  "billerParticipantId": "5311"
}