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
Page header section of payment link page
Invoices section of payment link page
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Link 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 link 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 link 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
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 >= 0Header 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 >= 0Header 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==..."
Was this page helpful?
{
"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
},
"settings": {
"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==..."
}
}
}