API referenceShared resource endpointsPayment links

Refresh payment link

Refresh a payment link's content after an update.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

payLinkIdstringRequired
ID for the payment link.

Query parameters

amountFixedenumOptionalDefaults to true

Indicates whether customer can modify the payment amount. A value of true means the amount is not modifiable, a value false means the payor can modify the amount to pay.

Allowed values:

Response

Success
isSuccessbooleanOptional

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

responseDatastringOptional

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

responseTextstringOptional

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

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error