Update payment link

Updates a payment link's details.

Path parameters

payLinkIdstringRequired
ID for the payment link.

Headers

requestTokenstringRequired

Request

This endpoint expects an object.
contactUsobjectOptional
ContactUs section of payment link page
messageBeforePayingobjectOptional
Message section of payment link page
notesobjectOptional
Notes section of payment link page
pageobjectOptional
Page header section of payment link page
paymentButtonobjectOptional
Payment button section of payment link page
paymentMethodsobjectOptional
Payment methods section of payment link page
reviewobjectOptional
Review section of payment link page
settingsobjectOptional
Settings section of payment link page

Response

Success
isSuccessboolean or null

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDatastring or null

If isSuccess = true, this contains the payment link identifier. If isSuccess = false, this contains the reason of the error.

responseTextstring or null

Response text for operation: ‘Success’ or ‘Declined’.

Errors