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.
curl --request GET \
--url https://api-sandbox.payabli.com/api/Query/paypoints/{orgId} \
--header 'requestToken: <api-key>'
{
"Summary": {
"totalRecords": 2,
"totalAmount": 77.22,
"totalNetAmount": 77.22,
"totalPages": 2,
"pageSize": 20,
"pageIdentifier": "null"
},
"Records": [
{
"IdPaypoint": "198",
"OrgId": 123,
"OrgParentName": "PropertyManager Pro",
"DbaName": "Sunshine Gutters",
"LegalName": "Sunshine Services, LLC",
"Ein": "123456789",
"Taxfillname": "Sunshine LLC",
"Whencharged": "When Service Provided",
"Whenprovided": "30 Days or Less",
"Whendelivered": "Over 30 Days",
"Whenrefund": "30 Days or Less",
"LicenseState": "CA",
"License": "2222222FFG",
"BAddress1": "123 Walnut Street",
"BAddress2": "Suite 103",
"BCity": "New Vegas",
"BZip": "33000",
"BState": "FL",
"BCountry": "US",
"WebsiteAddress": "www.example.com",
"BPhone": "5551234567",
"BSummary": "Brick and mortar store that sells office supplies",
"BFax": "5551234567",
"MAddress1": "123 Walnut Street",
"MAddress2": "STE 900",
"MCity": "Johnson City",
"MZip": "37615",
"MState": "TN",
"MCountry": "US",
"BStartdate": "01/01/1990",
"OwnType": "Limited Liability Company",
"SalesCode": "<string>",
"AverageMonthlyVolume": 1000,
"HighTicketAmount": 1000,
"AverageTicketAmount": 1000,
"Mccid": "<string>",
"externalPaypointID": "Paypoint-100",
"BTimeZone": -5,
"BinPerson": 60,
"BinPhone": 20,
"BinWeb": 20,
"PaypointStatus": 1,
"TemplateId": 22,
"BoardingId": 340,
"DocumentsRef": "<string>",
"ContactData": [
{
"contactName": "Herman Martinez",
"contactEmail": "example@email.com",
"contactTitle": "Owner",
"contactPhone": "3055550000"
}
],
"OwnerData": [
{
"ownername": "John Smith",
"ownertitle": "CEO",
"ownerpercent": 25,
"ownerssn": "123456789",
"ownerdob": "01/01/1990",
"ownerphone1": "555888111",
"ownerphone2": "555888111",
"owneremail": "example@email.com",
"ownerdriver": "CA6677778",
"odriverstate": "CA",
"oaddress": "33 North St",
"ostate": "CA",
"ocountry": "US",
"ocity": "Any City",
"ozip": "55555"
}
],
"BankData": [
{
"id": 123,
"bankName": "Country Bank",
"routingAccount": "123123123",
"accountNumber": "1XXXXXX3123",
"typeAccount": "Checking",
"bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
"bankAccountHolderType": "Business",
"bankAccountFunction": 0
}
],
"ServiceData": {
"card": {
"acceptVisa": true,
"acceptMastercard": true,
"acceptDiscover": false,
"acceptAmex": true
},
"ach": {
"acceptWeb": true,
"acceptPPD": false,
"acceptCCD": false
}
},
"EntryPoints": [
{
"Paypoint": {
"idPaypoint": "198",
"dbaName": "Sunshine Gutters",
"legalName": "Sunshine Services, LLC",
"externalPaypointID": "Paypoint-100",
"address1": "123 Ocean Drive",
"address2": "Suite 400",
"city": "Bristol",
"zip": "31113",
"state": "GA",
"country": "US",
"websiteAddress": "www.example.com",
"phone": "5555555555",
"summary": {
"customers": 123,
"countTx": 123,
"amountTx": 123,
"countSubs": 123,
"amountSubs": 123
},
"fax": "5555555555",
"boardingId": 340,
"contacts": [
{
"contactName": "Herman Martinez",
"contactEmail": "example@email.com",
"contactTitle": "Owner",
"contactPhone": "3055550000"
}
],
"serviceData": {
"card": {
"acceptVisa": true,
"acceptMastercard": true,
"acceptDiscover": false,
"acceptAmex": true
},
"ach": {
"acceptWeb": true,
"acceptPPD": false,
"acceptCCD": false
}
},
"bankData": [
{
"id": 123,
"bankName": "Country Bank",
"routingAccount": "123123123",
"accountNumber": "1XXXXXX3123",
"typeAccount": "Checking",
"bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
"bankAccountHolderType": "Business",
"bankAccountFunction": 0
}
],
"paypointStatus": 1,
"timeZone": -5,
"parentOrg": {
"idOrg": 123,
"orgName": "Pilgrim Planner",
"orgType": 0,
"orgStatus": 1,
"orgLogo": {
"ftype": "pdf",
"filename": "my-doc.pdf",
"furl": "https://mysite.com/my-doc.pdf",
"fContent": "TXkgdGVzdCBmaWxlHJ==..."
},
"orgAddress": "123 Walnut Street"
},
"credentials": [
{
"service": "<string>",
"mode": 123,
"minticket": 123,
"maxticket": 123,
"cfeeFix": 123,
"cfeeFloat": 123,
"cfeeMin": 123,
"cfeeMax": 123,
"accountId": "<string>",
"referenceId": 123
}
]
},
"EntryPages": [
{
"subdomain": "mypage-1",
"lastAccess": "2022-06-30 15:01:00",
"totalAmount": 123,
"pageContent": {
"name": "<string>",
"entry": "<string>",
"subdomain": "mypage-1",
"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
},
"autopay": {
"enabled": true,
"order": 1,
"header": "<string>",
"finish": {
"untilCancelled": true,
"calendar": true
},
"frequency": {
"one-time": true,
"weekly": true,
"every2Weeks": true,
"every6Months": true,
"monthly": true,
"every3Months": true,
"annually": true
},
"startDate": "1, 5-10",
"frequencySelected": "<string>"
},
"amount": {
"enabled": true,
"order": 1,
"categories": [
{
"name": "<string>",
"type": "<string>",
"label": "<string>",
"value": "<string>",
"description": "<string>",
"order": 1,
"quantity": 123,
"showDescription": true,
"optionalPay": true
}
]
}
},
"receiptContent": {
"logo": {
"enabled": true,
"order": 1
},
"page": {
"enabled": true,
"order": 1,
"header": "<string>",
"description": "<string>"
},
"amount": {
"enabled": true,
"order": 1
},
"details": {
"enabled": true,
"order": 1
},
"paymentInformation": {
"enabled": true,
"order": 1
},
"messageBeforeButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"paymentButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"contactUs": {
"enabled": true,
"order": 1
},
"settings": {
"enabled": true,
"order": 1,
"sendAuto": true,
"sendManual": false,
"fields": [
{
"name": "<string>",
"display": true,
"Fixed": true
}
]
}
},
"pageSettings": {
"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==..."
},
"paymentButton": {
"label": "<string>",
"size": "sm"
}
},
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"published": 0,
"credentials": [
{
"service": "<string>",
"mode": 123,
"minticket": 123,
"maxticket": 123,
"cfeeFix": 123,
"cfeeFloat": 123,
"cfeeMin": 123,
"cfeeMax": 123,
"accountId": "<string>",
"referenceId": 123
}
],
"pageIdentifier": "null",
"validationCode": "<string>"
}
],
"IdEntry": 123,
"EntryName": "<string>",
"EntryLogo": "<string>",
"EntryTitle": "<string>",
"EntrySubtitle": "<string>",
"EntryComment": "<string>"
}
],
"CreatedAt": "2022-07-01 15:00:01",
"LastModified": "2022-07-01 15:00:01",
"summary": {
"customers": 123,
"countTx": 123,
"amountTx": 123,
"countSubs": 123,
"amountSubs": 123
},
"ExternalProcessorInformation": "[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]"
}
]
}
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.
123
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:
eq
or 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.
0
The number of records to skip before starting to collect the result set.
251
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
.
"desc(field_name)"
Response
Total number of records in response.
2
Total amount for the records.
77.22
Total net amount for the records.
77.22
Total number of records in response.
2
Number of records on each response page.
20
Auxiliary validation used internally by payment pages and components.
null
Paypoint ID.
"198"
Organization ID. Unique identifier assigned to an org by Payabli.
123
The name of the parent organization.
"PropertyManager Pro"
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"
Business EIN or tax ID. This value is masked in API responses, for example XXXX6789
.
"123456789"
Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.
"Sunshine LLC"
Describes when customers are charged for goods or services. Accepted values:
When Service Provided
, In Advance
"When Service Provided"
Describes when goods or services are provided, from time of transaction.
30 Days or Less
, 31 to 60 Days
, 60+ Days
"30 Days or Less"
When goods and services are delivered.
0-7 Days
, 8-14 Days
, 15-30 Days
, Over 30 Days
"Over 30 Days"
Describes the business refund policy.
Exchange Only
, No Refund or Exchange
, More than 30 days
, 30 Days or Less
"30 Days or Less"
Business license issuing state or province.
"CA"
Business license ID or state ID number.
"2222222FFG"
Business address.
"123 Walnut Street"
Business address additional line.
"Suite 103"
Business city
"New Vegas"
Business ZIP.
"33000"
Business state.
"FL"
Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
"US"
Business website.
"www.example.com"
Business phone number.
"5551234567"
A summary of what the business sells in terms of goods or services.
"Brick and mortar store that sells office supplies"
The business's fax number.
"5551234567"
The business's mailing address.
"123 Walnut Street"
Additional line for the business's mailing address.
"STE 900"
The business's mail city.
"Johnson City"
Business mailing ZIP.
"37615"
The business's mailing address state.
"TN"
Business mailing country.
"US"
Business start date.
Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
"01/01/1990"
The business ownership type.
Limited Liability Company
, Non-Profit Org
, Partnership
, Private Corp
, Public Corp
, Tax Exempt
, Government
, Sole Proprietor
"Limited Liability Company"
Average total amount of transactions in your local currency that are processed each month.
1000
High ticket amount.
1000
Average ticket amount.
1000
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"
Timezone, in UTC offset. For example, -5 is Eastern time.
-5
Numeric percent of volume processed in person. To pass validation, binperson
, binweb
, and binphone
must total 100 together.
60
Numeric percent of volume processed by phone. To pass validation, binperson
, binweb
, and binphone
must total 100 together.
20
Numeric percent of volume processed on web. To pass validation, binperson
, binweb
, and binphone
must total 100 together.
20
The paypoint's status.
Active - 1
Inactive - 0
1
The associated boarding template's ID in Payabli.
22
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"
List of Owners with at least a 25% ownership.
Person who is registered as the beneficial owner of the business. This is a combination of first and last name.
"John Smith"
The job title of the person such as CEO or director.
"CEO"
Percentage of ownership the person holds, in integer format.
25
The relevant identifier for the person such as a Social Security Number.
"123456789"
Owner's date of birth.
"01/01/1990"
Owner phone 1.
"555888111"
Owner phone 2.
"555888111"
Owner email.
320
"example@email.com"
Owner driver's License. Payabli strongly recommends including this.
"CA6677778"
Owner driver's license State. Payabli strongly recommends including this.
"CA"
Owner street address.
"33 North St"
Owner address state.
"CA"
Owner address country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
"US"
Owner address city.
"Any City"
Owner address ZIP.
"55555"
Information about associated bank accounts.
Object that contains bank account details.
The bank's ID in Payabli.
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"
Describes whether the bank account is used for deposits or withdrawals in Payabli:
0
: Deposit1
: Withdrawal2
: Deposit and withdrawal
0
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
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"
Information about associated bank accounts.
Object that contains bank account details.
The bank's ID in Payabli.
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"
Describes whether the bank account is used for deposits or withdrawals in Payabli:
0
: Deposit1
: Withdrawal2
: Deposit and withdrawal
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 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"
Logo section of payment page
Page header section of payment page
Invoices section of payment page
Customer/Payor section of payment page
Payment methods section of payment page
Notes section of payment page
Message section of payment page
Payment button section of payment page
Review section of payment page
ContactUs section of payment page
Autopay section of payment page
Amount section of payment page
Sections of payment receipt
Section logo of payment receipt
Section page of payment receipt
Section amount of payment receipt
Section payment details of payment receipt
Section payment information of payment receipt
Section message of payment receipt
Section payment button of payment receipt
Section contactUs of payment receipt
The receipt's settings.
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
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
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
Timestamp of when record was last updated, in UTC.
"2022-07-01 15:00:01"
Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.
"[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]"
Was this page helpful?
curl --request GET \
--url https://api-sandbox.payabli.com/api/Query/paypoints/{orgId} \
--header 'requestToken: <api-key>'
{
"Summary": {
"totalRecords": 2,
"totalAmount": 77.22,
"totalNetAmount": 77.22,
"totalPages": 2,
"pageSize": 20,
"pageIdentifier": "null"
},
"Records": [
{
"IdPaypoint": "198",
"OrgId": 123,
"OrgParentName": "PropertyManager Pro",
"DbaName": "Sunshine Gutters",
"LegalName": "Sunshine Services, LLC",
"Ein": "123456789",
"Taxfillname": "Sunshine LLC",
"Whencharged": "When Service Provided",
"Whenprovided": "30 Days or Less",
"Whendelivered": "Over 30 Days",
"Whenrefund": "30 Days or Less",
"LicenseState": "CA",
"License": "2222222FFG",
"BAddress1": "123 Walnut Street",
"BAddress2": "Suite 103",
"BCity": "New Vegas",
"BZip": "33000",
"BState": "FL",
"BCountry": "US",
"WebsiteAddress": "www.example.com",
"BPhone": "5551234567",
"BSummary": "Brick and mortar store that sells office supplies",
"BFax": "5551234567",
"MAddress1": "123 Walnut Street",
"MAddress2": "STE 900",
"MCity": "Johnson City",
"MZip": "37615",
"MState": "TN",
"MCountry": "US",
"BStartdate": "01/01/1990",
"OwnType": "Limited Liability Company",
"SalesCode": "<string>",
"AverageMonthlyVolume": 1000,
"HighTicketAmount": 1000,
"AverageTicketAmount": 1000,
"Mccid": "<string>",
"externalPaypointID": "Paypoint-100",
"BTimeZone": -5,
"BinPerson": 60,
"BinPhone": 20,
"BinWeb": 20,
"PaypointStatus": 1,
"TemplateId": 22,
"BoardingId": 340,
"DocumentsRef": "<string>",
"ContactData": [
{
"contactName": "Herman Martinez",
"contactEmail": "example@email.com",
"contactTitle": "Owner",
"contactPhone": "3055550000"
}
],
"OwnerData": [
{
"ownername": "John Smith",
"ownertitle": "CEO",
"ownerpercent": 25,
"ownerssn": "123456789",
"ownerdob": "01/01/1990",
"ownerphone1": "555888111",
"ownerphone2": "555888111",
"owneremail": "example@email.com",
"ownerdriver": "CA6677778",
"odriverstate": "CA",
"oaddress": "33 North St",
"ostate": "CA",
"ocountry": "US",
"ocity": "Any City",
"ozip": "55555"
}
],
"BankData": [
{
"id": 123,
"bankName": "Country Bank",
"routingAccount": "123123123",
"accountNumber": "1XXXXXX3123",
"typeAccount": "Checking",
"bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
"bankAccountHolderType": "Business",
"bankAccountFunction": 0
}
],
"ServiceData": {
"card": {
"acceptVisa": true,
"acceptMastercard": true,
"acceptDiscover": false,
"acceptAmex": true
},
"ach": {
"acceptWeb": true,
"acceptPPD": false,
"acceptCCD": false
}
},
"EntryPoints": [
{
"Paypoint": {
"idPaypoint": "198",
"dbaName": "Sunshine Gutters",
"legalName": "Sunshine Services, LLC",
"externalPaypointID": "Paypoint-100",
"address1": "123 Ocean Drive",
"address2": "Suite 400",
"city": "Bristol",
"zip": "31113",
"state": "GA",
"country": "US",
"websiteAddress": "www.example.com",
"phone": "5555555555",
"summary": {
"customers": 123,
"countTx": 123,
"amountTx": 123,
"countSubs": 123,
"amountSubs": 123
},
"fax": "5555555555",
"boardingId": 340,
"contacts": [
{
"contactName": "Herman Martinez",
"contactEmail": "example@email.com",
"contactTitle": "Owner",
"contactPhone": "3055550000"
}
],
"serviceData": {
"card": {
"acceptVisa": true,
"acceptMastercard": true,
"acceptDiscover": false,
"acceptAmex": true
},
"ach": {
"acceptWeb": true,
"acceptPPD": false,
"acceptCCD": false
}
},
"bankData": [
{
"id": 123,
"bankName": "Country Bank",
"routingAccount": "123123123",
"accountNumber": "1XXXXXX3123",
"typeAccount": "Checking",
"bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
"bankAccountHolderType": "Business",
"bankAccountFunction": 0
}
],
"paypointStatus": 1,
"timeZone": -5,
"parentOrg": {
"idOrg": 123,
"orgName": "Pilgrim Planner",
"orgType": 0,
"orgStatus": 1,
"orgLogo": {
"ftype": "pdf",
"filename": "my-doc.pdf",
"furl": "https://mysite.com/my-doc.pdf",
"fContent": "TXkgdGVzdCBmaWxlHJ==..."
},
"orgAddress": "123 Walnut Street"
},
"credentials": [
{
"service": "<string>",
"mode": 123,
"minticket": 123,
"maxticket": 123,
"cfeeFix": 123,
"cfeeFloat": 123,
"cfeeMin": 123,
"cfeeMax": 123,
"accountId": "<string>",
"referenceId": 123
}
]
},
"EntryPages": [
{
"subdomain": "mypage-1",
"lastAccess": "2022-06-30 15:01:00",
"totalAmount": 123,
"pageContent": {
"name": "<string>",
"entry": "<string>",
"subdomain": "mypage-1",
"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
},
"autopay": {
"enabled": true,
"order": 1,
"header": "<string>",
"finish": {
"untilCancelled": true,
"calendar": true
},
"frequency": {
"one-time": true,
"weekly": true,
"every2Weeks": true,
"every6Months": true,
"monthly": true,
"every3Months": true,
"annually": true
},
"startDate": "1, 5-10",
"frequencySelected": "<string>"
},
"amount": {
"enabled": true,
"order": 1,
"categories": [
{
"name": "<string>",
"type": "<string>",
"label": "<string>",
"value": "<string>",
"description": "<string>",
"order": 1,
"quantity": 123,
"showDescription": true,
"optionalPay": true
}
]
}
},
"receiptContent": {
"logo": {
"enabled": true,
"order": 1
},
"page": {
"enabled": true,
"order": 1,
"header": "<string>",
"description": "<string>"
},
"amount": {
"enabled": true,
"order": 1
},
"details": {
"enabled": true,
"order": 1
},
"paymentInformation": {
"enabled": true,
"order": 1
},
"messageBeforeButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"paymentButton": {
"enabled": true,
"order": 1,
"label": "<string>"
},
"contactUs": {
"enabled": true,
"order": 1
},
"settings": {
"enabled": true,
"order": 1,
"sendAuto": true,
"sendManual": false,
"fields": [
{
"name": "<string>",
"display": true,
"Fixed": true
}
]
}
},
"pageSettings": {
"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==..."
},
"paymentButton": {
"label": "<string>",
"size": "sm"
}
},
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"published": 0,
"credentials": [
{
"service": "<string>",
"mode": 123,
"minticket": 123,
"maxticket": 123,
"cfeeFix": 123,
"cfeeFloat": 123,
"cfeeMin": 123,
"cfeeMax": 123,
"accountId": "<string>",
"referenceId": 123
}
],
"pageIdentifier": "null",
"validationCode": "<string>"
}
],
"IdEntry": 123,
"EntryName": "<string>",
"EntryLogo": "<string>",
"EntryTitle": "<string>",
"EntrySubtitle": "<string>",
"EntryComment": "<string>"
}
],
"CreatedAt": "2022-07-01 15:00:01",
"LastModified": "2022-07-01 15:00:01",
"summary": {
"customers": 123,
"countTx": 123,
"amountTx": 123,
"countSubs": 123,
"amountSubs": 123
},
"ExternalProcessorInformation": "[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]"
}
]
}