Update Payment Link
API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Update Payment Link
Updates a payment link’s details.
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
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
ID for the payment link.
Body
The body is of type object
.
Response
200
application/json
Success
The response is of type object
.
Was this page helpful?
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"
}