Skip to content

PayPro API Reference (v1)

Servers

https://api.paypro.nl/

Payments

The payment object is the core of the PayPro API. You can create payments to let a customer pay which ultimately transfers funds from them to you.

This allows you to setup one-time payments, recurring payments, subscriptions or invoices.

Refer to our Creating payments guide to see how you can implement 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

Refunds allow you to return funds to your customer. These funds are deducted from your PayPro balance and are refunded to the card, bank account or wallet used in the initial payment.

You can create refunds yourself or in some cases the customer can initiate a refund.

Refer to our Refund guide on how to manage and create refunds.

Operations

Chargebacks

Chargebacks are created by our system when a customer files a dispute and initiates a chargeback. For example this can happen when the customer does not receive the product bought.

Only certain pay methods have chargebacks like credit card and SEPA Direct Debit. Once the customer initiates a chargeback we will create a chargeback object and notify you through our webhooks.

Operations

Pay methods

Pay method endpoints can be used to retrieve all available payment methods for your account.

The pay method object contains information about the pay method for instance the minimum and maximum amount or which currencies are allowed.

Operations

Customers

Customers are a representation of your customers. These are used to get better insight in your PayPro payments for instance when searching for a customer name in our dashboard.

Customers can be created directly through the API or are created by the system when a payment is paid and no existing customer is associated.

For recurring payments and subscriptions it is mandatory to create a customer. This allows us to manage mandates, subscriptions and payments on the customer level.

A customer does not require any customer information, but we recommend to atleast provide a name or email. This makes it easier to manage your customers and payments in the PayPro dashboard.

To see how you can use customers see our Subscriptions guide.

Operations

Mandates

A Mandate symbolizes the permission the customer gave you to charge their payment method. This is used to setup recurring payments and subscriptions.

Mandates can be created directly for some payment types like "direct-debit" or require an authorization payment which is generally the first payment when setting up the recurring payments or subscription.

Check our Recurring payments guide or Subscriptions guide for how to use mandates.

Operations

Subscriptions

Subscriptions are the easiest way to setup and schedule recurring payments. You provide us the amounts and intervals and PayPro will manage the full life-cycle of the subscription.

Each interval a Subscription period and Payment will be created which will charge the customer.

These subscriptions can be managed through the API or in our dashboard and also includes optional invoicing, debtor management and other features.

Refer to our Subscriptions guide how to setup and manage your subscriptions.

It is also possible to create the Subscription period yourself which we call an "on-demand" subscription check our On-demand subscriptions guide how to do this.

Operations

Subscription periods

The Subscription period represents a period in a subscription. These are created by the system at the interval you specified or by yourself when using an "on-demand" subscription.

The payment created to charge the customer is associated with the subscription period as well as other payments that might happen if the first one fails or when a customer repays after a chargeback.

Operations

Installment plans

Installment plans can be used to periodically charge a customer by specifying the amount and interval. The amount and number of periods are fixed.

The main difference with a subscription is that an installment plan does not run indefinitely and the invoice is generated up front. Where with a subscription it can run indefinitely and an invoice is created for each period.

If you are unsure which to use we suggest to look at the Subscriptions first. Most use cases can be solved with subscriptions and installment plans should only be considered if a single invoice is required.

Operations

Installment plan periods

The Installment plan period represents a period in an installment plan. These are created by the system at the interval you specified.

The payment created to charge the customer are associated with the installment plan period as well as other payments that might happen if the first one fails or when a customer repays after a chargeback.

Operations

Events

Events are generated by our system to notify about something that happened in your account. Events contain an event type like payment.paid or customer.updated and a payload with information about the object for which this event happened.

The event payload always contains the information about the resource at the moment the event was created. This means the information in the payload may be out-of-date. To avoid this you should retrieve the resource from the API again and use the information retrieved in the API request.

You can use these endpoints to retrieve events from your account. Our webhook system uses these events when sending notifications to your server.

Refer to the webhooks section for more information.

Operations

Webhooks

Webhooks can be used to send events to an HTTP endpoint. A typical event is when a payment is paid, payment.paid.

You can retrieve and manage your webhooks through the API or in the PayPro dashboard.

Refer to the webhooks section on how to setup and use webhooks and events.

Operations

Payouts

Payouts are created when you receive funds from PayPro to one of your bank accounts. These can be created on a schedule, through the dashboard or by using the Payout create endpoint.

When creating a payout you must have sufficient balance in your PayPro account.

Operations

Top-ups

Top-ups are a way to top-up your PayPro balance. This can be done through our dashboard or by using the Top-up create endpoint.

The top-up has a unique ID which might be necessary to use when doing manual transfers. When the top-up is processed your PayPro balance will automatically be increased by the amount in the top-up.

Operations