Documentation

Account Data webhook examples

Consent

INITIATED Status

Consent created in Ordo

{
  "eventId": "c67a28f3-bc1c-424c-93ed-5fdeedba21d4",
  "callBackUrl": "https://webhook.site/Ordo",
  "aisConsentId": "AIS-634478d3a85146cdb815f3ee83",
  "status": "INITIATED",
  "merchantReference": "SAVINGS",
  "billerParticipantId": "1225"
}

AUTHORISED Status

Consent authorised by end customer

{
  "eventId": "1f5ee3ed-6f58-4a5f-8fbc-1959a8dc87bf",
  "callBackUrl": "https://webhook.site/Ordo",
  "aisConsentId": "AIS-634478d3a85146cdb815f3ee83",
  "status": "AUTHORISED",
  "merchantReference": "SAVINGS",
  "updatedDate": "16-12-2024 09:46:36",
  "billerParticipantId": "1225"
}

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

Consent cancelled by end customer within Ordo after authorising

{
  "eventId": "02f4eb20-687b-4974-8177-367bdb69061a",
  "callBackUrl": "https://webhook.site/Ordo",
  "aisConsentId": "AIS-0e42168b0fc14f46a8c716d333",
  "status": "CANCELLED",
  "cancelledBy": "cancelledByPayerAfterAuthorisation",
  "merchantReference": "m",
  "updatedDate": "17-12-2024 05:48:04",
  "billerParticipantId": "1225"
}

CANCELLED (cancelledByPayerWithinASPSP) Status

Mandate cancelled by Payer within ASPSP/Bank

{
  "eventId": "c0614ba4-6c70-45ad-9a8a-30ef7c94f734",
  "callBackUrl": "https://webhook.site/Ordo",
  "aisConsentId": "AIS-9841636e4b4d4e74ba08197ab6",
  "status": "CANCELLED",
  "cancelledBy": "cancelledByPayerWithinAspsp",
  "merchantReference": "TBCanc",
  "updatedDate": "17-12-2024 07:53:15",
  "billerParticipantId": "2005"
}

CANCELLED (cancelledByMerchant) Status

Mandate cancelled by Merchant

{
  "eventId": "8eb2af07-7060-4620-b9d3-6af68c5d0bbe",
  "callBackUrl": "https://webhook.site/Ordo",
  "aisConsentId": "AIS-29c0d942f4a24cd7a70e08b55b",
  "status": "CANCELLED",
  "cancelledBy": "cancelledByMerchant",
  "merchantReference": "m",
  "updatedDate": "17-12-2024 05:44:33",
  "billerParticipantId": "1225"
}

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"
}

Data Request

Requested Status

Data Request sent to the bank

{
  "eventId": "29e9bfdb-39cc-47cc-bd9c-97ecba28bc02",
  "callBackUrl": "https://webhook.site/Ordo",
  "aisDataRequestId": "ee0029db-e7a2-42de-b814-9187f338dfd6",
  "aisConsentId": "AIS-29c0d942f4a24cd7a70e08b55b",
  "status": "REQUESTED",
  "merchantReference": "Example",
  "billerParticipantId": "1225",
  "updatedDate": "16-12-2024 14:00:02",
  "createdDate": "16-12-2024 14:00:00"
}

To be Collected Status

Data Request received from bank and stored on Ordo platform- awaiting collection

{
  "eventId": "49f03051-c1c7-47e8-a2a4-86d2ee8c2268",
  "callBackUrl": "https://webhook.site/Ordo",
  "aisDataRequestId": "ee0029db-e7a2-42de-b814-9187f338dfd6",
  "aisConsentId": "AIS-29c0d942f4a24cd7a70e08b55b",
  "status": "TOBECOLLECTED",
  "merchantReference": "Example",
  "billerParticipantId": "1225",
  "updatedDate": "16-12-2024 14:00:06",
  "createdDate": "16-12-2024 14:00:00"
}

​Collected Status

Data Request retrieved from Ordo platform

{
  "eventId": "ddd411af-84d2-4dcb-b16a-0c2312b21acf",
  "callBackUrl": "https://webhook.site/Ordo",
  "aisDataRequestId": "ee0029db-e7a2-42de-b814-9187f338dfd6",
  "aisConsentId": "AIS-29c0d942f4a24cd7a70e08b55b",
  "status": "COLLECTED",
  "merchantReference": "Example",
  "billerParticipantId": "1225",
  "updatedDate": "16-12-2024 14:01:08",
  "createdDate": "16-12-2024 14:00:00"
}

Rejected Status

Data Request