Get payout subscription

GET

/PayoutSubscription/:id

GET

/api/PayoutSubscription/:id

$ curl https://api-sandbox.payabli.com/api/PayoutSubscription/42 \
>      -H "requestToken: <apiKey>"

1 {
2   "responseText": "Success",
3   "isSuccess": true,
4   "responseData": {
5     "startDate": "2025-09-01T00:00:00Z",
6     "endDate": "2026-09-01T00:00:00Z",
7     "nextDate": "2025-10-01T00:00:00Z",
8     "lastRun": "2025-09-01T06:00:00Z",
9     "idOutSubscription": 42,
10     "status": 1,
11     "events": [
12       {
13         "description": "TransferCreated",
14         "eventTime": "2025-09-01T06:00:00Z",
15         "extraData": null,
16         "refData": "refData",
17         "source": "api"
18       }
19     ],
20     "vendor": {
21       "VendorNumber": "VEN-123",
22       "Name1": "Herman's Coatings",
23       "Name2": "Herman's Coating Supply Company, LLC",
24       "EIN": "123456789",
25       "Phone": "2125551234",
26       "Email": "example@email.com",
27       "RemitEmail": null,
28       "Address1": "123 Ocean Drive",
29       "Address2": "Suite 400",
30       "City": "Bristol",
31       "State": "GA",
32       "Zip": "31113",
33       "Country": "US",
34       "Mcc": "7777",
35       "LocationCode": "LOC123",
36       "Contacts": [
37         {
38           "ContactName": "Eric Martinez",
39           "ContactEmail": "eric@martinezcoatings.com",
40           "ContactTitle": "Owner",
41           "ContactPhone": "5555555555"
42         }
43       ],
44       "BillingData": {
45         "id": 123456,
46         "nickname": "Main Checking Account",
47         "bankName": "Example Bank",
48         "routingAccount": "123456789",
49         "accountNumber": "9876543210",
50         "typeAccount": "Checking",
51         "bankAccountHolderName": "John Doe",
52         "bankAccountHolderType": "Business",
53         "bankAccountFunction": 2,
54         "verified": true,
55         "status": 1,
56         "services": [],
57         "default": true,
58         "accountId": "bank-account-001"
59       },
60       "PaymentMethod": null,
61       "VendorStatus": 1,
62       "VendorId": 456,
63       "EnrollmentStatus": null,
64       "Summary": {
65         "ActiveBills": 2,
66         "PendingBills": 4,
67         "InTransitBills": 3,
68         "PaidBills": 18,
69         "OverdueBills": 1,
70         "ApprovedBills": 5,
71         "DisapprovedBills": 1,
72         "TotalBills": 34,
73         "ActiveBillsAmount": 1250.75,
74         "PendingBillsAmount": 2890.5,
75         "InTransitBillsAmount": 1675.25,
76         "PaidBillsAmount": 15420.8,
77         "OverdueBillsAmount": 425,
78         "ApprovedBillsAmount": 3240.9,
79         "DisapprovedBillsAmount": 180,
80         "TotalBillsAmount": 25083.2
81       },
82       "PaypointLegalname": "Sunshine Services, LLC",
83       "PaypointDbaname": "Sunshine Gutters",
84       "PaypointEntryname": "d193cf9a46",
85       "ParentOrgName": "PropertyManager Pro",
86       "ParentOrgId": 1000,
87       "CreatedDate": "2022-07-01T15:00:01Z",
88       "LastUpdated": "2022-07-01T15:00:01Z",
89       "remitAddress1": "123 Walnut Street",
90       "remitAddress2": "Suite 900",
91       "remitCity": "Miami",
92       "remitState": "FL",
93       "remitZip": "31113",
94       "remitCountry": "US",
95       "payeeName1": "payeeName1",
96       "payeeName2": "payeeName2",
97       "customField1": "",
98       "customField2": "",
99       "customerVendorAccount": "123-456",
100       "InternalReferenceId": 1000000,
101       "PaymentPortalUrl": "https://greenfield-landscaping.com/pay",
102       "CardAccepted": "yes",
103       "AchAccepted": "unable to determine",
104       "EnrichmentStatus": "fully_enriched",
105       "EnrichedBy": "web_search",
106       "EnrichedAt": "2026-03-05T14:22:10Z",
107       "EnrichmentId": "enrich-3890-a1b2c3d4",
108       "additionalData": null,
109       "externalPaypointID": "Paypoint-100",
110       "StoredMethods": []
111     },
112     "billData": [
113       {
114         "invoiceDate": "2025-08-01",
115         "dueDate": "2025-08-15",
116         "billId": 54323,
117         "invoiceNumber": "INV-2345",
118         "netAmount": "500"
119       }
120     ],
121     "externalPaypointID": "d193cf9a46-10",
122     "method": "ach",
123     "paypointId": 3040,
124     "totalAmount": 500,
125     "netAmount": 500,
126     "feeAmount": 0,
127     "paymentData": {
128       "AccountType": "checking",
129       "HolderName": "Herman Coatings",
130       "Initiator": "merchant",
131       "MaskedAccount": "XXXXXX5666",
132       "paymentDetails": {
133         "totalAmount": 500,
134         "currency": "USD",
135         "serviceFee": 0
136       },
137       "Sequence": "subsequent",
138       "StoredMethodUsageType": "recurring"
139     },
140     "frequency": "monthly",
141     "totalCycles": 12,
142     "leftCycles": 11,
143     "entrypageId": 0,
144     "untilCancelled": false,
145     "lastUpdated": "2025-08-01T12:00:00Z",
146     "createdAt": "2025-08-01T12:00:00Z",
147     "paypointLegalname": "Sunshine Services, LLC",
148     "paypointDbaname": "Sunshine Gutters",
149     "paypointEntryname": "d193cf9a46",
150     "parentOrgName": "PropertyManager Pro",
151     "parentOrgId": 236,
152     "source": "api"
153   }
154 }

Retrieves a single payout subscription’s details. See Manage payout subscriptions for more information.

Authentication

requestTokenstring

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

AuthorizationBearer

OAuth2 Bearer access token from the client-credentials flow. See OAuth authentication.

Path parameters

idlongRequired

The payout subscription ID.

Response

Success

responseTextstring

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

isSuccessboolean

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

responseDataobject

The payout subscription record.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error