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

Updates an installment plan

Request

Updates an Installment plan object. Returns the updated Installment plan

Path

idstringrequired

Bodyapplication/json

descriptionstring

Description of the installment plan. This will be shown to customers and in the PayPro dashboard

Example: "description"

mandatestring

ID of the mandate for installment plan. Only approved 'direct-debit' customer's mandates are supported.

number_of_periodsnumber>= 1

periodobject

Settings for when new periods should be created and with which amounts. When the Installment plan is active updates to these settings will only affect new periods.

Example: {"amount":1000}

first_periodobject or null

Settings for when the first period should be created and with what amount. These settings can only be updated if the Installment plan has not started yet.

Responses

installment plan updated

Bodyapplication/json

idstringrequired

Example: "PIV1QACRO4DSMQT0KK"

typestringrequired

Value"installment_plan"

Example: "installment_plan"

descriptionstringrequired

Example: "Test installment plan"

installment_plan_typestring or nullrequired

Value"direct_debit"

Example: "direct_debit"

statestringrequired

Example: "active"

currencystringrequired

Value"EUR"

Example: "EUR"

created_atstring(date-time)required

Example: "2023-07-24T12:40:10Z"

customerstring or nullrequired

Example: "CU7JRN6W6K3DA9"

mandatestring or nullrequired

Example: "MDC7XX65BH42PW"

periodobjectrequired

Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}

period.amountintegerrequired

Example: "1000"

period.vatnumber[ 0 .. 100 ]required

Example: "21"

period.multiplierintegerrequired

Example: 1

period.intervalstringrequired

Enum"day""week""month""year"

Example: "month"

first_periodobject or nullrequired

Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}

first_period.amountintegerrequired

Example: "1000"

first_period.vatnumber[ 0 .. 100 ]required

Example: "21"

first_period.multiplierinteger

Example: 1

first_period.intervalstring

Enum"day""week""month""year"

Example: "month"

number_of_periodsnumber>= 1required

Example: 5

payment_detailsobjectrequired

Example: {"return_url":null,"cancel_url":null}

payment_details.return_urlstring or null(uri)required

payment_details.cancel_urlstring or null(uri)required

metadataobjectrequired

Example: {}

_linksobjectrequired

Example: {"self":"https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MDC7XX65BH42PW"}

_links.selfstring(uri)required

Example: "https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK"

_links.customerstring(uri)

Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"

_links.mandatestring(uri)

Example: "https://api.paypro.nl/mandates/MDC7XX65BH42PW"

_links.checkoutstring(uri)

Response

application/json

{
  "id": "PIV1QACRO4DSMQT0KK",
  "type": "installment_plan",
  "description": "Test installment plan",
  "currency": "EUR",
  "installment_plan_type": "direct_debit",
  "state": "active",
  "created_at": "2023-07-24T12:40:10Z",
  "customer": "CU7JRN6W6K3DA9",
  "mandate": "MDC7XX65BH42PW",
  "period": {
    "amount": "1000",
    "vat": "21",
    "multiplier": 1,
    "interval": "month"
  },
  "first_period": {
    "amount": "1000",
    "vat": "21",
    "multiplier": 1,
    "interval": "month"
  },
  "number_of_periods": 5,
  "payment_details": {
    "return_url": null,
    "cancel_url": null
  },
  "metadata": {},
  "_links": {
    "self": "https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK",
    "customer": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9",
    "mandate": "https://api.paypro.nl/mandates/MDC7XX65BH42PW"
  }
}

Cancels a installment plan

Request

Cancels a installment plan. A canceled installment plan will no longer create new installment plan periods. It is not possible to resume a canceled installment plan.

Path

idstringrequired

Responses

installment plan canceled

Bodyapplication/json

idstringrequired

Example: "PIV1QACRO4DSMQT0KK"

typestringrequired

Value"installment_plan"

Example: "installment_plan"

descriptionstringrequired

Example: "Test installment plan"

installment_plan_typestring or nullrequired

Value"direct_debit"

Example: "direct_debit"

statestringrequired

Example: "active"

currencystringrequired

Value"EUR"

Example: "EUR"

created_atstring(date-time)required

Example: "2023-07-24T12:40:10Z"

customerstring or nullrequired

Example: "CU7JRN6W6K3DA9"

mandatestring or nullrequired

Example: "MDC7XX65BH42PW"

periodobjectrequired

Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}

period.amountintegerrequired

Example: "1000"

period.vatnumber[ 0 .. 100 ]required

Example: "21"

period.multiplierintegerrequired

Example: 1

period.intervalstringrequired

Enum"day""week""month""year"

Example: "month"

first_periodobject or nullrequired

Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}

first_period.amountintegerrequired

Example: "1000"

first_period.vatnumber[ 0 .. 100 ]required

Example: "21"

first_period.multiplierinteger

Example: 1

first_period.intervalstring

Enum"day""week""month""year"

Example: "month"

number_of_periodsnumber>= 1required

Example: 5

payment_detailsobjectrequired

Example: {"return_url":null,"cancel_url":null}

payment_details.return_urlstring or null(uri)required

payment_details.cancel_urlstring or null(uri)required

metadataobjectrequired

Example: {}

_linksobjectrequired

Example: {"self":"https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MDC7XX65BH42PW"}

_links.selfstring(uri)required

Example: "https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK"

_links.customerstring(uri)

Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"

_links.mandatestring(uri)

Example: "https://api.paypro.nl/mandates/MDC7XX65BH42PW"

_links.checkoutstring(uri)

Response

application/json

{
  "id": "PIV1QACRO4DSMQT0KK",
  "type": "installment_plan",
  "description": "Test installment plan",
  "currency": "EUR",
  "installment_plan_type": "direct_debit",
  "state": "active",
  "created_at": "2023-07-24T12:40:10Z",
  "customer": "CU7JRN6W6K3DA9",
  "mandate": "MDC7XX65BH42PW",
  "period": {
    "amount": "1000",
    "vat": "21",
    "multiplier": 1,
    "interval": "month"
  },
  "first_period": {
    "amount": "1000",
    "vat": "21",
    "multiplier": 1,
    "interval": "month"
  },
  "number_of_periods": 5,
  "payment_details": {
    "return_url": null,
    "cancel_url": null
  },
  "metadata": {},
  "_links": {
    "self": "https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK",
    "customer": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9",
    "mandate": "https://api.paypro.nl/mandates/MDC7XX65BH42PW"
  }
}

Retrieves a list installment plan periods that belong to this installment plan

Request

Retrieves a list of installment plan periods that belong to this installment plan.

Path

idstringrequired

Responses

installment plan periods found

Bodyapplication/json

typestringrequired

Value"list"

dataArray of objects(installment_plan_period)required

Example: [{"id":"IPD344S1PDY8XX","type":"installment_plan_period","amount":1500,"period_number":1,"installment_plan":"PIUJDW4VCMG9JS","state":"paid","payments":{"type":"list","data":[{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"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"}}],"count":1,"_links":{"self":"https://api.paypro.nl/installment_plan_periods/SPD344S1PDY8XX/payments"}},"created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/installment_plan_periods/IPD344S1PDY8XX","installment_plan":"https://api.paypro.nl/installment_plans/PIUJDW4VCMG9JS"}}]

data[].idstringrequired

Example: "IPD344S1PDY8XX"

data[].typestringrequired

Value"installment_plan_period"

Example: "installment_plan_period"

data[].amountintegerrequired

Example: 1500

data[].period_numberintegerrequired

Example: 1

data[].installment_planstringrequired

Example: "PIUJDW4VCMG9JS"

data[].statestringrequired

Enum"open""pending""paid""canceled""reversed""refunded"

Example: "paid"

data[].paymentsobjectrequired

Example: {"type":"list","data":[{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"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"}}],"count":1,"_links":{"self":"https://api.paypro.nl/installment_plan_periods/SPD344S1PDY8XX/payments"}}

data[].payments.typestringrequired

Value"list"

Example: "list"

data[].payments.dataArray of objects(payment)required

Example: [{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"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"}}]

data[].payments.data[].idstringrequired

Example: "PPH25H07JYWLR7PA82"

data[].payments.data[].typestringrequired

Value"payment"

Example: "payment"

data[].payments.data[].amountintegerrequired

Example: 1000

data[].payments.data[].descriptionstringrequired

Example: "Test Payment"

data[].payments.data[].currencystringrequired

Value"EUR"

Example: "EUR"

data[].payments.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[].payments.data[].pay_method.idstringrequired

Example: "ideal"

data[].payments.data[].pay_method.typestringrequired

Value"pay_method"

Example: "pay_method"

data[].payments.data[].pay_method.namestringrequired

Example: "iDEAL"

data[].payments.data[].pay_method.currenciesArray of strings

Items Value"EUR"

Example: ["EUR"]

data[].payments.data[].pay_method.minimum_amountinteger

Example: 10

data[].payments.data[].pay_method.maximum_amountinteger

Example: 5000000

data[].payments.data[].pay_method.detailsobject

Example: {"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}

data[].payments.data[].statestringrequired

Example: "paid"

data[].payments.data[].refunded_amountintegerrequired

data[].payments.data[].return_urlstring or null(uri)required

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

data[].payments.data[].cancel_urlstring or null(uri)required

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

data[].payments.data[].metadataobjectrequired

Example: {}

data[].payments.data[].customerstring or nullrequired

Example: "CU7JRN6W6K3DA9"

data[].payments.data[].mandatestring or nullrequired

Example: "MD6ULYXJ4HP9RJ"

data[].payments.data[].subscriptionstring or nullrequired

data[].payments.data[].installment_planstring or nullrequired

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

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

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

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

data[].payments.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[].payments.data[]._links.selfstring(uri)required

Example: "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"

data[].payments.data[]._links.customerstring(uri)

Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"

data[].payments.data[]._links.mandatestring(uri)

Example: "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"

data[].payments.data[]._links.subscriptionstring(uri)

data[].payments.data[]._links.installment_planstring(uri)

data[].payments.data[]._links.checkoutstring(uri)

data[].payments.countintegerrequired

Example: 1

data[].payments._linksobjectrequired

Example: {"self":"https://api.paypro.nl/installment_plan_periods/SPD344S1PDY8XX/payments"}

data[].payments._links.selfstring(uri)required

Example: "https://api.paypro.nl/installment_plan_periods/SPD344S1PDY8XX/payments"

data[].created_atstring(date-time)required

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

data[]._linksobjectrequired

Example: {"self":"https://api.paypro.nl/installment_plan_periods/IPD344S1PDY8XX","installment_plan":"https://api.paypro.nl/installment_plans/PIUJDW4VCMG9JS"}

data[]._links.selfstring(uri)required

Example: "https://api.paypro.nl/installment_plan_periods/IPD344S1PDY8XX"

data[]._links.installment_planstring(uri)required

Example: "https://api.paypro.nl/installment_plans/PIUJDW4VCMG9JS"

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

Installment plan periods

Operations

Events

Operations

Webhooks

Operations

PayPro API Reference (v1)

Payments

Refunds

Chargebacks

Pay methods

Customers

Mandates

Subscriptions

Subscription periods

Installment plans

Updates an installment plan

Request

Responses

Was this helpful?

Cancels a installment plan

Request

Responses

Was this helpful?

Retrieves a list installment plan periods that belong to this installment plan

Request

Responses

Was this helpful?

Installment plan periods

Events

Webhooks

PayPro API Reference (v1)

Payments

Refunds

Chargebacks

Pay methods

Customers

Mandates

Subscriptions

Subscription periods

Installment plans

Updates an installment plan

RequestExpand all

Responses

Was this helpful?

Cancels a installment plan

Request

Responses

Was this helpful?

Retrieves a list installment plan periods that belong to this installment plan

Request

Responses

Was this helpful?

Installment plan periods

Events

Webhooks

Request