GoCardlessClient.Resources.CustomerNotifications (GoCardlessClient v2.0.0)

Copy Markdown View Source

GoCardless Customer Notifications API.

Allows you to mark a customer notification as handled when you are managing notifications yourself (rather than letting GoCardless send them automatically).

This is used in custom notification flows. When you handle a notification yourself (e.g. send your own branded email), you call handle/3 to signal GoCardless that it should not send a duplicate notification.

Example

# In your notification handler:
def send_mandate_confirmation(notification_id) do
  # Send your own branded email to the customer...
  send_mandate_email()

  # Then tell GoCardless you've handled it
  {:ok, _} = GoCardlessClient.Resources.CustomerNotifications.handle(
    client,
    notification_id
  )
end

Summary

Functions

handle(client, id, params \\ %{}, opts \\ [])

Marks a customer notification as handled by you.

Functions

handle(client, id, params \\ %{}, opts \\ [])

@spec handle(GoCardlessClient.Client.t(), String.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Marks a customer notification as handled by you.

After calling this, GoCardless will not send its own notification for this event.