Interface NotificationsApiServiceGrpc.AsyncService (1.0.0) 

public static interface NotificationsApiServiceGrpc.AsyncService

Service to manage notification subscriptions for merchants

Methods

createNotificationSubscription(CreateNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)

public default void createNotificationSubscription(CreateNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)

Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For MCAs, the business can create a subscription for all managed accounts or for a specific subaccount. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type):

  1. Subscription for all managed accounts + subscription for self.
  2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type):
  3. Multiple self subscriptions.
  4. Multiple "all managed accounts" subscriptions.
  5. "All managed accounts" subscription and partial subscriptions at the same time.
  6. Multiple partial subscriptions for the same target account.
Parameters
Name Description
request CreateNotificationSubscriptionRequest
responseObserver io.grpc.stub.StreamObserver<NotificationSubscription>

deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request, StreamObserver<Empty> responseObserver)

public default void deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request, StreamObserver<Empty> responseObserver)

Deletes a notification subscription for a merchant.

Parameters
Name Description
request DeleteNotificationSubscriptionRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getNotificationSubscription(GetNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)

public default void getNotificationSubscription(GetNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)

Gets notification subscriptions for an account.

Parameters
Name Description
request GetNotificationSubscriptionRequest
responseObserver io.grpc.stub.StreamObserver<NotificationSubscription>

getNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request, StreamObserver<NotificationSubscriptionHealthMetrics> responseObserver)

public default void getNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request, StreamObserver<NotificationSubscriptionHealthMetrics> responseObserver)

Retrieves notification subscription health metrics for a merchant. We recommend calling this periodically (hourly or daily) to monitor health of your callback endpoint.

Parameters
Name Description
request GetNotificationSubscriptionHealthMetricsRequest
responseObserver io.grpc.stub.StreamObserver<NotificationSubscriptionHealthMetrics>

listNotificationSubscriptions(ListNotificationSubscriptionsRequest request, StreamObserver<ListNotificationSubscriptionsResponse> responseObserver)

public default void listNotificationSubscriptions(ListNotificationSubscriptionsRequest request, StreamObserver<ListNotificationSubscriptionsResponse> responseObserver)

Gets all the notification subscriptions for a merchant.

Parameters
Name Description
request ListNotificationSubscriptionsRequest
responseObserver io.grpc.stub.StreamObserver<ListNotificationSubscriptionsResponse>

updateNotificationSubscription(UpdateNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)

public default void updateNotificationSubscription(UpdateNotificationSubscriptionRequest request, StreamObserver<NotificationSubscription> responseObserver)

Updates an existing notification subscription for a merchant.

Parameters
Name Description
request UpdateNotificationSubscriptionRequest
responseObserver io.grpc.stub.StreamObserver<NotificationSubscription>