public class CustomerNotificationService
extends java.lang.Object
Service class for working with customer notification resources.
Customer Notifications represent the notification which is due to be sent to a customer after an event has happened. The event, the resource and the customer to be notified are all identified in the links property.
Note that these are ephemeral records - once the notification has been actioned in some way, it is no longer visible using this API.
Restricted: This API is currently only available for approved integrators - please get in touch if you would like to use this API.
| Modifier and Type | Class and Description |
|---|---|
static class |
CustomerNotificationService.CustomerNotificationHandleRequest
Request class for
handle(java.lang.String). |
| Constructor and Description |
|---|
CustomerNotificationService(HttpClient httpClient)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
CustomerNotificationService.CustomerNotificationHandleRequest |
handle(java.lang.String identity)
“Handling” a notification means that you have sent the notification yourself (and don’t want GoCardless to send it).
|
public CustomerNotificationService(HttpClient httpClient)
Constructor. Users of this library should have no need to call this - an instance of this class can be obtained by calling GoCardlessClient.customerNotifications().
public CustomerNotificationService.CustomerNotificationHandleRequest handle(java.lang.String identity)
“Handling” a notification means that you have sent the notification yourself (and don’t want GoCardless to send it). If the notification has already been actioned, or the deadline to notify has passed, this endpoint will return an already_actioned error and you should not take further action.