Get basic paypoint details by ID

curl https://api-sandbox.payabli.com/api/Paypoint/basicById/198 \
     -H "requestToken: <apiKey>"

{
  "isSuccess": true,
  "responseCode": 1,
  "responseData": {
    "EntryName": "abc123def",
    "EntryPages": [
      {
        "AdditionalData": {
          "key1": {
            "key": "value"
          },
          "key2": {
            "key": "value"
          },
          "key3": {
            "key": "value"
          }
        }
      }
    ],
    "IdEntry": 11111,
    "Paypoint": {
      "address1": "123 Ocean Drive",
      "address2": "Suite 400",
      "bankData": [
        {
          "bankAccountFunction": 0,
          "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
          "nickname": "Business Checking 1234"
        }
      ],
      "boardingId": 340,
      "city": "Bristol",
      "contacts": [
        {}
      ],
      "country": "US",
      "credentials": [
        {}
      ],
      "dbaName": "Sunshine Gutters",
      "externalPaypointID": "",
      "fax": "5555555555",
      "idPaypoint": 1000000,
      "legalName": "Sunshine Services, LLC",
      "parentOrg": {
        "orgName": "Pilgrim Planner",
        "orgStatus": 1,
        "orgType": 0
      },
      "paypointStatus": 1,
      "phone": "5555555555",
      "state": "GA",
      "summary": {
        "amountSubs": 0,
        "amountTx": 0,
        "countSubs": 0,
        "countTx": 0,
        "customers": 1
      },
      "timeZone": -5,
      "websiteAddress": "www.example.com",
      "zip": "31113"
    }
  },
  "responseText": "Success"
}

Retrieves the basic details for a paypoint by ID.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

IdPaypointstringRequired

Paypoint ID. You can find this value by querying /api/Query/paypoints/{orgId}

Response

Success

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

responseCodeinteger

Code for the response. Learn more in API Response Codes.

responseDataobject

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error