From e203957c5950ae2397c000aca4e97c62a5475799 Mon Sep 17 00:00:00 2001 From: "Bradbury, Doug" Date: Mon, 18 Oct 2021 11:50:48 -0500 Subject: [PATCH 1/3] Draft notifications hook --- notifications.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 notifications.md diff --git a/notifications.md b/notifications.md new file mode 100644 index 0000000..ba3a7fe --- /dev/null +++ b/notifications.md @@ -0,0 +1,53 @@ +#Notifications API + +Applications may register for notifications from DadePay. + +Notfications are sent as POST requests to the url provided. + +### Event Types: + payment_commented + payment_clarified + posting_completed + posting_undone + payments_imported + load_completed + file_transfer_failed + file_transfer_completed + + +## Post + +### Authorization + OAuth 2 token flow + +### Headers + CorrelationId: a unique random string to track this request + ContentType: application/json + +### Body +All Event contain the following fields: + + billerId: The ID of the biller in DadePay + billerGroup: The billers Group + eventName: One of the above Event Names + EventDate: yyyy-MM-dd'T'HH:mm:ss.SSSZ. + +Additional Fields: + + paymentId: ID of the payments in Dadepay; used in: payment_commented, payment_clarified. + reason: Reason for the reveral; used for posting_undone + jobStatus: string; used in: load_completed, file_transfer_failed, file_transfer_completed, posting_completed + + +#### Example: file_transfer_failed +``` +{ + "billerId": "745", + "billerGroup": "Q84233", + "eventName": "file_transfer_failed", + "eventDate": "2019-05-14T13:03:45.221Z", + "paymentId": "1236625", + "reason": "Reason Text", + “jobStatus”:”pass”” +} +``` From 11730ea91922742d6c3aca30877b036baf35b756 Mon Sep 17 00:00:00 2001 From: "Bradbury, Doug" Date: Mon, 18 Oct 2021 11:52:56 -0500 Subject: [PATCH 2/3] formatting --- notifications.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/notifications.md b/notifications.md index ba3a7fe..04fe00a 100644 --- a/notifications.md +++ b/notifications.md @@ -1,10 +1,11 @@ -#Notifications API +# Notifications API Applications may register for notifications from DadePay. Notfications are sent as POST requests to the url provided. ### Event Types: + payment_commented payment_clarified posting_completed @@ -18,28 +19,31 @@ Notfications are sent as POST requests to the url provided. ## Post ### Authorization - OAuth 2 token flow + OAuth 2 token flow ### Headers - CorrelationId: a unique random string to track this request - ContentType: application/json + +CorrelationId: a unique random string to track this request +ContentType: application/json ### Body + All Event contain the following fields: - billerId: The ID of the biller in DadePay - billerGroup: The billers Group - eventName: One of the above Event Names - EventDate: yyyy-MM-dd'T'HH:mm:ss.SSSZ. +billerId: The ID of the biller in DadePay +billerGroup: The billers Group +eventName: One of the above Event Names +EventDate: yyyy-MM-dd'T'HH:mm:ss.SSSZ. Additional Fields: - paymentId: ID of the payments in Dadepay; used in: payment_commented, payment_clarified. - reason: Reason for the reveral; used for posting_undone - jobStatus: string; used in: load_completed, file_transfer_failed, file_transfer_completed, posting_completed +paymentId: ID of the payments in Dadepay; used in: payment_commented, payment_clarified. +reason: Reason for the reveral; used for posting_undone +jobStatus: string; used in: load_completed, file_transfer_failed, file_transfer_completed, posting_completed #### Example: file_transfer_failed + ``` { "billerId": "745", From 8f0211ba5fe222c6f76034186a5618bf250307ab Mon Sep 17 00:00:00 2001 From: "Bradbury, Doug" Date: Mon, 18 Oct 2021 11:54:00 -0500 Subject: [PATCH 3/3] more formatting --- notifications.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/notifications.md b/notifications.md index 04fe00a..9364c0c 100644 --- a/notifications.md +++ b/notifications.md @@ -6,14 +6,14 @@ Notfications are sent as POST requests to the url provided. ### Event Types: - payment_commented - payment_clarified - posting_completed - posting_undone - payments_imported - load_completed - file_transfer_failed - file_transfer_completed + - payment_commented + - payment_clarified + - posting_completed + - posting_undone + - payments_imported + - load_completed + - file_transfer_failed + - file_transfer_completed ## Post @@ -23,23 +23,23 @@ Notfications are sent as POST requests to the url provided. ### Headers -CorrelationId: a unique random string to track this request -ContentType: application/json + - CorrelationId: a unique random string to track this request + - ContentType: application/json ### Body All Event contain the following fields: -billerId: The ID of the biller in DadePay -billerGroup: The billers Group -eventName: One of the above Event Names -EventDate: yyyy-MM-dd'T'HH:mm:ss.SSSZ. + - billerId: The ID of the biller in DadePay + - billerGroup: The billers Group + - eventName: One of the above Event Names + - EventDate: yyyy-MM-dd'T'HH:mm:ss.SSSZ. Additional Fields: -paymentId: ID of the payments in Dadepay; used in: payment_commented, payment_clarified. -reason: Reason for the reveral; used for posting_undone -jobStatus: string; used in: load_completed, file_transfer_failed, file_transfer_completed, posting_completed + - paymentId: ID of the payments in Dadepay; used in: payment_commented, payment_clarified. + - reason: Reason for the reveral; used for posting_undone + - jobStatus: string; used in: load_completed, file_transfer_failed, file_transfer_completed, posting_completed #### Example: file_transfer_failed