API V3Paylink
Retrieves the collection of Paylink resources.
This endpoint allows you to retrieve a list of paylinks.
### Paylink Status
The status of a paylink can be one of the following:
- no_response No reaction to the message
- visited_website Customer has clicked on the link
- payment_started Payment started, but not yet finished
- payment_canceled Payment cancelled by the customer
- payment_failed Payment failed. E.g. insufficient funds
- payment_invalid Payment started, but status not yet known
- payment_expired Payment started, but not completed on time
- paid Full amount has been paid
- chargeback Payment was reversed by customer
GET
/v3/paylinkscurl -X GET "/v3/paylinks" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY"Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Parameters
pageintegerqueryThe collection page number
Default:1batch_namestringquerydebtor_numberstringquerypayment_referencestringquerystatusstringquerystatus[]string[]querystatus_datestringquery
Response
application/json200
Paylink collection
total_itemsintegeritems_per_pageintegerpage_countintegermemberPaylink.PaylinkSummary-paylink.read[]required
{
"total_items": 100,
"items_per_page": 10,
"page_count": 10,
"member": [
{
"paylink_id": 0,
"status": "string",
"status_date": "2026-01-15T09:30:00Z",
"request_id": "string",
"provider": "string",
"account_owner": "string",
"iban": "string",
"bic": "string"
}
]
}