Get basic paypoint details by ID

GET

/Paypoint/basicById/:IdPaypoint

GET

/api/Paypoint/basicById/:IdPaypoint

$ curl https://api-sandbox.payabli.com/api/Paypoint/basicById/198 \
>      -H "Authorization: Bearer <token>"

1 {
2   "isSuccess": true,
3   "responseText": "Success",
4   "responseCode": 1,
5   "responseData": {
6     "EntryName": "8cfec329267",
7     "EntryPages": [
8       {
9         "AdditionalData": {
10           "key1": {
11             "key": "value"
12           },
13           "key2": {
14             "key": "value"
15           },
16           "key3": {
17             "key": "value"
18           }
19         }
20       }
21     ],
22     "IdEntry": 11111,
23     "Paypoint": {
24       "Address1": "123 Ocean Drive",
25       "Address2": "Suite 400",
26       "BankData": [
27         {
28           "nickname": "Business Checking 1234",
29           "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
30           "bankAccountFunction": 0
31         }
32       ],
33       "BoardingId": 340,
34       "City": "Bristol",
35       "Contacts": [
36         {}
37       ],
38       "Country": "US",
39       "Credentials": [
40         {}
41       ],
42       "DbaName": "Sunshine Gutters",
43       "externalPaypointID": "",
44       "Fax": "5555555555",
45       "IdPaypoint": 1000000,
46       "LegalName": "Sunshine Services, LLC",
47       "ParentOrg": {
48         "orgName": "Pilgrim Planner",
49         "orgStatus": 1,
50         "orgType": 0
51       },
52       "PaypointStatus": 1,
53       "Phone": "5555555555",
54       "State": "GA",
55       "summary": {
56         "amountSubs": 0,
57         "amountTx": 0,
58         "countSubs": 0,
59         "countTx": 0,
60         "customers": 1
61       },
62       "TimeZone": -5,
63       "WebsiteAddress": "www.example.com",
64       "Zip": "31113"
65     }
66   }
67 }

Retrieves the basic details for a paypoint by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

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.

responseTextstring

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

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

responseCodeintegerOptional

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

responseDataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error