List Punch Cards - MijnKlantportaal Developer Documentation

List Punch Cards

curl --request GET \
  --url https://api.mijnklantportaal.nl/v1/punch-cards \
  --header 'Authorization: Bearer <token>'

{
  "current_page": 1,
  "data": [
    {
      "id": "pcd_abc12345def678",
      "name": "Driving lessons",
      "description": "Lessons in a BMW, Mon-Fri 09AM-05PM",
      "punches": 20,
      "punchLabel": "lessons",
      "forSale": true,
      "price": "229.95",
      "vatRate": 21,
      "expiryValue": 3,
      "expiryPeriode": "years",
      "createdAt": "2025-11-19T21:00:00+02:00"
    }
  ],
  "first_page_url": "https://api.mijnklantportaal.nl/v1/punch-cards?page=1",
  "from": 1,
  "next_page_url": "https://api.mijnklantportaal.nl/v1/punch-cards?page=2,",
  "path": "https://api.mijnklantportaal.nl/v1/punch-cards",
  "per_page": 15,
  "prev_page_url": null,
  "to": 15
}

GET

punch-cards

List Punch Cards

curl --request GET \
  --url https://api.mijnklantportaal.nl/v1/punch-cards \
  --header 'Authorization: Bearer <token>'

{
  "current_page": 1,
  "data": [
    {
      "id": "pcd_abc12345def678",
      "name": "Driving lessons",
      "description": "Lessons in a BMW, Mon-Fri 09AM-05PM",
      "punches": 20,
      "punchLabel": "lessons",
      "forSale": true,
      "price": "229.95",
      "vatRate": 21,
      "expiryValue": 3,
      "expiryPeriode": "years",
      "createdAt": "2025-11-19T21:00:00+02:00"
    }
  ],
  "first_page_url": "https://api.mijnklantportaal.nl/v1/punch-cards?page=1",
  "from": 1,
  "next_page_url": "https://api.mijnklantportaal.nl/v1/punch-cards?page=2,",
  "path": "https://api.mijnklantportaal.nl/v1/punch-cards",
  "per_page": 15,
  "prev_page_url": null,
  "to": 15
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Paginated response with punch cards

current_page

integer

Current page of the response

Example:

1

data

object[]

Array of Punch Cards objects

Show child attributes

data.id

string

ID of the punch card, always starting with pcd_.

Example:

"pcd_abc12345def678"

data.name

string

Example:

"Driving lessons"

data.description

string | null

Description of the card. Will be shown in the portal

Example:

"Lessons in a BMW, Mon-Fri 09AM-05PM"

data.punches

integer

Punch count for this card

Example:

20

data.punchLabel

string

Type of punches

Example:

"lessons"

data.forSale

boolean

Indicates if the punch card can be bought online in the customer portal

Example:

true

data.price

string | null

Price, including VAT, of which this card will be sold for, in EUR. Will be null when the card is not for sale

Example:

"229.95"

data.vatRate

integer | null

Percentage of VAT which is applied to the price. Can be 21, 9 or 0. Will be null when the card is not for sale

Example:

21

data.expiryValue

integer

Number of units when this cards expires into the future

Example:

3

data.expiryPeriode

string | null

Unit of when this cards expires into the future. Can be days, months or years.

Example:

"years"

data.createdAt

string

Date and time when the card was created. Written in ATOM format.

Example:

"2025-11-19T21:00:00+02:00"

first_page_url

string

Endpoint to go to the first page of objects

Example:

"https://api.mijnklantportaal.nl/v1/punch-cards?page=1"

from

integer

Offset of the current page

Example:

1

next_page_url

string | null

Endpoint to get the next batch of objects, if available

Example:

"https://api.mijnklantportaal.nl/v1/punch-cards?page=2,"

path

string

Current used endpoint

Example:

"https://api.mijnklantportaal.nl/v1/punch-cards"

per_page

integer

Amount of object returned per page. Default is 15 objects

Example:

15

prev_page_url

string | null

Endpoint to get the previous batch of object, if available

Example:

null

integer

Next offset of objects

Example:

15

List Payment Link Payments

Create Punch Card

⌘I

API v1

Authorizations

Response