PATCH /paymentLinks/{linkId}

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

Servers

Path parameters

Name Type Required Description
linkId String Yes

Unique identifier of the payment link.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
status String Yes

Status of the payment link. Possible values:

  • expired

Possible values:

  • "expired"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.