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.
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.
If isSuccess = true, responseData contains the payment link page content. If isSuccess = false, responseData contains a string with the reason for the error.
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"
}
}
Array of credential objects with active services for the page
Timestamp of last access to page structure
Sections of page
Amount section of payment page
Order of element or section in container.
x > 0Toggles whether the section or element is enabled.
Order of element or section in container.
x > 0Autopay section of payment page
Toggles whether the section or element is enabled.
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
Value of pre-selected frequency
Header text for section
Order of element or section in container.
x > 0Range of days enabled in calendar Leave empty to enable all days.
ContactUs section of payment page
Custom content for email
Toggles whether the section or element is enabled.
Header text for section
Order of element or section in container.
x > 0Flag indicating if icons for accepted card brands will be shown
Custom content for phone number
Identifier of entry point owner of page
Invoices section of payment page
Toggles whether the section or element is enabled.
Link to invoice
Toggles whether the section or element is enabled.
Label to display for section or element
Order of element or section in container.
x > 0Order of element or section in container.
x > 0Link to view invoice details
Toggles whether the section or element is enabled.
Label to display for section or element
Order of element or section in container.
x > 0Message section of payment page
Toggles whether the section or element is enabled.
Label to display for section or element
Order of element or section in container.
x > 0Descriptor of page
Notes section of payment page
Toggles whether the section or element is enabled.
Header text for section
Order of element or section in container.
x > 0Placeholder text for input field
Pre-populated value for input field
Page header section of payment page
Page description in header
Toggles whether the section or element is enabled.
Page header
Order of element or section in container.
x > 0Payment button section of payment page
Toggles whether the section or element is enabled.
Label to display for section or element
Order of element or section in container.
x > 0Payment methods section of payment page
Flag indicating if all allowed payment methods will be pre-selected.
Toggles whether the section or element is enabled.
Header text for section
When true, American Express is accepted.
When true, Apple Pay is accepted.
When true, Discover is accepted.
When true, ACH is accepted.
When true, Mastercard is accepted.
When true, Visa is accepted.
Order of element or section in container.
x > 0Customer/Payor section of payment page
Toggles whether the section or element is enabled.
Array of Customer/Payor fields to show in section
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
Label to display for field
Name of field to show Should be one of the standard customer fields or a custom field name
Order of element or section in container.
x > 0Flag indicating if the input field is required for validation
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
Numeric 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 Custom header text for section
Order of element or section in container.
x > 0Review section of payment page
Unique identifier assigned to the page.
50Auxiliary validation used internally by payment pages and components.
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
Object containing logo file to upload/ use in page
Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
The name of the attached file.
The MIME type of the file (if content is provided)
pdf, doc, docx, jpg, jpeg, png, gif, txt Optional url provided to show or download the file remotely
Flag indicating if the capability for redirection in the page will be activated
Complete URL where the page will be redirected after completion
Flag indicating if page is active to accept payments. 0 for false, 1 for true.
0, 1 Sections of payment receipt
Section message of payment receipt
Toggles whether the section or element is enabled.
Label to display for section or element
Order of element or section in container.
x > 0Section page of payment receipt
Page description in header
Toggles whether the section or element is enabled.
Page header
Order of element or section in container.
x > 0Section payment button of payment receipt
Toggles whether the section or element is enabled.
Label to display for section or element
Order of element or section in container.
x > 0The receipt's settings.
Toggles whether the section or element is enabled.
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.
Page identifier. Must be unique in platform.
50Total amount to pay in this page
Base64 encoded image of Captcha associated to this page load
Response text for operation: 'Success' or 'Declined'.
Was this page helpful?