API V3Paylink
Updates the Paylink resource.
This endpoint allows you to update an existing paylink to a payment page for your debtor.
All fields are optional. Fields will only be overwritten if they were sent in the call.
### Paylink Payment Status
The status of a paylink can be one of the following:
- paid Payment link will be set to paid
- cancel Payment link will be closed
PATCH
/v3/paylinks/{id}curl -X PATCH "/v3/paylinks/{id}" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/merge-patch+json" \
-d '{
"status": "paid"
}'Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Parameters
idstringpathrequiredPaylink identifier
Body
application/merge-patch+json
The updated Paylink resource
statusenum<string> | nullNew status of the paylink.
One of:paidcancelinvoicesPaylinkInvoice-paylink.write[]
Response
application/json
Paylink resource updated
object
{}