SchemaPaymentsPayment Links

Update payment link

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

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.

Path parameters

paymentLinkIdstringRequired=10 characters
Unique identifier that we assigned to the payment link.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

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

This endpoint expects a list of objects.
Patch Add OperationobjectRequired
OR
Patch Remove OperationobjectRequired
OR
Patch Replace OperationobjectRequired
OR
Patch Move OperationobjectRequired
OR
Patch Copy OperationobjectRequired
OR
Patch Test OperationobjectRequired

Response

Successful request. We updated the payment link.
OR

Errors