Skip to main content
POST
/
payment-links
Create Payment Link
curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "Contribution costs",
  "amount": "12.95",
  "expiresAt": "2024-05-04",
  "reusable": true
}'
{
  "id": "plk_abc12345def678",
  "description": "Contribution costs",
  "currency": "EUR",
  "amount": "12.95",
  "reusable": true,
  "expiresAt": "2024-05-14T21:00:00+02:00",
  "status": "open",
  "checkoutUrl": "https://demo.mijnklantportaal.nl/payment-link/plk_abc12345def678",
  "createdAt": "2024-04-29T21:00:00+02:00"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
description
string
required

Description of the Payment Link, which will also show up on the bank statement of the payer.

Example:

"Contribution costs"

​
amount
string
required

Amount to be charged in Euro (EUR), as string.

Example:

"12.95"

​
expiresAt
string

Optional date after when the payment link should not work anymore, as format YYYY-mm-dd.

Example:

"2024-05-04"

​
reusable
boolean

Indicates if the payment link can be used multiple times. If false or omitted, the link can only be used once to pay.

Example:

true

Response

The created Payment Link

Payment Link

​
id
string

ID of the offer, always starting with plk_.

Example:

"plk_abc12345def678"

​
description
string

Description which will be used on the bank statement of the payer

Example:

"Contribution costs"

​
currency
string

Currency

Example:

"EUR"

​
amount
string

Amount value as string.

Example:

"12.95"

​
reusable
boolean

Indicates if the link can be used multiple times after a payment was successful

Example:

true

​
expiresAt
string | null

Date and time the link will expire and so not longer can used, if set. Written in ATOM format.

Example:

"2024-05-14T21:00:00+02:00"

​
status
string

Current status of the link. Possible values are open, paid, expired and closed.

Example:

"open"

​
checkoutUrl
string | null

The actual link where you can redirect a payer to for doing the payment. Will return null when the payment link can no longer be used.

Example:

"https://demo.mijnklantportaal.nl/payment-link/plk_abc12345def678"

​
createdAt
string

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

Example:

"2024-04-29T21:00:00+02:00"

⌘I