GET
/
PaymentLink
/
refresh
/
{payLinkId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/PaymentLink/refresh/{payLinkId} \
  --header 'requestToken: <api-key>'
{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234"
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

ID for the payment link.

Query Parameters

amountFixed
enum<string> | null
default: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.

Available options:
true,
false
Example:

"false"

Response

200
application/json
Success
responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

isSuccess
boolean

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

Example:

true

responseData
string

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

Example:

"2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234"