Changes generated by 9b350f6974d76e3211130f007ee8a2e612f1a598

This commit was automatically created from gocardless/gocardless-dotnet-template@9b350f6 by the `push-files` action. Workflow run: https://github.com/gocardless/gocardless-dotnet-template/actions/runs/13162965724
gocardless · Feb 5, 2025 · fe6f346 · fe6f346
1 parent e541d65
commit fe6f346
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 6 deletions.
diff --git a/GoCardless/Resources/BankAuthorisation.cs b/GoCardless/Resources/BankAuthorisation.cs
@@ -90,9 +90,14 @@ public class BankAuthorisation
         /// the `redirect_uri`, in which case you should
         /// prompt the user to try the bank authorisation step again.
         /// 
-        /// The `redirect_uri` you provide should handle the `outcome` query
-        /// parameter for displaying the result of the
-        /// bank authorisation as outlined above.
+        /// Please note: bank authorisations can still fail despite an
+        /// `outcome=success` on the `redirect_uri`. It is therefore recommended
+        /// to wait for the relevant bank authorisation event, such as
+        /// [`BANK_AUTHORISATION_AUTHORISED`](#billing-request-bankauthorisationauthorised),
+        /// [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied),
+        /// or
+        /// [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed)
+        /// in order to show the correct outcome to the user.
         /// 
         /// The BillingRequestFlow ID will also be appended to the
         /// `redirect_uri` as query parameter `id=BRF123`.

diff --git a/GoCardless/Services/BankAuthorisationService.cs b/GoCardless/Services/BankAuthorisationService.cs
@@ -117,9 +117,14 @@ public class BankAuthorisationLinks
         /// the `redirect_uri`, in which case you should
         /// prompt the user to try the bank authorisation step again.
         /// 
-        /// The `redirect_uri` you provide should handle the `outcome` query
-        /// parameter for displaying the result of the
-        /// bank authorisation as outlined above.
+        /// Please note: bank authorisations can still fail despite an
+        /// `outcome=success` on the `redirect_uri`. It is therefore recommended
+        /// to wait for the relevant bank authorisation event, such as
+        /// [`BANK_AUTHORISATION_AUTHORISED`](#billing-request-bankauthorisationauthorised),
+        /// [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied),
+        /// or
+        /// [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed)
+        /// in order to show the correct outcome to the user.
         /// 
         /// The BillingRequestFlow ID will also be appended to the
         /// `redirect_uri` as query parameter `id=BRF123`.