PayPro API Reference (v1)

Servers

https://api.paypro.nl/

Payments

Operations

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.

Security

apiKey

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":{}},"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,"locale":"en","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":{}}

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: {}

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[].localestring or nullrequired

Enum"de""en""fr""nl"

Example: "en"

data[].paid_atstring or null(date-time)required

Example: "2023-06-30T12:44:35Z"

data[].fail_reasonstring or null

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

Creates a payment

Request

Creates a Payment object.

After you have created a Payment you can use the _links.checkout link to redirect your customer.

Security

apiKey

Bodyapplication/json

amountintegerrequired

The amount that the customer will have to pay.

Example: 1000

currencystringrequired

The currency of the payment. Only 'EUR' is supported.

Value"EUR"

Example: "EUR"

descriptionstringrequired

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

Example: "Test Payment"

return_urlstring or null(uri)

The URL where the customer will be send to after the payment has been processed.

Example: "https://example.com/thank-you"

cancel_urlstring or null(uri)

The URL where the customer will be send to after the payment has been canceled by the customer.

Example: "https://example.com/cancel"

pay_methodsArray of strings or null

The allowed pay methods of the payment. If only one pay method is specified, it will be set as the payment pay method. Cannot be used together with a mandate.

Enum"afterpay""bancontact""bank-transfer""creditcard""direct-debit""ideal""ideal-qr""klarna-paynow""paypal"

Example: ["ideal","creditcard","paypal"]

metadataobject or null

You can put in random data that you like to save alongside the payment. When you fetch the payment this will be returned in the metadata field.

customerstring or null

ID of the customer that pays. This field is optional, if nothing is given we create a new Customer. Cannot be used together with a mandate.

mandatestring or null

ID of the mandate for payment

setup_mandateboolean or null

Indicates if the payment should create a mandate after it has been paid. This allows to setup recurring payments without the need to use a Subscription or InstallmentPlan. Needs the customer parameter to be set as well. Cannot be used together with a mandate.

localestring or null

Specifies the language to be used for the payment pages shown to the customer. If no locale or an invalid locale is specified we will ignore it and choose the locale based on the account settings or the locale used by the customer.

Enum"de""en""fr""nl"

issuerstring or nullDeprecated

Specifying the iDEAL issuer is deprecated and will be ignored if provided.

Enum"SNSBNL2A""ASNBNL21""ABNANL2A""BUNQNL2A""KNABNL2H""RABONL2U""REVOLT21""RBRBNL21""TRIONL2U""FVLBNL22"

Responses

payment created

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

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: {}

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

localestring or nullrequired

Enum"de""en""fr""nl"

Example: "en"

paid_atstring or null(date-time)required

Example: "2023-06-30T12:44:35Z"

fail_reasonstring or null

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,
  "locale": "en",
  "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"
  }
}

Retrieves a list of chargebacks that belong to this payment

Request

Retrieves a list of chargebacks that belong to this payment.

Security

apiKey

Path

idstringrequired

Responses

chargebacks found

Bodyapplication/json

typestringrequired

Value"list"

dataArray of objects(chargeback)required

Example: [{"id":"PCG2SZKYJCCDV8","type":"chargeback","amount":1000,"description":"Test Payment","reason":"MD06","payment":"PPBLGEE6UG92MS","currency":"EUR","state":"completed","refunded_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}}]

data[].idstringrequired

Example: "PCG2SZKYJCCDV8"

data[].typestringrequired

Value"chargeback"

Example: "chargeback"

data[].amountintegerrequired

Example: 1000

data[].descriptionstringrequired

Example: "Test Payment"

data[].reasonstring or nullrequired

Example: "MD06"

data[].currencystringrequired

Value"EUR"

Example: "EUR"

data[].paymentstringrequired

Example: "PPBLGEE6UG92MS"

data[].statestringrequired

Example: "completed"

data[].charged_back_atstring or null(date-time)required

data[].created_atstring(date-time)required

Example: "2023-06-30T12:40:10Z"

data[]._linksobjectrequired

Example: {"self":"https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}

data[]._links.selfstring(uri)required

Example: "https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8"

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

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

PayPro API Reference (v1)

Payments

Retrieve a list of payments

Request

Responses

Was this helpful?

Creates a payment

Request

Responses

Was this helpful?

Retrieves a list of chargebacks that belong to this payment

Request

Responses

Was this helpful?

Refunds

Chargebacks

Pay methods

Customers

Mandates

Subscriptions

Subscription periods

Installment plans

Installment plan periods

Events

Webhooks

Payouts

Top-ups