Recurring payment agreement webhook examples

Mandate

INITIATED Status

Mandate created in Ordo

{
  "eventId": "d247322a-bfd6-4a16-9f2b-a539e2f36622",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "status": "INITIATED",
  "billerReference": "MandateRef",
  "vrpType": "SWEEPING",
  "billerParticipantId": "1226"
}

AWAITING AUTHORISATION Status

Mandate read/viewed by Payer

{
  "eventId": "b133a7ff-7277-482b-8834-2e9bc439401c",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "status": "READ",
  "billerReference": "MandateRef",
  "vrpType": "SWEEPING",
  "updatedDate": "30-01-2023 08:09:35",
  "billerParticipantId": "1226"
}

AUTHORISED Status

Mandate authorised by Payer

{
  "eventId": "62f55f79-41b0-4daf-b7a7-f1cdcafdc3ac",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "status": "AUTHORISED",
  "billerReference": "MandateRef",
  "vrpType": "SWEEPING",
  "updatedDate": "30-01-2023 08:12:02",
  "billerParticipantId": "1226"
}

CANCELLED (cancelledByOrdo) Status

Mandate cancelled by Ordo

{
  "eventId": "54c7a302-4d3d-46c5-8daa-f9f46e6622f7",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "status": "CANCELLED",
  "cancelledBy": "cancelledByOrdo",
  "billerReference": "MandateRef",
  "vrpType": "SWEEPING",
  "updatedDate": "30-01-2023 11:51:21",
  "billerParticipantId": "1226"
}

CANCELLED (cancelledByPayerwithout Authorisation) Status

Mandate cancelled/declined by Payer within Ordo user journey

{
  "eventId": "54c7a302-4d3d-46c5-8daa-f9f46e6622f7",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "status": "CANCELLED",
  "cancelledBy": "cancelledByPayerWithoutAuthorisation",
  "billerReference": "MandateRef",
  "vrpType": "SWEEPING",
  "updatedDate": "30-01-2023 11:56:53",
  "billerParticipantId": "1226"
}

CANCELLED (cancelledByPayerAfter Authorisation) Status

Mandate cancelled by Payer within Ordo after authorising

{
  "eventId": "54c7a302-4d3d-46c5-8daa-f9f46e6622f7",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "status": "CANCELLED",
  "cancelledBy": "cancelledByPayerAfterAuthorisation",
  "billerReference": "MandateRef",
  "vrpType": "SWEEPING",
  "updatedDate": "30-01-2023 11:56:53",
  "billerParticipantId": "1226"
}

CANCELLED (cancelledByPayerWithinASPSP) Status

Mandate cancelled by Payer within ASPSP/Bank

{
  "eventId": "54c7a302-4d3d-46c5-8daa-f9f46e6622f7",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "status": "CANCELLED",
  "cancelledBy": "cancelledByPayerWithinAspsp",
  "billerReference": "MandateRef",
  "vrpType": "SWEEPING",
  "updatedDate": "30-01-2023 11:56:53",
  "billerParticipantId": "1226"
}

CANCELLED (cancelledByMerchant) Status

Mandate cancelled by Merchant

{
  "eventId": "54c7a302-4d3d-46c5-8daa-f9f46e6622f7",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "status": "CANCELLED",
  "cancelledBy": "cancelledByMerchant",
  "billerReference": "MandateRef",
  "vrpType": "SWEEPING",
  "updatedDate": "30-01-2023 11:56:53",
  "billerParticipantId": "1226"
}

EXPIRED Status

Mandate reaches the Merchant-set expiry date

{
  "eventId": "91c1ea7f-b762-4039-88ab-f90952a88e07",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "status": "EXPIRED",
  "billerReference": "MandateRef",
  "vrpType": "SWEEPING",
  "billerParticipantId": "1226"
}

Transaction

PENDING Status

Transaction processed - awaiting confirmation

{
  "eventId": "e4fecbdf-62bd-4478-a5ad-63029bf9ea4d",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "amount": "7.00",
  "transactionId": "42413db8-5344-4aba-8cb4-242b8141b5b7",
  "status": "PENDING",
  "paymentStatus": "UNPAID",
  "billerReference": "TransRef",
  "updatedDate": "30-01-2023 08:12:09",
  "billerParticipantId": "1226"
}

CLOSED Status

Transaction accepted by ASPSP/Bank and payment successfully made

{
  "eventId": "c4b25533-83e5-4478-a3f5-93db265b80d4",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "amount": "7.00",
  "transactionId": "42413db8-5344-4aba-8cb4-242b8141b5b7",
  "status": "CLOSED",
  "paymentStatus": "FULLPAID",
  "billerReference": "TransRef",
  "updatedDate": "30-01-2023 08:12:40",
  "billerParticipantId": "1226"
}

REJECTED Status

Transaction has failed validation in Ordo - typically, transaction exceeds the Mandate parameters

{
  "eventId": "95652bc7-ee15-49aa-9806-de52e7b1c009",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "amount": "7.00",
  "transactionId": "42413db8-5344-4aba-8cb4-242b8141b5b7",
  "status": "REJECTED",
  "paymentStatus": "UNPAID",
  "billerReference": "TransRef",
  "updatedDate": "30-01-2023 08:10:40",
  "billerParticipantId": "1226"
}

DECLINED Status

Transaction failed at ASPSP/Bank - typically, due to insufficient funds when transaction presented to ASPSP/Bank

{
  "eventId": "95652bc7-ee15-49aa-9806-de52e7b1c009",
  "callBackUrl": "https://webhook.site/fd8dec46-d280-4f82-a894-ed3145abee1b",
  "mandateId": "19493d7b-1813-44a7-8108-fe0e33f4c0ba",
  "amount": "7.00",
  "transactionId": "42413db8-5344-4aba-8cb4-242b8141b5b7",
  "status": "DECLINED",
  "paymentStatus": "UNPAID",
  "billerReference": "TransRef",
  "updatedDate": "30-01-2023 08:10:40",
  "billerParticipantId": "1226"
}