PUT
/
PaymentLink
/
update
/
{payLinkId}
curl --request PUT \
  --url https://api-sandbox.payabli.com/api/PaymentLink/update/{payLinkId} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "logo": {
    "enabled": true,
    "order": 0
  },
  "page": {
    "enabled": true,
    "order": 0,
    "header": "Payment Page",
    "description": "Complete your payment securely"
  },
  "paymentMethods": {
    "enabled": true,
    "order": 0,
    "header": "Payment Methods",
    "allMethodsChecked": true,
    "methods": {
      "visa": true,
      "mastercard": true,
      "discover": true,
      "amex": true,
      "eCheck": true,
      "applePay": true
    }
  },
  "messageBeforePaying": {
    "enabled": true,
    "order": 0,
    "label": "Please review your payment details"
  },
  "paymentButton": {
    "enabled": true,
    "order": 0,
    "label": "Pay Now"
  },
  "review": {
    "enabled": true,
    "order": 0,
    "header": "Review Payment"
  },
  "notes": {
    "enabled": true,
    "order": 0,
    "header": "Additional Notes",
    "placeholder": "Enter any additional notes here",
    "value": ""
  },
  "contactUs": {
    "enabled": true,
    "order": 0,
    "header": "Contact Us",
    "emailLabel": "Email",
    "phoneLabel": "Phone",
    "paymentIcons": true
  },
  "settings": {
    "color": "#000000",
    "customCssUrl": "https://example.com/custom.css",
    "language": "en",
    "redirectAfterApproveUrl": "https://example.com/success",
    "redirectAfterApprove": true,
    "pageLogo": {
      "ftype": "jpg",
      "filename": "logo.jpg",
      "furl": "",
      "fContent": "PHN2ZyB2aWV3Qm94..."
    }
  }
}'
{
  "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

​
payLinkId
string
required

ID for the payment link.

Body

Logo section of payment link page

​
page
object

Page header section of payment link page

​
paymentMethods
object

Payment methods section of payment link page

​
notes
object

Notes section of payment link page

​
messageBeforePaying
object

Message section of payment link page

​
paymentButton
object

Payment button section of payment link page

​
review
object

Review section of payment link page

​
contactUs
object

ContactUs section of payment link page

​
settings
object

Settings section of payment link page

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"

Was this page helpful?