eventSubscriptions

Create event subscription

Changed on

Use this method to create an event subscription that we use to notify you when an event occurs, for example, when we change the status of a processing account.

In the request, include the events that you want to subscribe to and the public endpoint that we send event notifications to. For a complete list of events that you can subscribe to, go to Events List.

In the response, our gateway returns the id of the event subscription, which you can use to perform follow-on actions.

post/event-subscriptions

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/event-subscriptions
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

idinteger

Unique identifier that we assigned to the event subscription.

enabledboolean required

Indicates if we should notify you when the event occurs. The value is one of the following:

  • true - We notify you when the event occurs.
  • false - We don't notify you when the event occurs.
status'registered' | 'suspended' | 'failed'

Status of the subscription. We return one of the following values:

  • registered - You have set up the subscription, and we will notify you when an event occurs.
  • suspended - We have deactivated the event subscription, and we won't notify you when an event occurs.
  • failed - We couldn't contact your URI endpoint. We email the supportEmailAddress.
eventTypesstring[] required

Array of events that you want to subscribe to. For a list of events, go to Events List.

metadataEventSubscriptionMetadata

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Response

Successful request. We created the event subscription.

idinteger

Unique identifier that we assigned to the event subscription.

enabledboolean required

Indicates if we should notify you when the event occurs. The value is one of the following:

  • true - We notify you when the event occurs.
  • false - We don't notify you when the event occurs.
status'registered' | 'suspended' | 'failed'

Status of the subscription. We return one of the following values:

  • registered - You have set up the subscription, and we will notify you when an event occurs.
  • suspended - We have deactivated the event subscription, and we won't notify you when an event occurs.
  • failed - We couldn't contact your URI endpoint. We email the supportEmailAddress.
eventTypesstring[] required

Array of events that you want to subscribe to. For a list of events, go to Events List.

metadataEventSubscriptionMetadata

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Changes