Webhook Endpoints

5 endpoints. Base URL https://api.paymentsonline.io, sandbox https://api.sandbox-paymentsonline.io.

Every request needs payments-api-key and payments-account.

GET/v1/webhook-endpoints

List all Webhook Endpoints

Returns a list of Webhook Endpoints. The Webhook Endpoints are sorted with the most recently created appearing first.

Query parameters

include_connected_accountsbooleanoptional
When true, returns webhook endpoints across the caller account and all descendant merchant accounts. Without this, only endpoints owned by the caller account are returned. Mirrors the same flag on EventListQueryParams.
offsetnumberoptional
The (zero-based) offset of the first item in the collection to return.
limitnumberoptional
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200PaginatedDto | object

has_morebooleanrequired
Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
limitnumberoptional
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.
offsetnumberoptional
The (zero-based) offset of the first item in the collection to return.
totalnumberoptional
The total items count.
itemsarray of WebhookEndpointrequired

POST/v1/webhook-endpoints

Create a Webhook Endpoint

Creates a Webhook Endpoint.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Request body application/jsonrequired

descriptionstringoptional
An optional description of what the webhook is used for.
enabled_eventsarray of string (* | account.updated | charge.captured | charge.expired | charge.failed | charge.succeeded | charge.pending | charge.refunded | …)required
The list of events to enable for this endpoint. You may specify ['*'] to enable all events.
urlstringrequired
The URL of the webhook endpoint.

Responses

201WebhookEndpoint

account_idstringrequired
The id of the associated account.
created_atstring date-timerequired
Time at which the object was created.
descriptionstringoptional
An optional description of what the webhook is used for.
enabled_eventsarray of string (* | account.updated | charge.captured | charge.expired | charge.failed | charge.succeeded | charge.pending | charge.refunded | …)required
The list of events to enable for this endpoint. You may specify ['*'] to enable all events.
idstringrequired
Unique identifier for the object.
inactive_atstring date-timeoptional
Timestamp of the most recent transition into inactive. Used as the reference date for promoting inactive → disabled: an endpoint must have been continuously inactive for the disabled threshold before it will be disabled. Cleared on any transition out of inactive.
reenabled_atstring date-timeoptional
Timestamp of the most recent re-enablement (partner or admin sets status → active/pending). Used as the reference date for health degradation when there is no prior successful delivery.
secretstringoptional
The endpoint's secret, used to generate webhook signatures. Only returned at creation.
statusstring (active | pending | inactive | disabled)required
The health status of the endpoint: - active — Normal operation. - pending — Re-enabled and awaiting a successful delivery. - inactive — No successful delivery in 3+ days. Events are queued but delivery is not attempted. - disabled — Has been inactive for 7+ days. Events are unrecoverable.
updated_atstring date-timerequired
Time at which the object was last updated.
urlstringrequired
The URL of the webhook endpoint.

DELETE/v1/webhook-endpoints/{id}

Delete a Webhook Endpoint

Deletes a Webhook Endpoint. This cannot be undone.

Path parameters

idstringrequired

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

204object

GET/v1/webhook-endpoints/{id}

Get a Webhook Endpoint

Retrieves the details of an existing Webhook Endpoint.

Path parameters

idstringrequired

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200WebhookEndpoint

account_idstringrequired
The id of the associated account.
created_atstring date-timerequired
Time at which the object was created.
descriptionstringoptional
An optional description of what the webhook is used for.
enabled_eventsarray of string (* | account.updated | charge.captured | charge.expired | charge.failed | charge.succeeded | charge.pending | charge.refunded | …)required
The list of events to enable for this endpoint. You may specify ['*'] to enable all events.
idstringrequired
Unique identifier for the object.
inactive_atstring date-timeoptional
Timestamp of the most recent transition into inactive. Used as the reference date for promoting inactive → disabled: an endpoint must have been continuously inactive for the disabled threshold before it will be disabled. Cleared on any transition out of inactive.
reenabled_atstring date-timeoptional
Timestamp of the most recent re-enablement (partner or admin sets status → active/pending). Used as the reference date for health degradation when there is no prior successful delivery.
secretstringoptional
The endpoint's secret, used to generate webhook signatures. Only returned at creation.
statusstring (active | pending | inactive | disabled)required
The health status of the endpoint: - active — Normal operation. - pending — Re-enabled and awaiting a successful delivery. - inactive — No successful delivery in 3+ days. Events are queued but delivery is not attempted. - disabled — Has been inactive for 7+ days. Events are unrecoverable.
updated_atstring date-timerequired
Time at which the object was last updated.
urlstringrequired
The URL of the webhook endpoint.

PATCH/v1/webhook-endpoints/{id}

Update a Webhook Endpoint

Updates the Webhook Endpoint by setting the values of the provided parameters. Any parameters not provided will be left unchanged.

Path parameters

idstringrequired

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Request body application/jsonrequired

descriptionstringoptional
An optional description of what the webhook is used for.
enabled_eventsarray of string (* | account.updated | charge.captured | charge.expired | charge.failed | charge.succeeded | charge.pending | charge.refunded | …)optional
The list of events to enable for this endpoint. You may specify ['*'] to enable all events.
statusstring (active)optional
Set to active to re-enable an inactive or disabled endpoint. The endpoint transitions to pending and is promoted to active automatically after the first successful delivery.
urlstringoptional
The URL of the webhook endpoint.

Responses

200WebhookEndpoint

account_idstringrequired
The id of the associated account.
created_atstring date-timerequired
Time at which the object was created.
descriptionstringoptional
An optional description of what the webhook is used for.
enabled_eventsarray of string (* | account.updated | charge.captured | charge.expired | charge.failed | charge.succeeded | charge.pending | charge.refunded | …)required
The list of events to enable for this endpoint. You may specify ['*'] to enable all events.
idstringrequired
Unique identifier for the object.
inactive_atstring date-timeoptional
Timestamp of the most recent transition into inactive. Used as the reference date for promoting inactive → disabled: an endpoint must have been continuously inactive for the disabled threshold before it will be disabled. Cleared on any transition out of inactive.
reenabled_atstring date-timeoptional
Timestamp of the most recent re-enablement (partner or admin sets status → active/pending). Used as the reference date for health degradation when there is no prior successful delivery.
secretstringoptional
The endpoint's secret, used to generate webhook signatures. Only returned at creation.
statusstring (active | pending | inactive | disabled)required
The health status of the endpoint: - active — Normal operation. - pending — Re-enabled and awaiting a successful delivery. - inactive — No successful delivery in 3+ days. Events are queued but delivery is not attempted. - disabled — Has been inactive for 7+ days. Events are unrecoverable.
updated_atstring date-timerequired
Time at which the object was last updated.
urlstringrequired
The URL of the webhook endpoint.