PayPro API Reference (v1)

Servers
https://api.paypro.nl/

Payments

Operations

Refunds

Operations

Chargebacks

Operations

Pay methods

Operations

Customers

Operations

Mandates

Operations

Retrieve a list of mandates

Request

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

Responses

mandates found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(mandate)required
Example: [{"id":"MDQVT0CGB8Z5JK","type":"mandate","state":"pending","customer":"CUWSWVVPTL94VX","pay_method":"direct-debit","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK","customer":"https://api.paypro.nl/customers/CUWSWVVPTL94VX"}}]
data[].​idstringrequired
Example: "MDQVT0CGB8Z5JK"
data[].​typestringrequired
Value"mandate"
Example: "mandate"
data[].​statestringrequired
Example: "pending"
data[].​customerstringrequired
Example: "CUWSWVVPTL94VX"
data[].​pay_methodstringrequired
Example: "direct-debit"
data[].​created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK","customer":"https://api.paypro.nl/customers/CUWSWVVPTL94VX"}
data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK"
data[].​_links.​customerstring(uri)required
Example: "https://api.paypro.nl/customers/CUWSWVVPTL94VX"
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 mandate

Request

Creates a Mandate object.

You can only create a mandate manually for 'direct-debit'. The other supported pay methods require authorization through a Payment.

Bodyapplication/json
customerstringrequired

The reference of the Customer you want to create the mandate for.

Example: "CUWSWVVPTL94VX"
pay_methodstringrequired

The payment method of the mandate. Only 'direct-debit' is supported.

Value"direct-debit"
Example: "direct-debit"
ibanstring or null

When using 'direct-debit', this is the IBAN of the bank account.

Example: "NL47ABNA0612205029"
account_holder_namestring or null

When using 'direct-debit', this is the name of the account holder.

Example: "PayPro"

Responses

mandate created

Bodyapplication/json
idstringrequired
Example: "MDQVT0CGB8Z5JK"
typestringrequired
Value"mandate"
Example: "mandate"
statestringrequired
Example: "pending"
customerstringrequired
Example: "CUWSWVVPTL94VX"
pay_methodstringrequired
Example: "direct-debit"
created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK","customer":"https://api.paypro.nl/customers/CUWSWVVPTL94VX"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK"
_links.​customerstring(uri)required
Example: "https://api.paypro.nl/customers/CUWSWVVPTL94VX"
Response
application/json
{
  "id": "MDQVT0CGB8Z5JK",
  "type": "mandate",
  "state": "pending",
  "customer": "CUWSWVVPTL94VX",
  "pay_method": "direct-debit",
  "created_at": "2023-06-30T12:40:10Z",
  "_links": {
    "self": "https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK",
    "customer": "https://api.paypro.nl/customers/CUWSWVVPTL94VX"
  }
}

Subscriptions

Operations

Subscription periods

Operations

Installment plans

Operations

Installment plan periods

Operations

Events

Operations

Webhooks

Operations