GET
/
Query
/
paypoints
/
{orgId}
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:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20

should become:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

orgId
integer
required

The numeric identifier for organization, assigned by Payabli.

Example:

123

Query Parameters

parameters
object

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 => equal
  • gt => greater than
  • ge => greater or equal
  • lt => less than
  • le => less or equal
  • ne => not equal
  • ct => contains
  • nct => not contains
  • in => inside array
  • nin => 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"

limitRecord
integer
default:20

Max number of records to return for the query. Use 0 or negative value to return all records.

Example:

0

fromRecord
integer
default:0

The number of records to skip before starting to collect the result set.

Example:

251

sortBy
string

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.

Example:

"desc(field_name)"

Response

200
application/json
Success
Summary
object
Records
object[]