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
- GETList Transactions for Paypoint
- GETList Transactions for Org
- GETList Batches for Paypoint
- GETList Batches for Org
- GETList Batch Details for Paypoint
- GETList Batch Details for Org
- GETList MoneyOut Batches for Paypoint
- GETList MoneyOut Batches for Org
- GETList Subscriptions for Paypoint
- GETList Subscriptions for Org
- GETList Settled Transactions for Paypoint
- GETList Settled Transactions for Org
- GETGet Transfer Details
- GETList Transfers for Paypoint
- GETList Chargebacks for Paypoint
- GETList Chargebacks for Org
- GETList Customers for Paypoint
- GETList Customers for Org
- GETList Users for Paypoint
- GETList Users for Org
- GETList Suborganizations
- GETList Paypoints for Org
- GETList Notifications for Paypoint
- GETList Notifications for Org
- GETList Reports for Paypoint
- GETList Reports for Org
- GETList Vendors for Paypoint
- GETList Vendors for Org
- GETList vCards for Paypoint
- GETList vCards for Org
- GETList MoneyOut Transactions for Paypoint
- GETList MoneyOut Transactions for Org
- GETList Items for Paypoint
- GETList Invoices for Paypoint
- GETList Invoices for Org
- GETList Bills for Paypoint
- GETList Bills for Org
- GET
- Statistic
- Export
- Import
Object Models
- Object Model References
Get List of Paypoints for Organization
Returns a list of paypoints in an organization. Use filters to limit results.
You must remove parameters= from the request before you send it, otherwise Payabli will ignore the filters.
Because of a technical limitation, you can’t make a request that includes filters from the API console on this page. The response won’t be filtered. Instead, copy the request, remove parameters= and run the request in a different client.
For example:
should become:
—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
The numeric identifier for organization, assigned by Payabli.
Query Parameters
Collection of field names, conditions, and values used to filter the query
List of field names accepted:
createdAt(gt, ge, lt, le, eq, ne)lastModified(gt, ge, lt, le, eq, ne)startDate(gt, ge, lt, le, eq, ne)dbaname(ct, nct)status(eq, ne)legalname(ct, nct)externalPaypointID(ct, nct)ein(ct, nct)address(ct, nct)city(ct, nct)state(ct, nct)phone(ct, nct)mcc(ct, nct)owntype(ct, nct)ownerName(ct, nct)contactName(ct, nct)paypointId(eq, ne)orgParentname(ct, nct, in, nin)boardingId(eq, ne)entryName(ct, nct)externalOrgID(ct, nct)
List of comparison accepted - enclosed between parentheses:
eqor empty => equalgt=> greater thange=> greater or equallt=> less thanle=> less or equalne=> not equalct=> containsnct=> not containsin=> inside arraynin=> not inside array
List of parameters accepted:
limitRecord: max number of records for query (default="20", "0" or negative value for all)fromRecord: initial record in query
Example: dbaname(ct)=hoa return all records with dbname containing "hoa"
Max number of records to return for the query. Use 0 or negative value to return all records.
The number of records to skip before starting to collect the result set.
The field name to use for sorting results. Use desc(field_name) to sort descending by field_name, and use asc(field_name) to sort ascending by field_name.
Response
Average total amount of transactions in your local currency that are processed each month.
Average ticket amount.
Business address.
Business address additional line.
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 Business city
Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
The business's fax number.
Numeric percent of volume processed in person. To pass validation, binperson, binweb, and binphone must total 100 together.
Numeric percent of volume processed by phone. To pass validation, binperson, binweb, and binphone must total 100 together.
Numeric percent of volume processed on web. To pass validation, binperson, binweb, and binphone must total 100 together.
The Payabli-assigned ID of the boarding application linked to this paypoint.
Business phone number.
Business start date.
Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
Business state.
A summary of what the business sells in terms of goods or services.
Timezone, in UTC offset. For example, -5 is Eastern time.
Business ZIP.
Timestamp of when record was created, in UTC.
The alternate or common name that this business is doing business under usually referred to as a DBA name.
Business EIN or tax ID.
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
Autopay section of payment page
ContactUs section of payment page
Identifier of entry point owner of page
Invoices section of payment page
Logo section of payment page
Message section of payment page
Descriptor of page
Notes section of payment page
Page header section of payment page
Payment button section of payment page
Payment methods section of payment page
Customer/Payor section of payment page
Review 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
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 amount of payment receipt
Section contactUs of payment receipt
Section payment details of payment receipt
Section logo of payment receipt
Section message of payment receipt
Section page of payment receipt
Section payment button of payment receipt
Section payment information of payment receipt
The receipt's settings.
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.
Contact email address.
Contact name.
Contact phone number.
Contact title.
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.
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.
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.
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.
Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.
High ticket amount.
Paypoint ID.
Timestamp of when record was last updated, in UTC.
Business legal name.
Business license ID or state ID number.
Business license issuing state or province.
The business's mailing address.
Additional line for the business's mailing address.
The business's mail city.
Business mailing country.
The business's mailing address state.
Business mailing ZIP.
Organization ID. Unique identifier assigned to an org by Payabli.
The name of the parent organization.
List of Owners with at least a 25% ownership.
Owner street address.
Owner address city.
Owner address country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
Owner driver's license State. Payabli strongly recommends including this.
Owner address state.
Owner's date of birth.
Owner driver's License. Payabli strongly recommends including this.
Owner email.
Person who is registered as the beneficial owner of the business. This is a combination of first and last name.
Percentage of ownership the person holds, in integer format.
Owner phone 1.
Owner phone 2.
The relevant identifier for the person such as a Social Security Number.
The job title of the person such as CEO or director.
Owner address ZIP.
The business ownership type.
Limited Liability Company, Non-Profit Org, Partnership, Private Corp, Public Corp, Tax Exempt, Government, Sole Proprietor The paypoint's status.
Active - 1
Inactive - 0
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.
Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.
The associated boarding template's ID in Payabli.
Business website.
Describes when customers are charged for goods or services. Accepted values:
When Service Provided, In Advance When goods and services are delivered.
0-7 Days, 8-14 Days, 15-30 Days, Over 30 Days Describes when goods or services are provided, from time of transaction.
30 Days or Less, 31 to 60 Days, 60+ Days Describes the business refund policy.
Exchange Only, No Refund or Exchange, More than 30 days, 30 Days or Less Auxiliary validation used internally by payment pages and components.
Number of records on each response page.
Total amount for the records.
Total net amount for the records.
Total number of records in response.
Total number of records in response.
Was this page helpful?