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.
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
Page header section of payment link page
Payment methods section of payment link page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0
Header text for section
Flag indicating if all allowed payment methods will be pre-selected.
When true
, Visa is accepted.
true
When true
, Mastercard is accepted.
true
When true
, Discover is accepted.
false
When true
, American Express is accepted.
true
When true
, ACH is accepted.
false
When true
, Apple Pay is accepted.
true
Settings for wallet payment methods.
The Apple Pay button style. See Apple Pay Button Style for more information.
black
, white-outline
, white
"black"
The text on Apple Pay button. See Apple Pay Button Type for more information.
plain
, buy
, donate
, check-out
, book
, continue
, top-up
, order
, rent
, support
, contribute
, tip
, pay
"pay"
The Apple Pay button locale. See Apple Pay Button Language for more information.
en-US
, ar-AB
, ca-ES
, zh-CN
, zh-HK
, zh-TW
, hr-HR
, cs-CZ
, da-DK
, de-DE
, nl-NL
, en-AU
, en-GB
, fi-FI
, fr-CA
, fr-FR
, el-GR
, he-IL
, hi-IN
, hu-HU
, id-ID
, it-IT
, ja-JP
, ko-KR
, ms-MY
, nb-NO
, pl-PL
, pt-BR
, pt-PT
, ro-RO
, ru-RU
, sk-SK
, es-MX
, es-ES
, sv-SE
, th-TH
, tr-TR
, uk-UA
, vi-VN
"en-US"
Notes section of payment link page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0
Header text for section
Placeholder text for input field
Pre-populated value for input field
Message section of payment link page
Payment button section of payment link page
ContactUs section of payment link page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0
Header text for section
Custom content for email
Custom content for phone number
Flag indicating if icons for accepted card brands will be shown
Settings section of payment link page
An HTML color code in format #RRGGBB
Complete URL to a custom CSS file to be loaded with the page
Two-letter code following ISO 639-1
Complete URL where the page will be redirected after completion
Flag indicating if the capability for redirection in the page will be activated
Object containing logo file to upload/ use in page
The MIME type of the file (if content is provided)
pdf
, doc
, docx
, jpg
, jpeg
, png
, gif
, txt
"pdf"
The name of the attached file.
"my-doc.pdf"
Optional url provided to show or download the file remotely
"https://mysite.com/my-doc.pdf"
Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
"TXkgdGVzdCBmaWxlHJ==..."
Response
Response text for operation: 'Success' or 'Declined'.
"Success"
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
If isSuccess
= true, this contains the payment link identifier. If isSuccess
= false, this contains the reason of the error.
"2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234"
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"
}