PayPro API Reference (v1)

Servers

https://api.paypro.nl/

Payments

Operations

Retrieves a list of refunds that belong to this payment.

Request

Retrieves a list of refunds that belong to this payment.

Security
apiKey
Path
idstringrequired

Responses

refunds found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(refund)required
Example: [{"id":"PRRNQH3PCD125Z","type":"refund","amount":1000,"description":"Test Payment","reason":"","payment":"PPBLGEE6UG92MS","currency":"EUR","state":"refunded","refunded_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/refunds/PRRNQH3PCD125Z","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}}]
data[].​idstringrequired
Example: "PRRNQH3PCD125Z"
data[].​typestringrequired
Value"refund"
Example: "refund"
data[].​amountintegerrequired
Example: 1000
data[].​descriptionstringrequired
Example: "Test Payment"
data[].​reasonstring or nullrequired
data[].​currencystringrequired
Value"EUR"
Example: "EUR"
data[].​paymentstringrequired
Example: "PPBLGEE6UG92MS"
data[].​statestringrequired
Example: "refunded"
data[].​refunded_atstring or null(date-time)required
Example: "2023-06-30T12:44:35Z"
data[].​created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/refunds/PRRNQH3PCD125Z","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}
data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/refunds/PRRNQH3PCD125Z"
data[].​_links.​paymentstring(uri)required
Example: "https://api.paypro.nl/payments/PPBLGEE6UG92MS"
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 refund for this payment.

Request

Creates a Refund object for this Payment.

Creating a refund will refund a certain amount back to the customer. This amount will be deducted from your balance.

You can choose to only refund a part of the total amount. You can do this multiple times, but the total refunded amount can't exceed the payment amount.

Some pay methods require additional information, like IBAN and account holder name, to be supplied.

Security
apiKey
Path
idstringrequired
Bodyapplication/json
amountintegerrequired

The amount that will be refunded to the customer. This can be an amount lower than the total amount to do a partial refund. You can't refund more than the total amount of the original payment.

Example: 1000
descriptionstring or null

The description of the refund. This will be shown to your customer and will be visible in the dashboard.

Default "The description of the payment."
Example: "Test Refund"
reasonstring or null

The reason for this refund.

Example: "Customer requested"
account_holder_namestring or null

Name of the account holder of the account where the refund will be credited. This is a required field for the pay methods 'bancontact' and 'creditcard'. For other pay methods we will use the orginal customer information provided by the pay method to do the refund.

Example: "John Doe"
ibanstring

IBAN of the account where the refund will be credited. required field for the pay methods 'bancontact' and 'creditcard'. For other pay methods we will use the orginal customer information provided by the pay method to do the refund.

Example: "NL02ABNA0123456789"

Responses

refund created

Bodyapplication/json
idstringrequired
Example: "PRRNQH3PCD125Z"
typestringrequired
Value"refund"
Example: "refund"
amountintegerrequired
Example: 1000
descriptionstringrequired
Example: "Test Payment"
reasonstring or nullrequired
currencystringrequired
Value"EUR"
Example: "EUR"
paymentstringrequired
Example: "PPBLGEE6UG92MS"
statestringrequired
Example: "refunded"
refunded_atstring or null(date-time)required
Example: "2023-06-30T12:44:35Z"
created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/refunds/PRRNQH3PCD125Z","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/refunds/PRRNQH3PCD125Z"
_links.​paymentstring(uri)required
Example: "https://api.paypro.nl/payments/PPBLGEE6UG92MS"
Response
application/json
{
  "id": "PRRNQH3PCD125Z",
  "type": "refund",
  "amount": 1000,
  "description": "Test Payment",
  "reason": "",
  "payment": "PPBLGEE6UG92MS",
  "currency": "EUR",
  "state": "refunded",
  "refunded_at": "2023-06-30T12:44:35Z",
  "created_at": "2023-06-30T12:40:10Z",
  "_links": {
    "self": "https://api.paypro.nl/refunds/PRRNQH3PCD125Z",
    "payment": "https://api.paypro.nl/payments/PPBLGEE6UG92MS"
  }
}

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

Payouts

Operations

Top-ups

Operations