Get basic paypoint details by ID

GET

/Paypoint/basicById/:IdPaypoint

GET

/api/Paypoint/basicById/:IdPaypoint

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

Try it

200Example Paypoint Entry response

1 {
2   "isSuccess": true,
3   "responseCode": 1,
4   "responseData": {
5     "EntryName": "abc123def",
6     "EntryPages": [
7       {
8         "AdditionalData": {
9           "key1": {
10             "key": "value"
11           },
12           "key2": {
13             "key": "value"
14           },
15           "key3": {
16             "key": "value"
17           }
18         }
19       }
20     ],
21     "IdEntry": 11111,
22     "Paypoint": {
23       "address1": "123 Ocean Drive",
24       "address2": "Suite 400",
25       "bankData": [
26         {
27           "bankAccountFunction": 0,
28           "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
29           "nickname": "Business Checking 1234"
30         }
31       ],
32       "boardingId": 340,
33       "city": "Bristol",
34       "contacts": [
35         {}
36       ],
37       "country": "US",
38       "credentials": [
39         {}
40       ],
41       "dbaName": "Sunshine Gutters",
42       "externalPaypointID": "",
43       "fax": "5555555555",
44       "idPaypoint": 1000000,
45       "legalName": "Sunshine Services, LLC",
46       "parentOrg": {
47         "orgName": "Pilgrim Planner",
48         "orgStatus": 1,
49         "orgType": 0
50       },
51       "paypointStatus": 1,
52       "phone": "5555555555",
53       "state": "GA",
54       "summary": {
55         "amountSubs": 0,
56         "amountTx": 0,
57         "countSubs": 0,
58         "countTx": 0,
59         "customers": 1
60       },
61       "timeZone": -5,
62       "websiteAddress": "www.example.com",
63       "zip": "31113"
64     }
65   },
66   "responseText": "Success"
67 }

Retrieves the basic details for a paypoint by ID.

Path parameters

IdPaypointstringRequired

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

Response

Success

isSuccessbooleanOptional

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

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

responseCodeintegerOptional

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

responseDataobjectOptional

responseTextstringOptional

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

Get basic paypoint details by ID

Path parameters

Headers

Response

Errors