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

Installment plan periods

Operations

Events

Operations

Webhooks

Operations

Payouts

Operations

Top-ups

Operations

Retrieves a top-up

Request

Retrieves a single top-up based on the id.

Security
apiKey
Path
idstringrequired

Responses

top-up found

Bodyapplication/json
idstringrequired
Example: "TUMKR465ZG6QDU"
typestringrequired
Value"top_up"
Example: "top_up"
amountintegerrequired
Example: 12300
descriptionstringrequired
Example: "Top-up TUMKR465ZG6QDU"
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":1,"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: 1
pay_method.​maximum_amountinteger
Example: 5000000
pay_method.​detailsobject
Example: {}
statestringrequired
Example: "paid"
localestring or nullrequired
Enum"de""en""fr""nl"
Example: "en"
metadataobjectrequired
Example: {}
paid_atstring or null(date-time)required
Example: "2025-05-28T14:53:03Z"
created_atstring or null(date-time)required
Example: "2025-05-28T14:52:26Z"
_linksobjectrequired
Example: {"self":"http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"}
_links.​selfstring(uri)required
Example: "http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"
_links.​checkoutstring(uri)
Response
application/json
{
  "id": "TUMKR465ZG6QDU",
  "type": "top_up",
  "amount": 12300,
  "currency": "EUR",
  "description": "Top-up TUMKR465ZG6QDU",
  "pay_method": {
    "id": "ideal",
    "type": "pay_method",
    "name": "iDEAL",
    "currencies": [ … ],
    "minimum_amount": 1,
    "maximum_amount": 5000000,
    "details": {}
  },
  "locale": "en",
  "state": "paid",
  "metadata": {},
  "created_at": "2025-05-28T14:52:26Z",
  "paid_at": "2025-05-28T14:53:03Z",
  "_links": {
    "self": "http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"
  }
}

Retrieve a list of top-ups

Request

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

Security
apiKey

Responses

top-ups found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(top_up)required
Example: [{"id":"TUMKR465ZG6QDU","type":"top_up","amount":12300,"currency":"EUR","description":"Top-up TUMKR465ZG6QDU","pay_method":{"id":"ideal","type":"pay_method","name":"iDEAL","currencies":["EUR"],"minimum_amount":1,"maximum_amount":5000000,"details":{}},"locale":"en","state":"paid","metadata":{},"created_at":"2025-05-28T14:52:26Z","paid_at":"2025-05-28T14:53:03Z","_links":{"self":"http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"}}]
data[].​idstringrequired
Example: "TUMKR465ZG6QDU"
data[].​typestringrequired
Value"top_up"
Example: "top_up"
data[].​amountintegerrequired
Example: 12300
data[].​descriptionstringrequired
Example: "Top-up TUMKR465ZG6QDU"
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":1,"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: 1
data[].​pay_method.​maximum_amountinteger
Example: 5000000
data[].​pay_method.​detailsobject
Example: {}
data[].​statestringrequired
Example: "paid"
data[].​localestring or nullrequired
Enum"de""en""fr""nl"
Example: "en"
data[].​metadataobjectrequired
Example: {}
data[].​paid_atstring or null(date-time)required
Example: "2025-05-28T14:53:03Z"
data[].​created_atstring or null(date-time)required
Example: "2025-05-28T14:52:26Z"
data[].​_linksobjectrequired
Example: {"self":"http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"}
data[].​_links.​selfstring(uri)required
Example: "http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"
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 top-up

Request

Creates a Top-up object.

After you have created a Top-up you can use the _links.checkout link to redirect to the pay page.

Security
apiKey
Bodyapplication/json
amountintegerrequired

The amount that the customer will have to pay.

Example: 1000
currencystring

The currency of the top-up.

Value"EUR"
Example: "EUR"
descriptionstring or null

The description of the top-up.

pay_methodstring or null

The pay method of the top-up.

Enum"bancontact""bank-transfer""ideal"
localestring or null

Specifies the language to be used for the top-up page. If no locale or an invalid locale is specified we will ignore it and choose the locale based on the account settings.

Enum"de""en""fr""nl"
metadataobject or null

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

Responses

top-up created

Bodyapplication/json
idstringrequired
Example: "TUMKR465ZG6QDU"
typestringrequired
Value"top_up"
Example: "top_up"
amountintegerrequired
Example: 12300
descriptionstringrequired
Example: "Top-up TUMKR465ZG6QDU"
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":1,"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: 1
pay_method.​maximum_amountinteger
Example: 5000000
pay_method.​detailsobject
Example: {}
statestringrequired
Example: "paid"
localestring or nullrequired
Enum"de""en""fr""nl"
Example: "en"
metadataobjectrequired
Example: {}
paid_atstring or null(date-time)required
Example: "2025-05-28T14:53:03Z"
created_atstring or null(date-time)required
Example: "2025-05-28T14:52:26Z"
_linksobjectrequired
Example: {"self":"http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"}
_links.​selfstring(uri)required
Example: "http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"
_links.​checkoutstring(uri)
Response
application/json
{
  "id": "TUMKR465ZG6QDU",
  "type": "top_up",
  "amount": 12300,
  "currency": "EUR",
  "description": "Top-up TUMKR465ZG6QDU",
  "pay_method": {
    "id": "ideal",
    "type": "pay_method",
    "name": "iDEAL",
    "currencies": [ … ],
    "minimum_amount": 1,
    "maximum_amount": 5000000,
    "details": {}
  },
  "locale": "en",
  "state": "paid",
  "metadata": {},
  "created_at": "2025-05-28T14:52:26Z",
  "paid_at": "2025-05-28T14:53:03Z",
  "_links": {
    "self": "http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"
  }
}