Get List of Paypoints for Organization

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[]

Records.IdPaypoint

integer

Paypoint ID.

Example:

"198"

Records.OrgId

integer | null

Organization ID. Unique identifier assigned to an org by Payabli.

Example:

123

Records.OrgParentName

string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

Records.DbaName

string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

Example:

"Sunshine Gutters"

Records.LegalName

string | null

Business legal name.

Example:

"Sunshine Services, LLC"

Records.Ein

string | null

Business EIN or tax ID. This value is masked in API responses, for example XXXX6789.

Example:

"123456789"

Records.Taxfillname

string | null

Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.

Example:

"Sunshine LLC"

Records.Whencharged

enum<string>

Describes when customers are charged for goods or services. Accepted values:

Available options:

When Service Provided,

In Advance

Example:

"When Service Provided"

Records.Whenprovided

enum<string>

Describes when goods or services are provided, from time of transaction.

Available options:

30 Days or Less,

31 to 60 Days,

60+ Days

Example:

"30 Days or Less"

Records.Whendelivered

enum<string>

When goods and services are delivered.

Available options:

0-7 Days,

8-14 Days,

15-30 Days,

Over 30 Days

Example:

"Over 30 Days"

Records.Whenrefund

enum<string>

Describes the business refund policy.

Available options:

Exchange Only,

No Refund or Exchange,

More than 30 days,

30 Days or Less

Example:

"30 Days or Less"

Records.LicenseState

string | null

Business license issuing state or province.

Example:

"CA"

Records.License

string | null

Business license ID or state ID number.

Example:

"2222222FFG"

Records.BAddress1

string | null

Business address.

Example:

"123 Walnut Street"

Records.BAddress2

string | null

Business address additional line.

Example:

"Suite 103"

Records.BCity

string | null

Business city

Example:

"New Vegas"

Records.BZip

string | null

Business ZIP.

Example:

"33000"

Records.BState

string | null

Business state.

Example:

"FL"

Records.BCountry

string | null

Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference

Example:

"US"

Records.WebsiteAddress

string | null

Business website.

Example:

"www.example.com"

Records.BPhone

string | null

Business phone number.

Example:

"5551234567"

Records.BSummary

string | null

A summary of what the business sells in terms of goods or services.

Example:

"Brick and mortar store that sells office supplies"

Records.BFax

string | null

The business's fax number.

Example:

"5551234567"

Records.MAddress1

string | null

The business's mailing address.

Example:

"123 Walnut Street"

Records.MAddress2

string | null

Additional line for the business's mailing address.

Example:

"STE 900"

Records.MCity

string | null

The business's mail city.

Example:

"Johnson City"

Records.MZip

string | null

Business mailing ZIP.

Example:

"37615"

Records.MState

string | null

The business's mailing address state.

Example:

"TN"

Records.MCountry

string | null

Business mailing country.

Example:

"US"

Records.BStartdate

string | null

Business start date.
Accepted formats:

YYYY-MM-DD
MM/DD/YYYY

Example:

"01/01/1990"

Records.OwnType

enum<string> | null

The business ownership type.

Available options:

Limited Liability Company,

Non-Profit Org,

Partnership,

Private Corp,

Public Corp,

Tax Exempt,

Government,

Sole Proprietor

Example:

"Limited Liability Company"

Records.SalesCode

string | null

Records.AverageMonthlyVolume

number | null

Average total amount of transactions in your local currency that are processed each month.

Example:

1000

Records.HighTicketAmount

number | null

High ticket amount.

Example:

1000

Records.AverageTicketAmount

number | null

Average ticket amount.

Example:

1000

Records.Mccid

string

Records.externalPaypointID

string | null

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.

Example:

"Paypoint-100"

Records.BTimeZone

integer | null

default:0

Timezone, in UTC offset. For example, -5 is Eastern time.

Example:

-5

Records.BinPerson

integer | null

Numeric percent of volume processed in person. To pass validation, binperson, binweb, and binphone must total 100 together.

Example:

60

Records.BinPhone

integer | null

Numeric percent of volume processed by phone. To pass validation, binperson, binweb, and binphone must total 100 together.

Example:

20

Records.BinWeb

integer | null

Numeric percent of volume processed on web. To pass validation, binperson, binweb, and binphone must total 100 together.

Example:

20

Records.PaypointStatus

integer

The paypoint's status.

Active - 1

Inactive - 0

Example:

1

Records.TemplateId

integer | null

The associated boarding template's ID in Payabli.

Example:

22

Records.BoardingId

integer

The Payabli-assigned ID of the boarding application linked to this paypoint.

Example:

340

Records.DocumentsRef

string

Records.ContactData

object[] | null

List of contacts.

Records.OwnerData

object[] | null

List of Owners with at least a 25% ownership.

Records.BankData

object[] | null

Information about associated bank accounts.

Object that contains bank account details.

Records.ServiceData

object

Controls which services will be enabled for the merchant.

Records.EntryPoints

object[]

Records.EntryPoints.Paypoint

object

Records.EntryPoints.Paypoint.idPaypoint

integer

Paypoint ID.

Example:

"198"

Records.EntryPoints.Paypoint.dbaName

string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

Example:

"Sunshine Gutters"

Records.EntryPoints.Paypoint.legalName

string | null

Business legal name.

Example:

"Sunshine Services, LLC"

Records.EntryPoints.Paypoint.externalPaypointID

string | null

Example:

"Paypoint-100"

Records.EntryPoints.Paypoint.address1

string | null

The address.

Example:

"123 Ocean Drive"

Records.EntryPoints.Paypoint.address2

string | null

Additional line for the address.

Example:

"Suite 400"

Records.EntryPoints.Paypoint.city

string | null

The city.

Example:

"Bristol"

Records.EntryPoints.Paypoint.zip

string | null

ZIP code for address.

Example:

"31113"

Records.EntryPoints.Paypoint.state

string | null

The state or province.

Example:

"GA"

Records.EntryPoints.Paypoint.country

string | null

The country in ISO-3166-1 alpha 2 format. See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.

Example:

"US"

Records.EntryPoints.Paypoint.websiteAddress

string | null

The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.

Example:

"www.example.com"

Records.EntryPoints.Paypoint.phone

string | null

Phone number.

Example:

"5555555555"

Records.EntryPoints.Paypoint.summary

object

Records.EntryPoints.Paypoint.fax

string | null

Fax number

Example:

"5555555555"

Records.EntryPoints.Paypoint.boardingId

integer

The Payabli-assigned ID of the boarding application linked to this paypoint.

Example:

340

Records.EntryPoints.Paypoint.contacts

object[] | null

List of contacts.

Records.EntryPoints.Paypoint.serviceData

object

Controls which services will be enabled for the merchant.

Records.EntryPoints.Paypoint.bankData

object[] | null

Information about associated bank accounts.

Object that contains bank account details.

Records.EntryPoints.Paypoint.paypointStatus

integer

The paypoint's status.

Active - 1

Inactive - 0

Example:

1

Records.EntryPoints.Paypoint.timeZone

integer | null

default:0

Timezone, in UTC offset. For example, -5 is Eastern time.

Example:

-5

Records.EntryPoints.Paypoint.parentOrg

object

Records.EntryPoints.Paypoint.credentials

object[] | null

Records.EntryPoints.EntryPages

object[] | null

Records.EntryPoints.EntryPages.subdomain

string | null

Page identifier. Must be unique in platform.

Maximum length: 50

Example:

"mypage-1"

Records.EntryPoints.EntryPages.lastAccess

string | null

Timestamp of last access to page structure

Example:

"2022-06-30 15:01:00"

Records.EntryPoints.EntryPages.totalAmount

number | null

Total amount to pay in this page

Records.EntryPoints.EntryPages.pageContent

object

Sections of page

Records.EntryPoints.EntryPages.receiptContent

object

Sections of payment receipt

Records.EntryPoints.EntryPages.pageSettings

object

Settings of page

Records.EntryPoints.EntryPages.AdditionalData

object

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"
  }
}

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

Records.EntryPoints.EntryPages.published

enum<integer>

Flag indicating if page is active to accept payments. 0 for false, 1 for true.

Available options:

0,

1

Records.EntryPoints.EntryPages.credentials

object[] | null

Array of credential objects with active services for the page

Records.EntryPoints.EntryPages.pageIdentifier

string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

Records.EntryPoints.EntryPages.validationCode

string | null

Base64 encoded image of Captcha associated to this page load

Records.EntryPoints.IdEntry

integer

Records.EntryPoints.EntryName

string | null

Records.EntryPoints.EntryLogo

string | null

Records.EntryPoints.EntryTitle

string | null

Records.EntryPoints.EntrySubtitle

string | null

Records.EntryPoints.EntryComment

string | null

Records.CreatedAt

string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

Records.LastModified

string | null

Timestamp of when record was last updated, in UTC.

Example:

"2022-07-01 15:00:01"

Records.summary

object

Records.ExternalProcessorInformation

string | null

Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.

Example:

"[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]"

Was this page helpful?

List Suborganizations List Notifications for Paypoint

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]"
    }
  ]
}

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Get List of Paypoints for Organization

Authorizations

Path Parameters

Query Parameters

Response