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

Retrieves an event

Request

Retrieves a single event based on the id.

Path
idstringrequired

Responses

event found

Bodyapplication/json
idstringrequired
Example: "EVYKMZD2E452EDFB48"
typestringrequired
Value"event"
Example: "event"
event_typestringrequired
Example: "payment.created"
payloadchargeback (object) or payment (object) or refund (object)required
Example: {"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"initialized","return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}}
One of:
payload.​idstringrequired
Example: "PPH25H07JYWLR7PA82"
payload.​typestringrequired
Value"chargeback"
Example: "payment"
payload.​amountintegerrequired
Example: 1000
payload.​descriptionstringrequired
Example: "Test Payment"
payload.​reasonstring or nullrequired
payload.​currencystringrequired
Value"EUR"
Example: "EUR"
payload.​paymentstringrequired
payload.​statestringrequired
Example: "initialized"
payload.​charged_back_atstring or null(date-time)required
payload.​created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
payload.​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}
payload.​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"
payload.​_links.​paymentstring(uri)required
created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/events/EVYKMZD2E452EDFB48"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/events/EVYKMZD2E452EDFB48"
Response
application/json
{ "id": "EVYKMZD2E452EDFB48", "type": "event", "event_type": "payment.created", "payload": { "id": "PPH25H07JYWLR7PA82", "type": "payment", "amount": 1000, "description": "Test Payment", "currency": "EUR", "state": "initialized", "return_url": "https://example.com/thank-you", "cancel_url": "https://example.com/cancel", "paid_at": "2023-06-30T12:44:35Z", "created_at": "2023-06-30T12:40:10Z", "_links": {} }, "created_at": "2023-06-30T12:40:10Z", "_links": { "self": "https://api.paypro.nl/events/EVYKMZD2E452EDFB48" } }

Retrieve a list of events

Request

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

Responses

events found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(event)required
Example: [{"id":"EVYKMZD2E452EDFB48","type":"event","event_type":"payment.created","payload":{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"initialized","return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}},"created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/events/EVYKMZD2E452EDFB48"}}]
data[].​idstringrequired
Example: "EVYKMZD2E452EDFB48"
data[].​typestringrequired
Value"event"
Example: "event"
data[].​event_typestringrequired
Example: "payment.created"
data[].​payloadchargeback (object) or payment (object) or refund (object)required
Example: {"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"initialized","return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}}
One of:
data[].​payload.​idstringrequired
Example: "PPH25H07JYWLR7PA82"
data[].​payload.​typestringrequired
Value"chargeback"
Example: "payment"
data[].​payload.​amountintegerrequired
Example: 1000
data[].​payload.​descriptionstringrequired
Example: "Test Payment"
data[].​payload.​reasonstring or nullrequired
data[].​payload.​currencystringrequired
Value"EUR"
Example: "EUR"
data[].​payload.​paymentstringrequired
data[].​payload.​statestringrequired
Example: "initialized"
data[].​payload.​charged_back_atstring or null(date-time)required
data[].​payload.​created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​payload.​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}
data[].​payload.​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"
data[].​payload.​_links.​paymentstring(uri)required
data[].​created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/events/EVYKMZD2E452EDFB48"}
data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/events/EVYKMZD2E452EDFB48"
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" } }

Webhooks

Operations