PayPro API Reference (v1)

Servers
https://api.paypro.nl/

Payments

Operations

Refunds

Operations

Chargebacks

Operations

Retrieves a chargeback

Request

Retrieves a single chargeback based on the id.

Path
idstringrequired

Responses

chargeback found

Bodyapplication/json
idstringrequired
Example: "PCG2SZKYJCCDV8"
typestringrequired
Value"chargeback"
Example: "chargeback"
amountintegerrequired
Example: 1000
descriptionstringrequired
Example: "Test Payment"
reasonstring or nullrequired
Example: "MD06"
currencystringrequired
Value"EUR"
Example: "EUR"
paymentstringrequired
Example: "PPBLGEE6UG92MS"
statestringrequired
Example: "completed"
charged_back_atstring or null(date-time)required
created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8"
_links.​paymentstring(uri)required
Example: "https://api.paypro.nl/payments/PPBLGEE6UG92MS"
Response
application/json
{
  "id": "PCG2SZKYJCCDV8",
  "type": "chargeback",
  "amount": 1000,
  "description": "Test Payment",
  "reason": "MD06",
  "payment": "PPBLGEE6UG92MS",
  "currency": "EUR",
  "state": "completed",
  "refunded_at": "2023-06-30T12:44:35Z",
  "created_at": "2023-06-30T12:40:10Z",
  "_links": {
    "self": "https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8",
    "payment": "https://api.paypro.nl/payments/PPBLGEE6UG92MS"
  }
}

Retrieve a list of chargebacks

Request

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

Responses

chargebacks found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(chargeback)required
Example: [{"id":"PCG2SZKYJCCDV8","type":"chargeback","amount":1000,"description":"Test Payment","reason":"MD06","payment":"PPBLGEE6UG92MS","currency":"EUR","state":"completed","refunded_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}}]
data[].​idstringrequired
Example: "PCG2SZKYJCCDV8"
data[].​typestringrequired
Value"chargeback"
Example: "chargeback"
data[].​amountintegerrequired
Example: 1000
data[].​descriptionstringrequired
Example: "Test Payment"
data[].​reasonstring or nullrequired
Example: "MD06"
data[].​currencystringrequired
Value"EUR"
Example: "EUR"
data[].​paymentstringrequired
Example: "PPBLGEE6UG92MS"
data[].​statestringrequired
Example: "completed"
data[].​charged_back_atstring or null(date-time)required
data[].​created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}
data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8"
data[].​_links.​paymentstring(uri)required
Example: "https://api.paypro.nl/payments/PPBLGEE6UG92MS"
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"
  }
}

Pay methods

Operations

Customers

Operations

Mandates

Operations

Subscriptions

Operations

Subscription periods

Operations

Installment plans

Operations

Installment plan periods

Operations

Events

Operations

Webhooks

Operations