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
Get Payment Link by ID
Retrieves a payment link by ID.
curl --request GET \
--url https://api-sandbox.payabli.com/api/PaymentLink/load/{paylinkId} \
--header 'requestToken: <api-key>'{
"isSuccess": true,
"responseText": "Success",
"responseData": {
"subdomain": "mypage-1",
"lastAccess": "2022-06-30 15:01:00",
"totalAmount": 123,
"pageContent": {
"name": "<string>",
"entry": "<string>",
"subdomain": "mypage-1",
"logo": {
"enabled": true,
"order": 1
},
"page": {
"enabled": true,
"order": 1,
"header": "<string>",
"description": "<string>"
},
"invoices": {
"enabled": true,
"order": 1,
"invoiceLink": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"viewInvoiceDetails": {
"enabled": true,
"order": 1,
"label": "<string>"
}
},
"payor": {
"enabled": true,
"order": 1,
"header": "<string>",
"fields": [
{
"name": "<string>",
"label": "<string>",
"validation": "<string>",
"value": "<string>",
"required": true,
"display": true,
"fixed": true,
"identifier": true,
"order": 1,
"width": 4
}
]
},
"paymentMethods": {
"enabled": true,
"order": 1,
"header": "<string>",
"allMethodsChecked": true,
"methods": {
"visa": true,
"mastercard": true,
"discover": false,
"amex": true,
"eCheck": false,
"applePay": true
},
"settings": {
"applePay": {
"buttonStyle": "black",
"buttonType": "pay",
"language": "en-US"
}
}
},
"notes": {
"enabled": true,
"order": 1,
"header": "<string>",
"placeholder": "<string>",
"value": "<string>"
},
"messageBeforePaying": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"paymentButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"review": {
"enabled": true,
"order": 1,
"header": "<string>"
},
"contactUs": {
"enabled": true,
"order": 1,
"header": "<string>",
"emailLabel": "<string>",
"phoneLabel": "<string>",
"paymentIcons": true
},
"autopay": {
"enabled": true,
"order": 1,
"header": "<string>",
"finish": {
"untilCancelled": true,
"calendar": true
},
"frequency": {
"one-time": true,
"weekly": true,
"every2Weeks": true,
"every6Months": true,
"monthly": true,
"every3Months": true,
"annually": true
},
"startDate": "1, 5-10",
"frequencySelected": "<string>"
},
"amount": {
"enabled": true,
"order": 1,
"categories": [
{
"name": "<string>",
"type": "<string>",
"label": "<string>",
"value": "<string>",
"description": "<string>",
"order": 1,
"quantity": 123,
"showDescription": true,
"optionalPay": true
}
]
}
},
"receiptContent": {
"logo": {
"enabled": true,
"order": 1
},
"page": {
"enabled": true,
"order": 1,
"header": "<string>",
"description": "<string>"
},
"amount": {
"enabled": true,
"order": 1
},
"details": {
"enabled": true,
"order": 1
},
"paymentInformation": {
"enabled": true,
"order": 1
},
"messageBeforeButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"paymentButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"contactUs": {
"enabled": true,
"order": 1
},
"settings": {
"enabled": true,
"order": 1,
"sendAuto": true,
"sendManual": false,
"fields": [
{
"name": "<string>",
"display": true,
"Fixed": true
}
]
}
},
"pageSettings": {
"color": "<string>",
"customCssUrl": "<string>",
"language": "<string>",
"redirectAfterApproveUrl": "<string>",
"redirectAfterApprove": true,
"pageLogo": {
"ftype": "pdf",
"filename": "my-doc.pdf",
"furl": "https://mysite.com/my-doc.pdf",
"fContent": "TXkgdGVzdCBmaWxlHJ==..."
},
"paymentButton": {
"label": "<string>",
"size": "sm"
}
},
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"published": 0,
"credentials": [
{
"service": "<string>",
"mode": 123,
"minticket": 123,
"maxticket": 123,
"cfeeFix": 123,
"cfeeFloat": 123,
"cfeeMin": 123,
"cfeeMax": 123,
"accountId": "<string>",
"referenceId": 123
}
],
"pageIdentifier": "null",
"validationCode": "<string>"
}
}Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
ID for payment link
Response
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
If isSuccess = true, responseData contains the payment link page content. If isSuccess = false, responseData contains a string with the reason for the error.
Page identifier. Must be unique in platform.
50"mypage-1"
Timestamp of last access to page structure
"2022-06-30 15:01:00"
Total amount to pay in this page
Sections of page
Descriptor of page
Identifier of entry point owner of page
Unique identifier assigned to the page.
50"mypage-1"
Page header section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Page header
Page description in header
Invoices section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Link to invoice
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Label to display for section or element
Link to view invoice details
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Label to display for section or element
Customer/Payor section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Custom header text for section
Array of Customer/Payor fields to show in section
Name of field to show Should be one of the standard customer fields or a custom field name
Label to display for field
Type of validation to apply to the input field Accepted values:
- alpha for alphabetic, - numbers for numeric, - text for alphanumeric, - email for masked email address input, - phone for US phone numbers
Pre-populated value for field
Flag indicating if the input field is required for validation
Flag indicating if the input field will show in container
Flag indicating if the value in input field is readonly or not
Flag indicating if the input field is a customer identifier
Order of element or section in container.
x >= 0Numeric value indicating the size of input relative to the container Accepted values:
- 4 = 1/3, - 6 = 1/2, - 8 = 2/3, - 12 = 3/3
4, 6, 8, 12 Payment methods section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Header 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
Notes section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Header text for section
Placeholder text for input field
Pre-populated value for input field
Message section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Label to display for section or element
Payment button section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Label to display for section or element
Review section of payment page
ContactUs section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Header text for section
Custom content for email
Custom content for phone number
Flag indicating if icons for accepted card brands will be shown
Autopay section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Header text for section
accepted frequencies for autopay
Enable or disable frequency
Enable or disable frequency
Enable or disable frequency
Enable or disable frequency
Enable or disable frequency
Enable or disable frequency
Enable or disable frequency
Range of days enabled in calendar Leave empty to enable all days.
"1, 5-10"
Value of pre-selected frequency
Amount section of payment page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Order of element or section in container.
x >= 0Sections of payment receipt
Section page of payment receipt
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Page header
Page description in header
Section payment information of payment receipt
Section message of payment receipt
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Label to display for section or element
Section payment button of payment receipt
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Label to display for section or element
The receipt's settings.
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0When true, Payabli automatically sends the receipt to the payor email address.
When true, you must send the reciept to the payor manually using the /MoneyIn/sendreceipt/{transId} endpoint.
Settings of 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==..."
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
Flag indicating if page is active to accept payments. 0 for false, 1 for true.
0, 1 Array of credential objects with active services for the page
Auxiliary validation used internally by payment pages and components.
null
Base64 encoded image of Captcha associated to this page load
Was this page helpful?
curl --request GET \
--url https://api-sandbox.payabli.com/api/PaymentLink/load/{paylinkId} \
--header 'requestToken: <api-key>'{
"isSuccess": true,
"responseText": "Success",
"responseData": {
"subdomain": "mypage-1",
"lastAccess": "2022-06-30 15:01:00",
"totalAmount": 123,
"pageContent": {
"name": "<string>",
"entry": "<string>",
"subdomain": "mypage-1",
"logo": {
"enabled": true,
"order": 1
},
"page": {
"enabled": true,
"order": 1,
"header": "<string>",
"description": "<string>"
},
"invoices": {
"enabled": true,
"order": 1,
"invoiceLink": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"viewInvoiceDetails": {
"enabled": true,
"order": 1,
"label": "<string>"
}
},
"payor": {
"enabled": true,
"order": 1,
"header": "<string>",
"fields": [
{
"name": "<string>",
"label": "<string>",
"validation": "<string>",
"value": "<string>",
"required": true,
"display": true,
"fixed": true,
"identifier": true,
"order": 1,
"width": 4
}
]
},
"paymentMethods": {
"enabled": true,
"order": 1,
"header": "<string>",
"allMethodsChecked": true,
"methods": {
"visa": true,
"mastercard": true,
"discover": false,
"amex": true,
"eCheck": false,
"applePay": true
},
"settings": {
"applePay": {
"buttonStyle": "black",
"buttonType": "pay",
"language": "en-US"
}
}
},
"notes": {
"enabled": true,
"order": 1,
"header": "<string>",
"placeholder": "<string>",
"value": "<string>"
},
"messageBeforePaying": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"paymentButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"review": {
"enabled": true,
"order": 1,
"header": "<string>"
},
"contactUs": {
"enabled": true,
"order": 1,
"header": "<string>",
"emailLabel": "<string>",
"phoneLabel": "<string>",
"paymentIcons": true
},
"autopay": {
"enabled": true,
"order": 1,
"header": "<string>",
"finish": {
"untilCancelled": true,
"calendar": true
},
"frequency": {
"one-time": true,
"weekly": true,
"every2Weeks": true,
"every6Months": true,
"monthly": true,
"every3Months": true,
"annually": true
},
"startDate": "1, 5-10",
"frequencySelected": "<string>"
},
"amount": {
"enabled": true,
"order": 1,
"categories": [
{
"name": "<string>",
"type": "<string>",
"label": "<string>",
"value": "<string>",
"description": "<string>",
"order": 1,
"quantity": 123,
"showDescription": true,
"optionalPay": true
}
]
}
},
"receiptContent": {
"logo": {
"enabled": true,
"order": 1
},
"page": {
"enabled": true,
"order": 1,
"header": "<string>",
"description": "<string>"
},
"amount": {
"enabled": true,
"order": 1
},
"details": {
"enabled": true,
"order": 1
},
"paymentInformation": {
"enabled": true,
"order": 1
},
"messageBeforeButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"paymentButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"contactUs": {
"enabled": true,
"order": 1
},
"settings": {
"enabled": true,
"order": 1,
"sendAuto": true,
"sendManual": false,
"fields": [
{
"name": "<string>",
"display": true,
"Fixed": true
}
]
}
},
"pageSettings": {
"color": "<string>",
"customCssUrl": "<string>",
"language": "<string>",
"redirectAfterApproveUrl": "<string>",
"redirectAfterApprove": true,
"pageLogo": {
"ftype": "pdf",
"filename": "my-doc.pdf",
"furl": "https://mysite.com/my-doc.pdf",
"fContent": "TXkgdGVzdCBmaWxlHJ==..."
},
"paymentButton": {
"label": "<string>",
"size": "sm"
}
},
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"published": 0,
"credentials": [
{
"service": "<string>",
"mode": 123,
"minticket": 123,
"maxticket": 123,
"cfeeFix": 123,
"cfeeFloat": 123,
"cfeeMin": 123,
"cfeeMax": 123,
"accountId": "<string>",
"referenceId": 123
}
],
"pageIdentifier": "null",
"validationCode": "<string>"
}
}