PayPro API Reference (v1)

Servers
https://api.paypro.nl/

Payments

Operations

Retrieves a payment

Request

Retrieves a single payment based on the id.

Path
idstringrequired

Responses

payment found

Bodyapplication/json
idstringrequired
Example: "PPH25H07JYWLR7PA82"
typestringrequired
Value"payment"
Example: "payment"
amountintegerrequired
Example: 1000
descriptionstringrequired
Example: "Test Payment"
currencystringrequired
Value"EUR"
Example: "EUR"
pay_methodpay_method (object) or null_type (any)required
Example: {"id":"ideal","type":"pay_method","name":"iDEAL","currencies":["EUR"],"minimum_amount":10,"maximum_amount":5000000,"details":{"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}}
Any of:
pay_method.​idstringrequired
Example: "ideal"
pay_method.​typestringrequired
Value"pay_method"
Example: "pay_method"
pay_method.​namestringrequired
Example: "iDEAL"
pay_method.​currenciesArray of strings
Items Value"EUR"
Example: ["EUR"]
pay_method.​minimum_amountinteger
Example: 10
pay_method.​maximum_amountinteger
Example: 5000000
pay_method.​detailsobject
Example: {"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}
statestringrequired
Example: "paid"
refunded_amountintegerrequired
return_urlstring or null(uri)required
Example: "https://example.com/thank-you"
cancel_urlstring or null(uri)required
Example: "https://example.com/cancel"
metadataobjectrequired
Example: {}
customerstring or nullrequired
Example: "CU7JRN6W6K3DA9"
mandatestring or nullrequired
Example: "MD6ULYXJ4HP9RJ"
subscriptionstring or nullrequired
installment_planstring or nullrequired
paid_atstring or null(date-time)required
Example: "2023-06-30T12:44:35Z"
created_atstring or null(date-time)required
Example: "2023-06-30T12:40:10Z"
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"
_links.​customerstring(uri)
Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"
_links.​mandatestring(uri)
Example: "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"
_links.​subscriptionstring(uri)
_links.​installment_planstring(uri)
_links.​checkoutstring(uri)
Response
application/json
{ "id": "PPH25H07JYWLR7PA82", "type": "payment", "amount": 1000, "description": "Test Payment", "currency": "EUR", "pay_method": { "id": "ideal", "type": "pay_method", "name": "iDEAL", "currencies": [ … ], "minimum_amount": 10, "maximum_amount": 5000000, "details": { … } }, "state": "paid", "refunded_amount": 0, "return_url": "https://example.com/thank-you", "cancel_url": "https://example.com/cancel", "metadata": {}, "customer": "CU7JRN6W6K3DA9", "mandate": "MD6ULYXJ4HP9RJ", "subscription": null, "installment_plan": null, "paid_at": "2023-06-30T12:44:35Z", "created_at": "2023-06-30T12:40:10Z", "_links": { "self": "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82", "customer": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9", "mandate": "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ" } }

Cancels a payment

Request

Cancels a payment. It is possible to cancel payment only in open or initialiazed state.

Path
idstringrequired

Responses

payment canceled

Bodyapplication/json
idstringrequired
Example: "PPH25H07JYWLR7PA82"
typestringrequired
Value"payment"
Example: "payment"
amountintegerrequired
Example: 1000
descriptionstringrequired
Example: "Test Payment"
currencystringrequired
Value"EUR"
Example: "EUR"
pay_methodpay_method (object) or null_type (any)required
Example: {"id":"ideal","type":"pay_method","name":"iDEAL","currencies":["EUR"],"minimum_amount":10,"maximum_amount":5000000,"details":{"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}}
Any of:
pay_method.​idstringrequired
Example: "ideal"
pay_method.​typestringrequired
Value"pay_method"
Example: "pay_method"
pay_method.​namestringrequired
Example: "iDEAL"
pay_method.​currenciesArray of strings
Items Value"EUR"
Example: ["EUR"]
pay_method.​minimum_amountinteger
Example: 10
pay_method.​maximum_amountinteger
Example: 5000000
pay_method.​detailsobject
Example: {"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}
statestringrequired
Example: "paid"
refunded_amountintegerrequired
return_urlstring or null(uri)required
Example: "https://example.com/thank-you"
cancel_urlstring or null(uri)required
Example: "https://example.com/cancel"
metadataobjectrequired
Example: {}
customerstring or nullrequired
Example: "CU7JRN6W6K3DA9"
mandatestring or nullrequired
Example: "MD6ULYXJ4HP9RJ"
subscriptionstring or nullrequired
installment_planstring or nullrequired
paid_atstring or null(date-time)required
Example: "2023-06-30T12:44:35Z"
created_atstring or null(date-time)required
Example: "2023-06-30T12:40:10Z"
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"
_links.​customerstring(uri)
Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"
_links.​mandatestring(uri)
Example: "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"
_links.​subscriptionstring(uri)
_links.​installment_planstring(uri)
_links.​checkoutstring(uri)
Response
application/json
{ "id": "PPH25H07JYWLR7PA82", "type": "payment", "amount": 1000, "description": "Test Payment", "currency": "EUR", "pay_method": { "id": "ideal", "type": "pay_method", "name": "iDEAL", "currencies": [ … ], "minimum_amount": 10, "maximum_amount": 5000000, "details": { … } }, "state": "paid", "refunded_amount": 0, "return_url": "https://example.com/thank-you", "cancel_url": "https://example.com/cancel", "metadata": {}, "customer": "CU7JRN6W6K3DA9", "mandate": "MD6ULYXJ4HP9RJ", "subscription": null, "installment_plan": null, "paid_at": "2023-06-30T12:44:35Z", "created_at": "2023-06-30T12:40:10Z", "_links": { "self": "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82", "customer": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9", "mandate": "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ" } }

Retrieve a list of payments

Request

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

Responses

payments found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(payment)required
Example: [{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","pay_method":{"id":"ideal","type":"pay_method","name":"iDEAL","currencies":["EUR"],"minimum_amount":10,"maximum_amount":5000000,"details":{"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}},"state":"paid","refunded_amount":0,"return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","metadata":{},"customer":"CU7JRN6W6K3DA9","mandate":"MD6ULYXJ4HP9RJ","subscription":null,"installment_plan":null,"paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}}]
data[].​idstringrequired
Example: "PPH25H07JYWLR7PA82"
data[].​typestringrequired
Value"payment"
Example: "payment"
data[].​amountintegerrequired
Example: 1000
data[].​descriptionstringrequired
Example: "Test Payment"
data[].​currencystringrequired
Value"EUR"
Example: "EUR"
data[].​pay_methodpay_method (object) or null_type (any)required
Example: {"id":"ideal","type":"pay_method","name":"iDEAL","currencies":["EUR"],"minimum_amount":10,"maximum_amount":5000000,"details":{"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}}
Any of:
data[].​pay_method.​idstringrequired
Example: "ideal"
data[].​pay_method.​typestringrequired
Value"pay_method"
Example: "pay_method"
data[].​pay_method.​namestringrequired
Example: "iDEAL"
data[].​pay_method.​currenciesArray of strings
Items Value"EUR"
Example: ["EUR"]
data[].​pay_method.​minimum_amountinteger
Example: 10
data[].​pay_method.​maximum_amountinteger
Example: 5000000
data[].​pay_method.​detailsobject
Example: {"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}
data[].​statestringrequired
Example: "paid"
data[].​refunded_amountintegerrequired
data[].​return_urlstring or null(uri)required
Example: "https://example.com/thank-you"
data[].​cancel_urlstring or null(uri)required
Example: "https://example.com/cancel"
data[].​metadataobjectrequired
Example: {}
data[].​customerstring or nullrequired
Example: "CU7JRN6W6K3DA9"
data[].​mandatestring or nullrequired
Example: "MD6ULYXJ4HP9RJ"
data[].​subscriptionstring or nullrequired
data[].​installment_planstring or nullrequired
data[].​paid_atstring or null(date-time)required
Example: "2023-06-30T12:44:35Z"
data[].​created_atstring or null(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}
data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"
data[].​_links.​customerstring(uri)
Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"
data[].​_links.​mandatestring(uri)
Example: "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"
data[].​_links.​subscriptionstring(uri)
data[].​_links.​installment_planstring(uri)
data[].​_links.​checkoutstring(uri)
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" } }

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