PayPro API Reference (v1)

Servers

https://api.paypro.nl/

Payments

Operations

Refunds

Operations

Chargebacks

Operations

Pay methods

Operations

Customers

Operations

Retrieves a list of customers

Request

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

Responses

customers found

Bodyapplication/json

typestringrequired

Value"list"

dataArray of objects(customer)required

Example: [{"id":"CU7JRN6W6K3DA9","type":"customer","email":"customer@paypro.nl","first_name":"firstname","last_name":"name","address":"address 2","postal":"1234AA","city":"city","country":"NL","vat_number":"vatnumber","company_name":"PayPro","phone_number":"012345679","created_at":"2022-12-31T23:00:00Z","_links":{"self":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9"}}]

data[].idstringrequired

Example: "CU7JRN6W6K3DA9"

data[].typestringrequired

Value"customer"

Example: "customer"

data[].emailstring or null(email)required

Example: "customer@paypro.nl"

data[].first_namestring or nullrequired

Example: "firstname"

data[].last_namestring or nullrequired

Example: "name"

data[].addressstring or nullrequired

Example: "address 2"

data[].postalstring or nullrequired

Example: "1234AA"

data[].citystring or nullrequired

Example: "city"

data[].countrystring or nullrequired

Example: "NL"

data[].vat_numberstring or nullrequired

Example: "vatnumber"

data[].company_namestring or nullrequired

Example: "PayPro"

data[].phone_numberstring or nullrequired

Example: "012345679"

data[].created_atstring(date-time)required

Example: "2022-12-31T23:00:00Z"

data[]._linksobjectrequired

Example: {"self":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9"}

data[]._links.selfstring(uri)required

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

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 customer

Request

Creates a Customer object.

Bodyapplication/json

emailstring or null

Customer's email address

Example: "customer@paypro.nl"

first_namestring or null

Customer's first name

Example: "firstname"

last_namestring or null

Customer's last name

Example: "name"

addressstring or null

Customer's address

Example: "address 2"

postalstring or null

Customer's postal code or ZIP

Example: "1234AA"

citystring or null

Customer's city

Example: "city"

countrystring or null

Customer's country in ISO-3166-1 alpha-2 format, example: 'NL'

Example: "NL"

vat_numberstring or null

Customer's company vat number

Example: "vatnumber"

company_namestring or null

Customer's company name

Example: "PayPro"

phone_numberstring or null

Customer's phone number

Example: "012345679"

Responses

customer created

Bodyapplication/json

idstringrequired

Example: "CU7JRN6W6K3DA9"

typestringrequired

Value"customer"

Example: "customer"

emailstring or null(email)required

Example: "customer@paypro.nl"

first_namestring or nullrequired

Example: "firstname"

last_namestring or nullrequired

Example: "name"

addressstring or nullrequired

Example: "address 2"

postalstring or nullrequired

Example: "1234AA"

citystring or nullrequired

Example: "city"

countrystring or nullrequired

Example: "NL"

vat_numberstring or nullrequired

Example: "vatnumber"

company_namestring or nullrequired

Example: "PayPro"

phone_numberstring or nullrequired

Example: "012345679"

created_atstring(date-time)required

Example: "2022-12-31T23:00:00Z"

_linksobjectrequired

Example: {"self":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9"}

_links.selfstring(uri)required

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

Response

application/json

{
  "id": "CU7JRN6W6K3DA9",
  "type": "customer",
  "email": "customer@paypro.nl",
  "first_name": "firstname",
  "last_name": "name",
  "address": "address 2",
  "postal": "1234AA",
  "city": "city",
  "country": "NL",
  "vat_number": "vatnumber",
  "company_name": "PayPro",
  "phone_number": "012345679",
  "created_at": "2022-12-31T23:00:00Z",
  "_links": {
    "self": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"
  }
}

Retrieves a list of subscriptions that belong to this customer

Request

Retrieves a list of subscriptions that belong to this customer.

Path

idstringrequired

Responses

subscriptions found

Bodyapplication/json

typestringrequired

Value"list"

dataArray of objects(subscription)required

Example: [{"id":"PSV1QACRO4DSMQT0KK","type":"subscription","description":"Test subscription","currency":"EUR","subscription_type":"direct_debit","state":"active","start_at":null,"created_at":"2023-07-24T12:40:10Z","cancel_at":null,"customer":"CU7JRN6W6K3DA9","mandate":"MD6ULYXJ4HP9RJ","scheduling":"automatic","cancel_periods_on_cancellation":false,"period":{"amount":"1000","vat":"21","multiplier":1,"interval":"month"},"first_period":{"amount":"1000","vat":"21","multiplier":1,"interval":"month"},"payment_details":{"return_url":null,"cancel_url":null},"metadata":{},"_links":{"self":"https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}}]

data[].idstringrequired

Example: "PSV1QACRO4DSMQT0KK"

data[].typestringrequired

Value"subscription"

Example: "subscription"

data[].descriptionstringrequired

Example: "Test subscription"

data[].subscription_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[].start_atstring or null(date)required

data[].cancel_atstring or null(date)required

data[].customerstring or nullrequired

Example: "CU7JRN6W6K3DA9"

data[].mandatestring or nullrequired

Example: "MD6ULYXJ4HP9RJ"

data[].schedulingstring or null

Enum"manual""automatic"

Example: "automatic"

data[].cancel_periods_on_cancellationboolean

data[].periodobject or nullrequired

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[].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/subscriptions/PSV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}

data[]._links.selfstring(uri)required

Example: "https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK"

data[]._links.customerstring(uri)

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

data[]._links.mandatestring(uri)

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

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

Mandates

Operations

Subscriptions

Operations

Subscription periods

Operations

Installment plans

Operations

Installment plan periods

Operations

Events

Operations

Webhooks

Operations