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
PayLinkData Object Model
Object model for the PayLinkData object
ContactUs section of payment link 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
Invoices section of payment link page
Toggles whether the section or element is enabled.
Order of element or section in container.
x > 0Link to view invoice details
Message section of payment link page
Notes section of payment link 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
Payment methods section of payment link 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 > 0Settings for wallet payment methods.
The Apple Pay button style. See Apple Pay Button Style for more information.
black, white-outline, white 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 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 Customer/Payor section of payment link 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 > 0Settings 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
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
Was this page helpful?