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

Retrieves a list of installment plans

Request

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

Security

apiKey

Responses

installment plans found

Bodyapplication/json

typestringrequired

Value"list"

dataArray of objects(installment_plan)required

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

data[].idstringrequired

Example: "PIV1QACRO4DSMQT0KK"

data[].typestringrequired

Value"installment_plan"

Example: "installment_plan"

data[].descriptionstringrequired

Example: "Test installment plan"

data[].installment_plan_typestring or nullrequired

Value"direct_debit"

Example: "direct_debit"

data[].statestringrequired

Example: "active"

data[].currencystringrequired

Value"EUR"

Example: "EUR"

data[].created_atstring(date-time)required

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

data[].customerstring or nullrequired

Example: "CU7JRN6W6K3DA9"

data[].mandatestring or nullrequired

Example: "MDC7XX65BH42PW"

data[].periodobjectrequired

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

data[].period.amountintegerrequired

Example: "1000"

data[].period.vatnumber[ 0 .. 100 ]required

Example: "21"

data[].period.multiplierintegerrequired

Example: 1

data[].period.intervalstringrequired

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

Example: "month"

data[].first_periodobject or nullrequired

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

data[].first_period.amountintegerrequired

Example: "1000"

data[].first_period.vatnumber[ 0 .. 100 ]required

Example: "21"

data[].first_period.multiplierinteger

Example: 1

data[].first_period.intervalstring

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

Example: "month"

data[].number_of_periodsnumber>= 1required

Example: 5

data[].payment_detailsobjectrequired

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

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

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

data[].metadataobjectrequired

Example: {}

data[]._linksobjectrequired

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

data[]._links.selfstring(uri)required

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

data[]._links.customerstring(uri)

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

data[]._links.mandatestring(uri)

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

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 installment plan

Request

Creates a Installment plan object.

After you have created a Installment plan, it will start immediately when mandate is given. When pay_methods are given you need to redirect the customer to the checkout link in the links section.

Security

apiKey

Bodyapplication/json

customerstringrequired

ID of the customer for installment plan. Cannot be used together with a mandate.

Example: "CUW78XU8BYL8X6"

mandatestring

ID of the mandate for installment plan

descriptionstringrequired

Description of the installment plan. This will be shown to customers

Example: "description"

currencystringrequired

The currency of the installment plan. Only 'EUR' is supported

Example: "EUR"

pay_methodsArray of strings or null

Pay methods that can be used to start the subscription. Using this creates the subscription with the authorization flow and will start the subscription when the first payment is paid. Use the checkout link in the links field to redirect the customer. Cannot be used together with a mandate.

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

Example: ["creditcard","direct-debit","ideal"]

payment_detailsobject

Fields to be passed to the authorization payment.

periodobjectrequired

Settings for when new periods should be created and with which amounts

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

period.amountinteger

The amount in cents that the customer will have to pay.

Example: 1000

period.vatnumber or null

The vat included in the amount. Accepted values: from 0 till 30

Example: 21

period.intervalstring

The interval of each period. Accepted values: day, week, month or year

period.multiplierinteger

The multiplier of the interval between periods. Example: interval=month and mulitplier=3 will create a new period every 3 months.

Example: 1

first_periodobject or null

Settings for when the first period should be created and with what amount

number_of_periodsintegerrequired

The number of installment plan periods.

Example: 5

metadataobject or null

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

Responses

installment plan created

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 installment plan

Request

Retrieves a single installment plan based on the id.

Security

apiKey

Path

idstringrequired

Responses

installment plan found

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

Installment plan periods

Operations

Events

Operations

Webhooks

Operations

Payouts

Operations

Top-ups

Operations

PayPro API Reference (v1)

Payments

Refunds

Chargebacks

Pay methods

Customers

Mandates

Subscriptions

Subscription periods

Installment plans

Retrieves a list of installment plans

Request

Responses

Was this helpful?

Creates a installment plan

Request

Responses

Was this helpful?

Retrieves a installment plan

Request

Responses

Was this helpful?

Installment plan periods

Events

Webhooks

Payouts

Top-ups

PayPro API Reference (v1)

Payments

Refunds

Chargebacks

Pay methods

Customers

Mandates

Subscriptions

Subscription periods

Installment plans

Retrieves a list of installment plans

Request

Responses

Was this helpful?

Creates a installment plan

RequestExpand all

Responses

Was this helpful?

Retrieves a installment plan

Request

Responses

Was this helpful?

Installment plan periods

Events

Webhooks

Payouts

Top-ups

Request