Sign in
paymentLinks

Partially update payment link

Use this method to partially update a payment link. Structure your request to follow the RFC 6902 standard.

To update a payment link, you need its paymentLinkId, which we sent you in the response of the Create Payment Link method.

Note: If you don't have the paymentLinkId, use our List Payment Links method to search for the payment link.

You can update the following properties of a multi-use link:

  • expiresOn parameter - Expiration date of the link.
  • customLabels object - Label for the payment button.
  • credentialOnFile object - Settings for saving the customer's payment details.

You can update the following properties of a single-use link:

  • expiresOn parameter - Expiration date of the link.
  • authType parameter - Transaction type of the payment link.
  • amount parameter - Total amount of the transaction.
  • currency parameter - Currency of the transaction.
  • description parameter - Brief description of the transaction.
  • customLabels object - Label for the payment button.
  • credentialOnFile object - Settings for saving the customer's payment details.

Note: When a merchant updates a single-use link, we update the payment URL and HTML code in the assets object. The customer can't use the original link to make a payment.

patch/payment-links/{paymentLinkId}

Path parameters

paymentLinkIdstring required

Unique identifier that we assigned to the payment link.

Headers

Authorizationstring required

Bearer authentication

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

Response

Successful request. We updated the payment link and return a polymorphic object that contains payment link information. The value of the type parameter determines which variant you should use:

  • multiUse - Create a link that the merchant can use to take multiple payments.
  • singleUse - Create a link that the merchant can use for only one payment.
OR

Changes

No recorded changes to this endpoint across all 1 revision of this API.