PayPro API Reference (v1)

Servers
https://api.paypro.nl/

Payments

Operations

Refunds

Operations

Chargebacks

Operations

Pay methods

Operations

Customers

Operations

Mandates

Operations

Subscriptions

Operations

Subscription periods

Operations

Installment plans

Operations

Installment plan periods

Operations

Events

Operations

Webhooks

Operations

Retrieves a list of webhooks

Request

Retrieve a list of webhooks that have been created for your account. The webhooks are sorted, with the most recent first.

Responses

webhooks found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(webhook)required
Example: [{"id":"WHXFPVRLXYL3U7","type":"webhook","name":"Webhook Name","description":"Webhook Description","active":true,"url":"https://example.com/webhook","secret":"V9xVoX4sVJE8x41hATbFYZJ5qd6HALhN","enabled_event_types":["payment.created","payment.paid"],"created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/webhooks/WHXFPVRLXYL3U7"}}]
data[].​idstringrequired
Example: "WHXFPVRLXYL3U7"
data[].​typestringrequired
Value"webhook"
Example: "webhook"
data[].​namestringrequired
Example: "Webhook Name"
data[].​descriptionstringrequired
Example: "Webhook Description"
data[].​activebooleanrequired
Example: true
data[].​urlstring(uri)required
Example: "https://example.com/webhook"
data[].​secretstringrequired
Example: "V9xVoX4sVJE8x41hATbFYZJ5qd6HALhN"
data[].​enabled_event_typesArray of strings(event_types)
Items Enum"customer.created""customer.updated""chargeback.created""payout.created""payout.approved""payout.rejected""payout.failed""payout.paid""payment.created""payment.started"
Example: ["payment.created","payment.paid"]
data[].​created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/webhooks/WHXFPVRLXYL3U7"}
data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/webhooks/WHXFPVRLXYL3U7"
countintegerrequired
_linksobjectrequired
_links.​selfstring(uri)required
_links.​nextstring(uri)
_links.​prevstring(uri)
Response
application/json
{
  "type": "list",
  "data": [
    { … }
  ],
  "count": 0,
  "_links": {
    "self": "http://example.com",
    "next": "http://example.com",
    "prev": "http://example.com"
  }
}

Creates a webhook

Request

Creates a Webhook object.

A webhook needs to have a name, description and a url. By default the Webhook will be active and subscribed to all event types. You can add the parameter active to false to make it inactive.

Bodyapplication/json
descriptionstring

Description of the webhook. It describes what this webhook is used for.

Example: "Webhook description"
namestring

Name of the webhook.

Example: "Webhook name"
urlstring(uri)

The URL of the webhook endpoint

Example: "https://www.example.org/webhook"
activeboolean or null

When active is true this webhook endpoint will receive events.

Default true
Example: true
enabled_event_typesArray of all_event_types (string) or event_types (string) or null

Event types that will be sent to the webhook endpoint. If event_types are not supplied, all event types will be sent. Also, you can supply ['all'] to enable all event types.

Example: ["all"]

Responses

webhook created

Bodyapplication/json
idstringrequired
Example: "WHXFPVRLXYL3U7"
typestringrequired
Value"webhook"
Example: "webhook"
namestringrequired
Example: "Webhook Name"
descriptionstringrequired
Example: "Webhook Description"
activebooleanrequired
Example: true
urlstring(uri)required
Example: "https://example.com/webhook"
secretstringrequired
Example: "V9xVoX4sVJE8x41hATbFYZJ5qd6HALhN"
enabled_event_typesArray of strings(event_types)
Items Enum"customer.created""customer.updated""chargeback.created""payout.created""payout.approved""payout.rejected""payout.failed""payout.paid""payment.created""payment.started"
Example: ["payment.created","payment.paid"]
created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/webhooks/WHXFPVRLXYL3U7"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/webhooks/WHXFPVRLXYL3U7"
Response
application/json
{
  "id": "WHXFPVRLXYL3U7",
  "type": "webhook",
  "name": "Webhook Name",
  "description": "Webhook Description",
  "active": true,
  "url": "https://example.com/webhook",
  "secret": "V9xVoX4sVJE8x41hATbFYZJ5qd6HALhN",
  "enabled_event_types": [
    "payment.created",
    "payment.paid"
  ],
  "created_at": "2023-06-30T12:40:10Z",
  "_links": {
    "self": "https://api.paypro.nl/webhooks/WHXFPVRLXYL3U7"
  }
}