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

Retrieves a payout

Request

Retrieves a single payout based on the id.

Security
apiKey
Path
idstringrequired

Responses

payout found

Bodyapplication/json
idstringrequired
Example: "POKHCDCQPS4GAA"
typestringrequired
Value"payout"
Example: "payout"
amountintegerrequired
Example: 12300
fee_amountintegerrequired
fee_vat_amountintegerrequired
currencystringrequired
Value"EUR"
Example: "EUR"
descriptionstringrequired
Example: "Payout #1"
statestringrequired
Example: "pending"
bank_accountobjectrequired
bank_account.​ibanstringrequired
bank_account.​namestringrequired
metadataobjectrequired
Example: {}
created_atstring or null(date-time)required
Example: "2025-05-28T14:52:26Z"
_linksobjectrequired
Example: {"self":"http://api.paypro.test:3000/payouts/TUMKR465ZG6QDU"}
_links.​selfstring(uri)required
Example: "http://api.paypro.test:3000/payouts/TUMKR465ZG6QDU"
Response
application/json
{
  "id": "POKHCDCQPS4GAA",
  "type": "payout",
  "amount": 12300,
  "currency": "EUR",
  "description": "Payout #1",
  "state": "pending",
  "metadata": {},
  "created_at": "2025-05-28T14:52:26Z",
  "_links": {
    "self": "http://api.paypro.test:3000/payouts/TUMKR465ZG6QDU"
  }
}

Retrieve a list of payouts

Request

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

Security
apiKey

Responses

payouts found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(payout)required
Example: [{"id":"POKHCDCQPS4GAA","type":"payout","amount":12300,"currency":"EUR","description":"Payout #1","state":"pending","metadata":{},"created_at":"2025-05-28T14:52:26Z","_links":{"self":"http://api.paypro.test:3000/payouts/TUMKR465ZG6QDU"}}]
data[].​idstringrequired
Example: "POKHCDCQPS4GAA"
data[].​typestringrequired
Value"payout"
Example: "payout"
data[].​amountintegerrequired
Example: 12300
data[].​fee_amountintegerrequired
data[].​fee_vat_amountintegerrequired
data[].​currencystringrequired
Value"EUR"
Example: "EUR"
data[].​descriptionstringrequired
Example: "Payout #1"
data[].​statestringrequired
Example: "pending"
data[].​bank_accountobjectrequired
data[].​bank_account.​ibanstringrequired
data[].​bank_account.​namestringrequired
data[].​metadataobjectrequired
Example: {}
data[].​created_atstring or null(date-time)required
Example: "2025-05-28T14:52:26Z"
data[].​_linksobjectrequired
Example: {"self":"http://api.paypro.test:3000/payouts/TUMKR465ZG6QDU"}
data[].​_links.​selfstring(uri)required
Example: "http://api.paypro.test:3000/payouts/TUMKR465ZG6QDU"
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 payout

Request

Creates a Payout object.

Security
apiKey
Bodyapplication/json
amountintegerrequired

The amount that will be withdrawn from your balance.

Example: 10000
currencystringrequired

The currency of the payout.

Value"EUR"
Example: "EUR"
metadataobject or null

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

Responses

payout created

Bodyapplication/json
idstringrequired
Example: "POKHCDCQPS4GAA"
typestringrequired
Value"payout"
Example: "payout"
amountintegerrequired
Example: 12300
fee_amountintegerrequired
fee_vat_amountintegerrequired
currencystringrequired
Value"EUR"
Example: "EUR"
descriptionstringrequired
Example: "Payout #1"
statestringrequired
Example: "pending"
bank_accountobjectrequired
bank_account.​ibanstringrequired
bank_account.​namestringrequired
metadataobjectrequired
Example: {}
created_atstring or null(date-time)required
Example: "2025-05-28T14:52:26Z"
_linksobjectrequired
Example: {"self":"http://api.paypro.test:3000/payouts/TUMKR465ZG6QDU"}
_links.​selfstring(uri)required
Example: "http://api.paypro.test:3000/payouts/TUMKR465ZG6QDU"
Response
application/json
{
  "id": "POKHCDCQPS4GAA",
  "type": "payout",
  "amount": 12300,
  "currency": "EUR",
  "description": "Payout #1",
  "state": "pending",
  "metadata": {},
  "created_at": "2025-05-28T14:52:26Z",
  "_links": {
    "self": "http://api.paypro.test:3000/payouts/TUMKR465ZG6QDU"
  }
}

Top-ups

Operations