Get basic paypoint details

1 import { PayabliClient } from "@payabli/sdk-node"; 2 3 const client = new PayabliClient({ apiKey: "YOUR_API_KEY" }); 4 await client.paypoint.getBasicEntry("8cfec329267");

1 { 2 "isSuccess": true, 3 "responseText": "Success", 4 "responseCode": 1, 5 "responseData": { 6 "EntryName": "abc123def", 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 }

Gets the basic details for a paypoint.

Authentication

requestTokenstring

API Key authentication via header

Path Parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

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’.

pageIdentifierstring or null

Auxiliary validation used internally by payment pages and components.

responseCodeinteger or null

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

responseDataobject or null

Authentication

Path Parameters

Response

Errors