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
- Organization
- Paypoint
- Customer
- User
- Vendor
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Get Paypoint Details by ID
Retrieves the basic details for a paypoint by ID.
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
Paypoint ID. You can find this value by querying /api/Query/paypoints/{orgId}
Response
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Auxiliary validation used internally by payment pages and components.
Code for the response. Learn more in API Response Codes.
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
Toggles 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.
Type of end date
accepted frequencies for autopay
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
Order of element or section in container.
x > 0Link to view invoice details
Message 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
Order of element or section in container.
x > 0Settings for wallet payment methods.
Customer/Payor section of payment page
Toggles whether the section or element is enabled.
Array of Customer/Payor fields to show in section
Custom header text for section
Order of element or section in container.
x > 0Review section of payment page
Toggles whether the section or element is enabled.
Header text for section
Order of element or section in container.
x > 0Unique 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 > 0Section payment information of payment receipt
The receipt's settings.
Toggles whether the section or element is enabled.
Fields to display on the reciept.
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
The address.
Additional line for the address.
Information about associated bank accounts.
Masked account number for bank account.
Describes whether the bank account is used for deposits or withdrawals in Payabli:
0: Deposit1: Withdrawal2: Deposit and withdrawal
The accountholder's name.
Describes whether the bank is a personal or business account.
Personal, Business Name of bank for account.
The bank's ID in Payabli.
Routing number of bank account.
Type of bank account: Checking or Savings.
Checking, Savings The Payabli-assigned ID of the boarding application linked to this paypoint.
The city.
List of contacts.
The country in ISO-3166-1 alpha 2 format. See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
The alternate or common name that this business is doing business under usually referred to as a DBA name.
A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.
Fax number
Paypoint ID.
Business legal name.
Organization ID. Unique identifier assigned to an org by Payabli.
The organization's address.
Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.
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
The name of the organization.
The paypoint's status.
Active - 1
Inactive - 0
The organization type. Currently, this must be 0.
The paypoint's status.
Active - 1
Inactive - 0
Phone number.
Controls which services will be enabled for the merchant.
CCD is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Corporate Credit or Debit Entry. Options are: true and false
PPD is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Prearranged Payment and Deposit.
Web is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Internet Initiated/Mobile Entry Options are true and false.
Determines whether American Express is accepted.
Determines whether Discover is accepted.
Determines whether MasterCard is accepted.
Determines whether Visa is accepted.
The state or province.
Timezone, in UTC offset. For example, -5 is Eastern time.
The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.
ZIP code for address.
Response text for operation: 'Success' or 'Declined'.
Was this page helpful?