GET
/
Paypoint
/
{entry}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Paypoint/{entry} \
  --header 'requestToken: <api-key>'
{
  "responseCode": 1,
  "pageIdentifier": null,
  "roomId": 0,
  "isSuccess": true,
  "responseText": "Success",
  "responseData": {
    "Paypoint": {
      "IdPaypoint": 1234,
      "DbaName": "Example Training LLC",
      "LegalName": "Example Training LLC",
      "Address1": "123 Training Road",
      "Address2": "STE 900",
      "City": "Exampletown",
      "Zip": "37615",
      "State": "TN",
      "Country": "US",
      "WebsiteAddress": "https://www.example-training.com",
      "Phone": "(555) 555-1234",
      "Summary": "Training School",
      "Fax": "",
      "externalPaypointID": "",
      "BoardingId": 12345,
      "Contacts": [
        {
          "ContactName": "Jane Smith",
          "ContactEmail": "contact@example-training.com",
          "ContactTitle": "COO",
          "ContactPhone": "(555) 555-5678"
        }
      ],
      "ServiceData": null,
      "BankData": [
        {
          "id": 1111,
          "bankName": "EXAMPLE FEDERAL BANK",
          "routingAccount": "123456789",
          "accountNumber": "0XXXXXX9999",
          "typeAccount": "Checking",
          "bankAccountHolderName": null,
          "bankAccountHolderType": null,
          "bankAccountFunction": 0,
          "verified": false
        },
        {
          "id": 2222,
          "bankName": "EXAMPLE FEDERAL BANK",
          "routingAccount": "123456789",
          "accountNumber": "0XXXXXX9999",
          "typeAccount": "Checking",
          "bankAccountHolderName": null,
          "bankAccountHolderType": null,
          "bankAccountFunction": 1,
          "verified": false
        }
      ],
      "PaypointStatus": 1,
      "TimeZone": 0,
      "ParentOrg": {
        "IdOrg": 123,
        "OrgName": "Example Organization",
        "OrgType": 0,
        "OrgStatus": 1,
        "OrgLogo": null,
        "OrgAddress": null
      },
      "Credentials": [
        {
          "Service": "ach",
          "Mode": 0,
          "Minticket": 0,
          "Maxticket": 20000,
          "CfeeFix": 0,
          "CfeeFloat": 0,
          "CfeeMin": 0,
          "CfeeMax": 0,
          "ReferenceId": 1111,
          "AccountId": "EX_123456789"
        },
        {
          "Service": "ach",
          "Mode": 1,
          "Minticket": 0,
          "Maxticket": 20000,
          "CfeeFix": 0,
          "CfeeFloat": 0,
          "CfeeMin": 0,
          "CfeeMax": 0,
          "ReferenceId": 1111,
          "AccountId": "EX_123456789"
        },
        {
          "Service": "card",
          "Mode": 0,
          "Minticket": 0,
          "Maxticket": 20000,
          "CfeeFix": 0,
          "CfeeFloat": 3,
          "CfeeMin": 0,
          "CfeeMax": 0,
          "ReferenceId": 2222,
          "AccountId": "EX_987654321"
        }
      ],
      "SuspendedTransfer": 0,
      "summary": {
        "customers": 1,
        "countTx": 0,
        "amountTx": 0,
        "countSubs": 0,
        "amountSubs": 0
      },
      "bStartDate": null
    },
    "EntryPages": [],
    "IdEntry": 11111,
    "EntryName": "abc123def",
    "EntryLogo": null,
    "EntryTitle": null,
    "EntrySubtitle": null,
    "EntryComment": null
  }
}

Authorizations

​
requestToken
string
header
required

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

Path Parameters

​
entry
string
required

The paypoint's entrypoint identifier. Learn more

Example:

"8cfec329267"

Query Parameters

​
entrypages
string

Response

200 - application/json

Success

The response is of type object.