Update the status of a payment link

patch/paymentLinks/{linkId}

Updates the status of a payment link. Use this endpoint to force the expiry of a payment link.

Endpoint destination URL
https://checkout-test.adyen.com/v68/paymentLinks/{linkId}
Click to copy

Path Parameters

linkIdstringRequired

Unique identifier of the payment link.

Request Parameters

statusstringRequired

Status of the payment link. Possible values:

  • expired

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less