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 Entry
Gets the details for a single paypoint.
curl --request GET \
--url https://api-sandbox.payabli.com/api/Paypoint/{entry} \
--header 'requestToken: <api-key>'{
"responseCode": 1,
"pageIdentifier": null,
"roomId": 0,
"isSuccess": true,
"responseText": "Success",
"responseData": {
"Paypoint": {
"IdPaypoint": 1234,
"DbaName": "Example Training LLC",
"LegalName": "Example Training LLC",
"Address1": "123 Training Road",
"Address2": "STE 900",
"City": "Exampletown",
"Zip": "37615",
"State": "TN",
"Country": "US",
"WebsiteAddress": "https://www.example-training.com",
"Phone": "(555) 555-1234",
"Summary": "Training School",
"Fax": "",
"externalPaypointID": "",
"BoardingId": 12345,
"Contacts": [
{
"ContactName": "Jane Smith",
"ContactEmail": "contact@example-training.com",
"ContactTitle": "COO",
"ContactPhone": "(555) 555-5678"
}
],
"ServiceData": null,
"BankData": [
{
"id": 1111,
"bankName": "EXAMPLE FEDERAL BANK",
"routingAccount": "123456789",
"accountNumber": "0XXXXXX9999",
"typeAccount": "Checking",
"bankAccountHolderName": null,
"bankAccountHolderType": null,
"bankAccountFunction": 0,
"verified": false
},
{
"id": 2222,
"bankName": "EXAMPLE FEDERAL BANK",
"routingAccount": "123456789",
"accountNumber": "0XXXXXX9999",
"typeAccount": "Checking",
"bankAccountHolderName": null,
"bankAccountHolderType": null,
"bankAccountFunction": 1,
"verified": false
}
],
"PaypointStatus": 1,
"TimeZone": 0,
"ParentOrg": {
"IdOrg": 123,
"OrgName": "Example Organization",
"OrgType": 0,
"OrgStatus": 1,
"OrgLogo": null,
"OrgAddress": null
},
"Credentials": [
{
"Service": "ach",
"Mode": 0,
"Minticket": 0,
"Maxticket": 20000,
"CfeeFix": 0,
"CfeeFloat": 0,
"CfeeMin": 0,
"CfeeMax": 0,
"ReferenceId": 1111,
"AccountId": "EX_123456789"
},
{
"Service": "ach",
"Mode": 1,
"Minticket": 0,
"Maxticket": 20000,
"CfeeFix": 0,
"CfeeFloat": 0,
"CfeeMin": 0,
"CfeeMax": 0,
"ReferenceId": 1111,
"AccountId": "EX_123456789"
},
{
"Service": "card",
"Mode": 0,
"Minticket": 0,
"Maxticket": 20000,
"CfeeFix": 0,
"CfeeFloat": 3,
"CfeeMin": 0,
"CfeeMax": 0,
"ReferenceId": 2222,
"AccountId": "EX_987654321"
}
],
"SuspendedTransfer": 0,
"summary": {
"customers": 1,
"countTx": 0,
"amountTx": 0,
"countSubs": 0,
"amountSubs": 0
},
"bStartDate": null
},
"EntryPages": [],
"IdEntry": 11111,
"EntryName": "abc123def",
"EntryLogo": null,
"EntryTitle": null,
"EntrySubtitle": null,
"EntryComment": null
}
}Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
The paypoint's entrypoint identifier. Learn more
"8cfec329267"
Query Parameters
Response
Code for the response. Learn more in API Response Codes.
1
Auxiliary validation used internally by payment pages and components.
null
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"
Paypoint ID.
"198"
The alternate or common name that this business is doing business under usually referred to as a DBA name.
"Sunshine Gutters"
Business legal name.
"Sunshine Services, LLC"
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.
"Paypoint-100"
The address.
"123 Ocean Drive"
Additional line for the address.
"Suite 400"
The city.
"Bristol"
ZIP code for address.
"31113"
The state or province.
"GA"
The country in ISO-3166-1 alpha 2 format. See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
"US"
The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.
"www.example.com"
Phone number.
"5555555555"
Fax number
"5555555555"
The Payabli-assigned ID of the boarding application linked to this paypoint.
340
List of contacts.
Contact name.
"Herman Martinez"
Contact email address.
320"example@email.com"
Contact title.
"Owner"
Contact phone number.
"3055550000"
Controls which services will be enabled for the merchant.
Determines whether Visa is accepted.
true
Determines whether Mastercard is accepted.
true
Determines whether Discover is accepted.
false
Determines whether American Express is accepted.
true
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.
true
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.
false
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
false
Enables or disables ACH payout functionality
Enables or disables check printing payout functionality
Enables or disables vCard payout functionality
Payment processor identifier
"tysys"
Region where payment processing occurs
US, CA "US"
Reference ID for the program enabled for ODP issuance
123456
Information about associated bank accounts.
Object that contains bank account details.
The bank's ID in Payabli.
User-defined name for the bank account.
"Business Checking 1234"
Name of bank for account.
"Country Bank"
Routing number of bank account.
"123123123"
Masked account number for bank account.
"1XXXXXX3123"
Type of bank account: Checking or Savings.
Checking, Savings "Checking"
The accountholder's name.
"Gruzya Adventure Outfitters LLC"
Describes whether the bank is a personal or business account.
Personal, Business "Business"
Indicates the function of the bank account:
- 0 - Deposits
- 1 - Withdrawals
- 2 - Deposits & Withdrawals
- 3 - Remittances
- 4 - Remittances & Deposits
- 5 - Remittances & Withdrawals
- 6 - Remittances & Withdrawals & Deposits
A paypoint is required to have a single deposit and withdrawal account. A Paypoint can have as many remittance accounts as needed for pay outs (remittances).
0, 1, 2, 3, 4, 5, 6 0
The paypoint's status.
Active - 1
Inactive - 0
1
Timezone, in UTC offset. For example, -5 is Eastern time.
-5
Organization ID. Unique identifier assigned to an org by Payabli.
123
The name of the organization.
"Pilgrim Planner"
The organization type. Currently, this must be 0.
0
The paypoint's status.
Active - 1
Inactive - 0
1
Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.
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==..."
The organization's address.
"123 Walnut Street"
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
Link to view invoice details
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
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.
Settings for wallet payment methods.
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
Toggles whether the section or element is enabled.
true
Order of element or section in container.
x >= 0Header text for section
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
Type of end date
accepted frequencies for autopay
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 >= 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.
Fields to display on the reciept.
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/Paypoint/{entry} \
--header 'requestToken: <api-key>'{
"responseCode": 1,
"pageIdentifier": null,
"roomId": 0,
"isSuccess": true,
"responseText": "Success",
"responseData": {
"Paypoint": {
"IdPaypoint": 1234,
"DbaName": "Example Training LLC",
"LegalName": "Example Training LLC",
"Address1": "123 Training Road",
"Address2": "STE 900",
"City": "Exampletown",
"Zip": "37615",
"State": "TN",
"Country": "US",
"WebsiteAddress": "https://www.example-training.com",
"Phone": "(555) 555-1234",
"Summary": "Training School",
"Fax": "",
"externalPaypointID": "",
"BoardingId": 12345,
"Contacts": [
{
"ContactName": "Jane Smith",
"ContactEmail": "contact@example-training.com",
"ContactTitle": "COO",
"ContactPhone": "(555) 555-5678"
}
],
"ServiceData": null,
"BankData": [
{
"id": 1111,
"bankName": "EXAMPLE FEDERAL BANK",
"routingAccount": "123456789",
"accountNumber": "0XXXXXX9999",
"typeAccount": "Checking",
"bankAccountHolderName": null,
"bankAccountHolderType": null,
"bankAccountFunction": 0,
"verified": false
},
{
"id": 2222,
"bankName": "EXAMPLE FEDERAL BANK",
"routingAccount": "123456789",
"accountNumber": "0XXXXXX9999",
"typeAccount": "Checking",
"bankAccountHolderName": null,
"bankAccountHolderType": null,
"bankAccountFunction": 1,
"verified": false
}
],
"PaypointStatus": 1,
"TimeZone": 0,
"ParentOrg": {
"IdOrg": 123,
"OrgName": "Example Organization",
"OrgType": 0,
"OrgStatus": 1,
"OrgLogo": null,
"OrgAddress": null
},
"Credentials": [
{
"Service": "ach",
"Mode": 0,
"Minticket": 0,
"Maxticket": 20000,
"CfeeFix": 0,
"CfeeFloat": 0,
"CfeeMin": 0,
"CfeeMax": 0,
"ReferenceId": 1111,
"AccountId": "EX_123456789"
},
{
"Service": "ach",
"Mode": 1,
"Minticket": 0,
"Maxticket": 20000,
"CfeeFix": 0,
"CfeeFloat": 0,
"CfeeMin": 0,
"CfeeMax": 0,
"ReferenceId": 1111,
"AccountId": "EX_123456789"
},
{
"Service": "card",
"Mode": 0,
"Minticket": 0,
"Maxticket": 20000,
"CfeeFix": 0,
"CfeeFloat": 3,
"CfeeMin": 0,
"CfeeMax": 0,
"ReferenceId": 2222,
"AccountId": "EX_987654321"
}
],
"SuspendedTransfer": 0,
"summary": {
"customers": 1,
"countTx": 0,
"amountTx": 0,
"countSubs": 0,
"amountSubs": 0
},
"bStartDate": null
},
"EntryPages": [],
"IdEntry": 11111,
"EntryName": "abc123def",
"EntryLogo": null,
"EntryTitle": null,
"EntrySubtitle": null,
"EntryComment": null
}
}