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 webhook

Request

Retrieves a single webhook based on the id.

Path
idstringrequired

Responses

webhook found

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"
  }
}

Updates a webhook

Request

Updates a Webhook object. Returns the updated Webhook

Path
idstringrequired
Bodyapplication/json
descriptionstring or null

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

Example: "Webhook description"
namestring or null

Name of the webhook.

Example: "Webhook name"
urlstring or null(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.

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. ['all'] parameter can be supplied to enable all event types

Example: ["payment.created","payment.paid"]

Responses

webhook updated

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"
  }
}

Deletes a webhook

Request

Deletes a webhook. A deleted webhook will no longer send events to the endpoint.

Path
idstringrequired

Responses

webhook deleted

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"
  }
}