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

Request

Retrieves a single installment plan based on the id.

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

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

Installment plan periods

Operations

Events

Operations

Webhooks

Operations