API V3Paylink
Retrieves a Paylink resource.
This endpoint allows you to retrieve the status of a paylink.
### 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/paylinks/{id}curl -X GET "/v3/paylinks/{id}" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY"Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Parameters
idstringpathrequiredPaylink identifier
Response
application/json
Paylink resource
debtor_numberstring | nullpayment_referencestring | nullamountinteger | nullexpiredbooleanDefault:falsepaylink_idintegerrequiredstatusstringrequiredstatus_datestring<date-time> | nullrequest_idstring | nullproviderstring | nullaccount_ownerstring | nullibanstring | nullbicstring | null
{
"debtor_number": "string",
"payment_reference": "string",
"amount": 0,
"expired": false,
"paylink_id": 0,
"status": "string",
"status_date": "2026-01-15T09:30:00Z",
"request_id": "string",
"provider": "string",
"account_owner": "string",
"iban": "string",
"bic": "string"
}