@payabli/sdk-node 0.0.135 → 0.0.137
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +5 -6
- package/README.md +19 -13
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +52 -42
- package/dist/cjs/api/resources/ghostCard/client/Client.d.ts +70 -0
- package/dist/cjs/api/resources/ghostCard/client/Client.js +204 -0
- package/dist/cjs/api/resources/ghostCard/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/ghostCard/client/index.js +17 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.ts +54 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.js +3 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.d.ts +14 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.js +3 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/ghostCard/exports.d.ts +2 -0
- package/dist/cjs/api/resources/ghostCard/exports.js +21 -0
- package/dist/cjs/api/resources/ghostCard/index.d.ts +2 -0
- package/dist/cjs/api/resources/ghostCard/index.js +18 -0
- package/dist/cjs/api/resources/ghostCard/types/CardStatus.d.ts +8 -0
- package/dist/cjs/api/resources/ghostCard/types/CardStatus.js +11 -0
- package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.d.ts +17 -0
- package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.js +3 -0
- package/dist/cjs/api/resources/ghostCard/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/ghostCard/types/index.js +18 -0
- package/dist/cjs/api/resources/index.d.ts +6 -0
- package/dist/cjs/api/resources/index.js +7 -1
- package/dist/cjs/api/resources/payoutSubscription/client/Client.d.ts +156 -0
- package/dist/cjs/api/resources/payoutSubscription/client/Client.js +385 -0
- package/dist/cjs/api/resources/payoutSubscription/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/payoutSubscription/client/index.js +17 -0
- package/dist/cjs/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.d.ts +67 -0
- package/dist/cjs/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/payoutSubscription/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/payoutSubscription/exports.d.ts +2 -0
- package/dist/cjs/api/resources/payoutSubscription/exports.js +21 -0
- package/dist/cjs/api/resources/payoutSubscription/index.d.ts +2 -0
- package/dist/cjs/api/resources/payoutSubscription/index.js +18 -0
- package/dist/cjs/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.d.ts +20 -0
- package/dist/cjs/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.d.ts +14 -0
- package/dist/cjs/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.ts +151 -0
- package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutPaymentDetail.d.ts +31 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutPaymentDetail.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutScheduleDetail.d.ts +9 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutScheduleDetail.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSetPause.d.ts +4 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSetPause.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.ts +195 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.ts +195 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.d.ts +69 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.ts +155 -0
- package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.d.ts +9 -0
- package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.d.ts +15 -0
- package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/index.d.ts +12 -0
- package/dist/cjs/api/resources/payoutSubscription/types/index.js +28 -0
- package/dist/cjs/api/resources/query/client/Client.d.ts +46 -6
- package/dist/cjs/api/resources/query/client/Client.js +150 -6
- package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.d.ts +84 -0
- package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.d.ts +84 -0
- package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/types/Remitaddress1.d.ts +1 -1
- package/dist/cjs/api/types/Remitaddress2.d.ts +1 -1
- package/dist/cjs/api/types/Remitcity.d.ts +1 -1
- package/dist/cjs/api/types/Remitcountry.d.ts +1 -1
- package/dist/cjs/api/types/Remitstate.d.ts +1 -1
- package/dist/cjs/api/types/Remitzip.d.ts +1 -1
- package/dist/cjs/api/types/VendorData.d.ts +6 -6
- package/dist/cjs/api/types/VendorEin.d.ts +1 -1
- package/dist/cjs/api/types/VendorName1.d.ts +1 -1
- package/dist/cjs/api/types/VendorName2.d.ts +1 -1
- package/dist/cjs/api/types/VendorNumber.d.ts +1 -1
- package/dist/cjs/api/types/VendorOutData.d.ts +9 -9
- package/dist/cjs/api/types/VendorQueryRecord.d.ts +1 -1
- package/dist/cjs/api/types/Vendorstatus.d.ts +5 -3
- package/dist/cjs/core/file/file.js +3 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +10 -0
- package/dist/esm/api/resources/ghostCard/client/Client.d.mts +70 -0
- package/dist/esm/api/resources/ghostCard/client/Client.mjs +167 -0
- package/dist/esm/api/resources/ghostCard/client/index.d.mts +1 -0
- package/dist/esm/api/resources/ghostCard/client/index.mjs +1 -0
- package/dist/esm/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.mts +54 -0
- package/dist/esm/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.mjs +2 -0
- package/dist/esm/api/resources/ghostCard/client/requests/UpdateCardRequestBody.d.mts +14 -0
- package/dist/esm/api/resources/ghostCard/client/requests/UpdateCardRequestBody.mjs +2 -0
- package/dist/esm/api/resources/ghostCard/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/ghostCard/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/ghostCard/exports.d.mts +2 -0
- package/dist/esm/api/resources/ghostCard/exports.mjs +3 -0
- package/dist/esm/api/resources/ghostCard/index.d.mts +2 -0
- package/dist/esm/api/resources/ghostCard/index.mjs +2 -0
- package/dist/esm/api/resources/ghostCard/types/CardStatus.d.mts +8 -0
- package/dist/esm/api/resources/ghostCard/types/CardStatus.mjs +8 -0
- package/dist/esm/api/resources/ghostCard/types/CreateGhostCardResponse.d.mts +17 -0
- package/dist/esm/api/resources/ghostCard/types/CreateGhostCardResponse.mjs +2 -0
- package/dist/esm/api/resources/ghostCard/types/index.d.mts +2 -0
- package/dist/esm/api/resources/ghostCard/types/index.mjs +2 -0
- package/dist/esm/api/resources/index.d.mts +6 -0
- package/dist/esm/api/resources/index.mjs +6 -0
- package/dist/esm/api/resources/payoutSubscription/client/Client.d.mts +156 -0
- package/dist/esm/api/resources/payoutSubscription/client/Client.mjs +348 -0
- package/dist/esm/api/resources/payoutSubscription/client/index.d.mts +1 -0
- package/dist/esm/api/resources/payoutSubscription/client/index.mjs +1 -0
- package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.d.mts +67 -0
- package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/payoutSubscription/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/payoutSubscription/exports.d.mts +2 -0
- package/dist/esm/api/resources/payoutSubscription/exports.mjs +3 -0
- package/dist/esm/api/resources/payoutSubscription/index.d.mts +2 -0
- package/dist/esm/api/resources/payoutSubscription/index.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.d.mts +20 -0
- package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.d.mts +14 -0
- package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.mts +151 -0
- package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutPaymentDetail.d.mts +31 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutPaymentDetail.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutScheduleDetail.d.mts +9 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutScheduleDetail.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSetPause.d.mts +4 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSetPause.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.mts +195 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.mts +195 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.d.mts +69 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.mts +155 -0
- package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.d.mts +9 -0
- package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.d.mts +15 -0
- package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/index.d.mts +12 -0
- package/dist/esm/api/resources/payoutSubscription/types/index.mjs +12 -0
- package/dist/esm/api/resources/query/client/Client.d.mts +46 -6
- package/dist/esm/api/resources/query/client/Client.mjs +150 -6
- package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.d.mts +84 -0
- package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.d.mts +84 -0
- package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
- package/dist/esm/api/types/Remitaddress1.d.mts +1 -1
- package/dist/esm/api/types/Remitaddress2.d.mts +1 -1
- package/dist/esm/api/types/Remitcity.d.mts +1 -1
- package/dist/esm/api/types/Remitcountry.d.mts +1 -1
- package/dist/esm/api/types/Remitstate.d.mts +1 -1
- package/dist/esm/api/types/Remitzip.d.mts +1 -1
- package/dist/esm/api/types/VendorData.d.mts +6 -6
- package/dist/esm/api/types/VendorEin.d.mts +1 -1
- package/dist/esm/api/types/VendorName1.d.mts +1 -1
- package/dist/esm/api/types/VendorName2.d.mts +1 -1
- package/dist/esm/api/types/VendorNumber.d.mts +1 -1
- package/dist/esm/api/types/VendorOutData.d.mts +9 -9
- package/dist/esm/api/types/VendorQueryRecord.d.mts +1 -1
- package/dist/esm/api/types/Vendorstatus.d.mts +5 -3
- package/dist/esm/core/file/file.mjs +3 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +29 -7
- package/reference.md +685 -78
package/reference.md
CHANGED
|
@@ -5141,6 +5141,172 @@ await client.export.exportVendorsOrg("csv", 123, {
|
|
|
5141
5141
|
</dl>
|
|
5142
5142
|
|
|
5143
5143
|
|
|
5144
|
+
</dd>
|
|
5145
|
+
</dl>
|
|
5146
|
+
</details>
|
|
5147
|
+
|
|
5148
|
+
## GhostCard
|
|
5149
|
+
<details><summary><code>client.ghostCard.<a href="/src/api/resources/ghostCard/client/Client.ts">createGhostCard</a>(entry, { ...params }) -> Payabli.CreateGhostCardResponse</code></summary>
|
|
5150
|
+
<dl>
|
|
5151
|
+
<dd>
|
|
5152
|
+
|
|
5153
|
+
#### 📝 Description
|
|
5154
|
+
|
|
5155
|
+
<dl>
|
|
5156
|
+
<dd>
|
|
5157
|
+
|
|
5158
|
+
<dl>
|
|
5159
|
+
<dd>
|
|
5160
|
+
|
|
5161
|
+
Creates a ghost card, a multi-use virtual debit card issued to a vendor for recurring or discretionary spend.
|
|
5162
|
+
|
|
5163
|
+
Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
|
|
5164
|
+
|
|
5165
|
+
Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
|
|
5166
|
+
</dd>
|
|
5167
|
+
</dl>
|
|
5168
|
+
</dd>
|
|
5169
|
+
</dl>
|
|
5170
|
+
|
|
5171
|
+
#### 🔌 Usage
|
|
5172
|
+
|
|
5173
|
+
<dl>
|
|
5174
|
+
<dd>
|
|
5175
|
+
|
|
5176
|
+
<dl>
|
|
5177
|
+
<dd>
|
|
5178
|
+
|
|
5179
|
+
```typescript
|
|
5180
|
+
await client.ghostCard.createGhostCard("8cfec2e0fa", {
|
|
5181
|
+
vendorId: 42,
|
|
5182
|
+
expenseLimit: 500,
|
|
5183
|
+
amount: 500,
|
|
5184
|
+
maxNumberOfUses: 3,
|
|
5185
|
+
exactAmount: false,
|
|
5186
|
+
expenseLimitPeriod: "monthly",
|
|
5187
|
+
billingCycle: "monthly",
|
|
5188
|
+
billingCycleDay: "1",
|
|
5189
|
+
dailyTransactionCount: 5,
|
|
5190
|
+
dailyAmountLimit: 200,
|
|
5191
|
+
transactionAmountLimit: 100,
|
|
5192
|
+
mcc: "5411",
|
|
5193
|
+
tcc: "R",
|
|
5194
|
+
misc1: "PO-98765",
|
|
5195
|
+
misc2: "Dept-Finance"
|
|
5196
|
+
});
|
|
5197
|
+
|
|
5198
|
+
```
|
|
5199
|
+
</dd>
|
|
5200
|
+
</dl>
|
|
5201
|
+
</dd>
|
|
5202
|
+
</dl>
|
|
5203
|
+
|
|
5204
|
+
#### ⚙️ Parameters
|
|
5205
|
+
|
|
5206
|
+
<dl>
|
|
5207
|
+
<dd>
|
|
5208
|
+
|
|
5209
|
+
<dl>
|
|
5210
|
+
<dd>
|
|
5211
|
+
|
|
5212
|
+
**entry:** `Payabli.Entry`
|
|
5213
|
+
|
|
5214
|
+
</dd>
|
|
5215
|
+
</dl>
|
|
5216
|
+
|
|
5217
|
+
<dl>
|
|
5218
|
+
<dd>
|
|
5219
|
+
|
|
5220
|
+
**request:** `Payabli.CreateGhostCardRequestBody`
|
|
5221
|
+
|
|
5222
|
+
</dd>
|
|
5223
|
+
</dl>
|
|
5224
|
+
|
|
5225
|
+
<dl>
|
|
5226
|
+
<dd>
|
|
5227
|
+
|
|
5228
|
+
**requestOptions:** `GhostCardClient.RequestOptions`
|
|
5229
|
+
|
|
5230
|
+
</dd>
|
|
5231
|
+
</dl>
|
|
5232
|
+
</dd>
|
|
5233
|
+
</dl>
|
|
5234
|
+
|
|
5235
|
+
|
|
5236
|
+
</dd>
|
|
5237
|
+
</dl>
|
|
5238
|
+
</details>
|
|
5239
|
+
|
|
5240
|
+
<details><summary><code>client.ghostCard.<a href="/src/api/resources/ghostCard/client/Client.ts">updateCard</a>(entry, { ...params }) -> Payabli.PayabliApiResponse</code></summary>
|
|
5241
|
+
<dl>
|
|
5242
|
+
<dd>
|
|
5243
|
+
|
|
5244
|
+
#### 📝 Description
|
|
5245
|
+
|
|
5246
|
+
<dl>
|
|
5247
|
+
<dd>
|
|
5248
|
+
|
|
5249
|
+
<dl>
|
|
5250
|
+
<dd>
|
|
5251
|
+
|
|
5252
|
+
Updates the status of a virtual card (including ghost cards) under a paypoint.
|
|
5253
|
+
</dd>
|
|
5254
|
+
</dl>
|
|
5255
|
+
</dd>
|
|
5256
|
+
</dl>
|
|
5257
|
+
|
|
5258
|
+
#### 🔌 Usage
|
|
5259
|
+
|
|
5260
|
+
<dl>
|
|
5261
|
+
<dd>
|
|
5262
|
+
|
|
5263
|
+
<dl>
|
|
5264
|
+
<dd>
|
|
5265
|
+
|
|
5266
|
+
```typescript
|
|
5267
|
+
await client.ghostCard.updateCard("8cfec2e0fa", {
|
|
5268
|
+
cardToken: "gc_abc123def456",
|
|
5269
|
+
status: "Cancelled"
|
|
5270
|
+
});
|
|
5271
|
+
|
|
5272
|
+
```
|
|
5273
|
+
</dd>
|
|
5274
|
+
</dl>
|
|
5275
|
+
</dd>
|
|
5276
|
+
</dl>
|
|
5277
|
+
|
|
5278
|
+
#### ⚙️ Parameters
|
|
5279
|
+
|
|
5280
|
+
<dl>
|
|
5281
|
+
<dd>
|
|
5282
|
+
|
|
5283
|
+
<dl>
|
|
5284
|
+
<dd>
|
|
5285
|
+
|
|
5286
|
+
**entry:** `Payabli.Entry`
|
|
5287
|
+
|
|
5288
|
+
</dd>
|
|
5289
|
+
</dl>
|
|
5290
|
+
|
|
5291
|
+
<dl>
|
|
5292
|
+
<dd>
|
|
5293
|
+
|
|
5294
|
+
**request:** `Payabli.UpdateCardRequestBody`
|
|
5295
|
+
|
|
5296
|
+
</dd>
|
|
5297
|
+
</dl>
|
|
5298
|
+
|
|
5299
|
+
<dl>
|
|
5300
|
+
<dd>
|
|
5301
|
+
|
|
5302
|
+
**requestOptions:** `GhostCardClient.RequestOptions`
|
|
5303
|
+
|
|
5304
|
+
</dd>
|
|
5305
|
+
</dl>
|
|
5306
|
+
</dd>
|
|
5307
|
+
</dl>
|
|
5308
|
+
|
|
5309
|
+
|
|
5144
5310
|
</dd>
|
|
5145
5311
|
</dl>
|
|
5146
5312
|
</details>
|
|
@@ -11894,8 +12060,8 @@ await client.paymentMethodDomain.verifyPaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
11894
12060
|
</dl>
|
|
11895
12061
|
</details>
|
|
11896
12062
|
|
|
11897
|
-
##
|
|
11898
|
-
<details><summary><code>client.
|
|
12063
|
+
## PayoutSubscription
|
|
12064
|
+
<details><summary><code>client.payoutSubscription.<a href="/src/api/resources/payoutSubscription/client/Client.ts">createPayoutSubscription</a>({ ...params }) -> Payabli.AddPayoutSubscriptionResponse</code></summary>
|
|
11899
12065
|
<dl>
|
|
11900
12066
|
<dd>
|
|
11901
12067
|
|
|
@@ -11907,7 +12073,7 @@ await client.paymentMethodDomain.verifyPaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
11907
12073
|
<dl>
|
|
11908
12074
|
<dd>
|
|
11909
12075
|
|
|
11910
|
-
|
|
12076
|
+
Creates a payout subscription to automatically send payouts to a vendor on a recurring schedule. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for a step-by-step guide.
|
|
11911
12077
|
</dd>
|
|
11912
12078
|
</dl>
|
|
11913
12079
|
</dd>
|
|
@@ -11922,7 +12088,37 @@ Gets the basic details for a paypoint.
|
|
|
11922
12088
|
<dd>
|
|
11923
12089
|
|
|
11924
12090
|
```typescript
|
|
11925
|
-
await client.
|
|
12091
|
+
await client.payoutSubscription.createPayoutSubscription({
|
|
12092
|
+
body: {
|
|
12093
|
+
entryPoint: "d193cf9a46",
|
|
12094
|
+
paymentMethod: {
|
|
12095
|
+
method: "ach",
|
|
12096
|
+
achHolder: "Herman Coatings",
|
|
12097
|
+
achRouting: "021000021",
|
|
12098
|
+
achAccount: "3453445666",
|
|
12099
|
+
achAccountType: "checking"
|
|
12100
|
+
},
|
|
12101
|
+
paymentDetails: {
|
|
12102
|
+
totalAmount: 500,
|
|
12103
|
+
serviceFee: 0,
|
|
12104
|
+
currency: "USD"
|
|
12105
|
+
},
|
|
12106
|
+
vendorData: {
|
|
12107
|
+
vendorId: 1501
|
|
12108
|
+
},
|
|
12109
|
+
billData: [{
|
|
12110
|
+
invoiceNumber: "INV-5001",
|
|
12111
|
+
netAmount: "500",
|
|
12112
|
+
invoiceDate: "2025-08-01",
|
|
12113
|
+
dueDate: "2025-08-15"
|
|
12114
|
+
}],
|
|
12115
|
+
scheduleDetails: {
|
|
12116
|
+
startDate: "09/01/2025",
|
|
12117
|
+
endDate: "09/01/2026",
|
|
12118
|
+
frequency: "monthly"
|
|
12119
|
+
}
|
|
12120
|
+
}
|
|
12121
|
+
});
|
|
11926
12122
|
|
|
11927
12123
|
```
|
|
11928
12124
|
</dd>
|
|
@@ -11938,7 +12134,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11938
12134
|
<dl>
|
|
11939
12135
|
<dd>
|
|
11940
12136
|
|
|
11941
|
-
**
|
|
12137
|
+
**request:** `Payabli.RequestPayoutSchedule`
|
|
11942
12138
|
|
|
11943
12139
|
</dd>
|
|
11944
12140
|
</dl>
|
|
@@ -11946,7 +12142,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11946
12142
|
<dl>
|
|
11947
12143
|
<dd>
|
|
11948
12144
|
|
|
11949
|
-
**requestOptions:** `
|
|
12145
|
+
**requestOptions:** `PayoutSubscriptionClient.RequestOptions`
|
|
11950
12146
|
|
|
11951
12147
|
</dd>
|
|
11952
12148
|
</dl>
|
|
@@ -11958,7 +12154,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11958
12154
|
</dl>
|
|
11959
12155
|
</details>
|
|
11960
12156
|
|
|
11961
|
-
<details><summary><code>client.
|
|
12157
|
+
<details><summary><code>client.payoutSubscription.<a href="/src/api/resources/payoutSubscription/client/Client.ts">getPayoutSubscription</a>(id) -> Payabli.GetPayoutSubscriptionResponse</code></summary>
|
|
11962
12158
|
<dl>
|
|
11963
12159
|
<dd>
|
|
11964
12160
|
|
|
@@ -11970,7 +12166,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11970
12166
|
<dl>
|
|
11971
12167
|
<dd>
|
|
11972
12168
|
|
|
11973
|
-
Retrieves
|
|
12169
|
+
Retrieves a single payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
11974
12170
|
</dd>
|
|
11975
12171
|
</dl>
|
|
11976
12172
|
</dd>
|
|
@@ -11985,7 +12181,7 @@ Retrieves the basic details for a paypoint by ID.
|
|
|
11985
12181
|
<dd>
|
|
11986
12182
|
|
|
11987
12183
|
```typescript
|
|
11988
|
-
await client.
|
|
12184
|
+
await client.payoutSubscription.getPayoutSubscription(42);
|
|
11989
12185
|
|
|
11990
12186
|
```
|
|
11991
12187
|
</dd>
|
|
@@ -12001,7 +12197,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
12001
12197
|
<dl>
|
|
12002
12198
|
<dd>
|
|
12003
12199
|
|
|
12004
|
-
**
|
|
12200
|
+
**id:** `number` — The payout subscription ID.
|
|
12005
12201
|
|
|
12006
12202
|
</dd>
|
|
12007
12203
|
</dl>
|
|
@@ -12009,7 +12205,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
12009
12205
|
<dl>
|
|
12010
12206
|
<dd>
|
|
12011
12207
|
|
|
12012
|
-
**requestOptions:** `
|
|
12208
|
+
**requestOptions:** `PayoutSubscriptionClient.RequestOptions`
|
|
12013
12209
|
|
|
12014
12210
|
</dd>
|
|
12015
12211
|
</dl>
|
|
@@ -12021,7 +12217,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
12021
12217
|
</dl>
|
|
12022
12218
|
</details>
|
|
12023
12219
|
|
|
12024
|
-
<details><summary><code>client.
|
|
12220
|
+
<details><summary><code>client.payoutSubscription.<a href="/src/api/resources/payoutSubscription/client/Client.ts">updatePayoutSubscription</a>(id, { ...params }) -> Payabli.UpdatePayoutSubscriptionResponse</code></summary>
|
|
12025
12221
|
<dl>
|
|
12026
12222
|
<dd>
|
|
12027
12223
|
|
|
@@ -12033,7 +12229,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
12033
12229
|
<dl>
|
|
12034
12230
|
<dd>
|
|
12035
12231
|
|
|
12036
|
-
|
|
12232
|
+
Updates a payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
12037
12233
|
</dd>
|
|
12038
12234
|
</dl>
|
|
12039
12235
|
</dd>
|
|
@@ -12048,7 +12244,9 @@ Gets the details for a single paypoint.
|
|
|
12048
12244
|
<dd>
|
|
12049
12245
|
|
|
12050
12246
|
```typescript
|
|
12051
|
-
await client.
|
|
12247
|
+
await client.payoutSubscription.updatePayoutSubscription(42, {
|
|
12248
|
+
setPause: true
|
|
12249
|
+
});
|
|
12052
12250
|
|
|
12053
12251
|
```
|
|
12054
12252
|
</dd>
|
|
@@ -12064,7 +12262,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12064
12262
|
<dl>
|
|
12065
12263
|
<dd>
|
|
12066
12264
|
|
|
12067
|
-
**
|
|
12265
|
+
**id:** `number` — The payout subscription ID.
|
|
12068
12266
|
|
|
12069
12267
|
</dd>
|
|
12070
12268
|
</dl>
|
|
@@ -12072,7 +12270,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12072
12270
|
<dl>
|
|
12073
12271
|
<dd>
|
|
12074
12272
|
|
|
12075
|
-
**request:** `Payabli.
|
|
12273
|
+
**request:** `Payabli.UpdatePayoutSubscriptionBody`
|
|
12076
12274
|
|
|
12077
12275
|
</dd>
|
|
12078
12276
|
</dl>
|
|
@@ -12080,7 +12278,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12080
12278
|
<dl>
|
|
12081
12279
|
<dd>
|
|
12082
12280
|
|
|
12083
|
-
**requestOptions:** `
|
|
12281
|
+
**requestOptions:** `PayoutSubscriptionClient.RequestOptions`
|
|
12084
12282
|
|
|
12085
12283
|
</dd>
|
|
12086
12284
|
</dl>
|
|
@@ -12092,7 +12290,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12092
12290
|
</dl>
|
|
12093
12291
|
</details>
|
|
12094
12292
|
|
|
12095
|
-
<details><summary><code>client.
|
|
12293
|
+
<details><summary><code>client.payoutSubscription.<a href="/src/api/resources/payoutSubscription/client/Client.ts">deletePayoutSubscription</a>(id) -> Payabli.DeletePayoutSubscriptionResponse</code></summary>
|
|
12096
12294
|
<dl>
|
|
12097
12295
|
<dd>
|
|
12098
12296
|
|
|
@@ -12104,7 +12302,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12104
12302
|
<dl>
|
|
12105
12303
|
<dd>
|
|
12106
12304
|
|
|
12107
|
-
|
|
12305
|
+
Deletes a payout subscription and prevents future payouts. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
12108
12306
|
</dd>
|
|
12109
12307
|
</dl>
|
|
12110
12308
|
</dd>
|
|
@@ -12119,7 +12317,7 @@ Gets the details for single payment page for a paypoint.
|
|
|
12119
12317
|
<dd>
|
|
12120
12318
|
|
|
12121
12319
|
```typescript
|
|
12122
|
-
await client.
|
|
12320
|
+
await client.payoutSubscription.deletePayoutSubscription(42);
|
|
12123
12321
|
|
|
12124
12322
|
```
|
|
12125
12323
|
</dd>
|
|
@@ -12135,15 +12333,7 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
12135
12333
|
<dl>
|
|
12136
12334
|
<dd>
|
|
12137
12335
|
|
|
12138
|
-
**
|
|
12139
|
-
|
|
12140
|
-
</dd>
|
|
12141
|
-
</dl>
|
|
12142
|
-
|
|
12143
|
-
<dl>
|
|
12144
|
-
<dd>
|
|
12145
|
-
|
|
12146
|
-
**subdomain:** `string` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
12336
|
+
**id:** `number` — The payout subscription ID.
|
|
12147
12337
|
|
|
12148
12338
|
</dd>
|
|
12149
12339
|
</dl>
|
|
@@ -12151,7 +12341,7 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
12151
12341
|
<dl>
|
|
12152
12342
|
<dd>
|
|
12153
12343
|
|
|
12154
|
-
**requestOptions:** `
|
|
12344
|
+
**requestOptions:** `PayoutSubscriptionClient.RequestOptions`
|
|
12155
12345
|
|
|
12156
12346
|
</dd>
|
|
12157
12347
|
</dl>
|
|
@@ -12163,7 +12353,8 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
12163
12353
|
</dl>
|
|
12164
12354
|
</details>
|
|
12165
12355
|
|
|
12166
|
-
|
|
12356
|
+
## Paypoint
|
|
12357
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getBasicEntry</a>(entry) -> Payabli.GetBasicEntryResponse</code></summary>
|
|
12167
12358
|
<dl>
|
|
12168
12359
|
<dd>
|
|
12169
12360
|
|
|
@@ -12175,7 +12366,7 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
12175
12366
|
<dl>
|
|
12176
12367
|
<dd>
|
|
12177
12368
|
|
|
12178
|
-
|
|
12369
|
+
Gets the basic details for a paypoint.
|
|
12179
12370
|
</dd>
|
|
12180
12371
|
</dl>
|
|
12181
12372
|
</dd>
|
|
@@ -12190,7 +12381,7 @@ Deletes a payment page in a paypoint.
|
|
|
12190
12381
|
<dd>
|
|
12191
12382
|
|
|
12192
12383
|
```typescript
|
|
12193
|
-
await client.paypoint.
|
|
12384
|
+
await client.paypoint.getBasicEntry("8cfec329267");
|
|
12194
12385
|
|
|
12195
12386
|
```
|
|
12196
12387
|
</dd>
|
|
@@ -12214,14 +12405,6 @@ await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
|
12214
12405
|
<dl>
|
|
12215
12406
|
<dd>
|
|
12216
12407
|
|
|
12217
|
-
**subdomain:** `string` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
12218
|
-
|
|
12219
|
-
</dd>
|
|
12220
|
-
</dl>
|
|
12221
|
-
|
|
12222
|
-
<dl>
|
|
12223
|
-
<dd>
|
|
12224
|
-
|
|
12225
12408
|
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12226
12409
|
|
|
12227
12410
|
</dd>
|
|
@@ -12234,7 +12417,7 @@ await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
|
12234
12417
|
</dl>
|
|
12235
12418
|
</details>
|
|
12236
12419
|
|
|
12237
|
-
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">
|
|
12420
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getBasicEntryById</a>(IdPaypoint) -> Payabli.GetBasicEntryByIdResponse</code></summary>
|
|
12238
12421
|
<dl>
|
|
12239
12422
|
<dd>
|
|
12240
12423
|
|
|
@@ -12246,7 +12429,7 @@ await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
|
12246
12429
|
<dl>
|
|
12247
12430
|
<dd>
|
|
12248
12431
|
|
|
12249
|
-
|
|
12432
|
+
Retrieves the basic details for a paypoint by ID.
|
|
12250
12433
|
</dd>
|
|
12251
12434
|
</dl>
|
|
12252
12435
|
</dd>
|
|
@@ -12261,7 +12444,7 @@ Updates a paypoint logo.
|
|
|
12261
12444
|
<dd>
|
|
12262
12445
|
|
|
12263
12446
|
```typescript
|
|
12264
|
-
await client.paypoint.
|
|
12447
|
+
await client.paypoint.getBasicEntryById("198");
|
|
12265
12448
|
|
|
12266
12449
|
```
|
|
12267
12450
|
</dd>
|
|
@@ -12277,15 +12460,7 @@ await client.paypoint.saveLogo("8cfec329267", {});
|
|
|
12277
12460
|
<dl>
|
|
12278
12461
|
<dd>
|
|
12279
12462
|
|
|
12280
|
-
**
|
|
12281
|
-
|
|
12282
|
-
</dd>
|
|
12283
|
-
</dl>
|
|
12284
|
-
|
|
12285
|
-
<dl>
|
|
12286
|
-
<dd>
|
|
12287
|
-
|
|
12288
|
-
**request:** `Payabli.FileContent`
|
|
12463
|
+
**IdPaypoint:** `string` — Paypoint ID. You can find this value by querying `/api/Query/paypoints/{orgId}`
|
|
12289
12464
|
|
|
12290
12465
|
</dd>
|
|
12291
12466
|
</dl>
|
|
@@ -12305,7 +12480,7 @@ await client.paypoint.saveLogo("8cfec329267", {});
|
|
|
12305
12480
|
</dl>
|
|
12306
12481
|
</details>
|
|
12307
12482
|
|
|
12308
|
-
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">
|
|
12483
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getEntryConfig</a>(entry, { ...params }) -> Payabli.GetEntryConfigResponse</code></summary>
|
|
12309
12484
|
<dl>
|
|
12310
12485
|
<dd>
|
|
12311
12486
|
|
|
@@ -12317,7 +12492,7 @@ await client.paypoint.saveLogo("8cfec329267", {});
|
|
|
12317
12492
|
<dl>
|
|
12318
12493
|
<dd>
|
|
12319
12494
|
|
|
12320
|
-
|
|
12495
|
+
Gets the details for a single paypoint.
|
|
12321
12496
|
</dd>
|
|
12322
12497
|
</dl>
|
|
12323
12498
|
</dd>
|
|
@@ -12332,7 +12507,7 @@ Retrieves an paypoint's basic settings like custom fields, identifiers, and invo
|
|
|
12332
12507
|
<dd>
|
|
12333
12508
|
|
|
12334
12509
|
```typescript
|
|
12335
|
-
await client.paypoint.
|
|
12510
|
+
await client.paypoint.getEntryConfig("8cfec329267");
|
|
12336
12511
|
|
|
12337
12512
|
```
|
|
12338
12513
|
</dd>
|
|
@@ -12356,6 +12531,14 @@ await client.paypoint.settingsPage("8cfec329267");
|
|
|
12356
12531
|
<dl>
|
|
12357
12532
|
<dd>
|
|
12358
12533
|
|
|
12534
|
+
**request:** `Payabli.GetEntryConfigRequest`
|
|
12535
|
+
|
|
12536
|
+
</dd>
|
|
12537
|
+
</dl>
|
|
12538
|
+
|
|
12539
|
+
<dl>
|
|
12540
|
+
<dd>
|
|
12541
|
+
|
|
12359
12542
|
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12360
12543
|
|
|
12361
12544
|
</dd>
|
|
@@ -12368,7 +12551,7 @@ await client.paypoint.settingsPage("8cfec329267");
|
|
|
12368
12551
|
</dl>
|
|
12369
12552
|
</details>
|
|
12370
12553
|
|
|
12371
|
-
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">
|
|
12554
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getPage</a>(entry, subdomain) -> Payabli.PayabliPages</code></summary>
|
|
12372
12555
|
<dl>
|
|
12373
12556
|
<dd>
|
|
12374
12557
|
|
|
@@ -12380,7 +12563,7 @@ await client.paypoint.settingsPage("8cfec329267");
|
|
|
12380
12563
|
<dl>
|
|
12381
12564
|
<dd>
|
|
12382
12565
|
|
|
12383
|
-
|
|
12566
|
+
Gets the details for single payment page for a paypoint.
|
|
12384
12567
|
</dd>
|
|
12385
12568
|
</dl>
|
|
12386
12569
|
</dd>
|
|
@@ -12395,17 +12578,7 @@ Migrates a paypoint to a new parent organization.
|
|
|
12395
12578
|
<dd>
|
|
12396
12579
|
|
|
12397
12580
|
```typescript
|
|
12398
|
-
await client.paypoint.
|
|
12399
|
-
entryPoint: "473abc123def",
|
|
12400
|
-
newParentOrganizationId: 123,
|
|
12401
|
-
notificationRequest: {
|
|
12402
|
-
notificationUrl: "https://webhook-test.yoursie.com",
|
|
12403
|
-
webHeaderParameters: [{
|
|
12404
|
-
key: "testheader",
|
|
12405
|
-
value: "1234567890"
|
|
12406
|
-
}]
|
|
12407
|
-
}
|
|
12408
|
-
});
|
|
12581
|
+
await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
12409
12582
|
|
|
12410
12583
|
```
|
|
12411
12584
|
</dd>
|
|
@@ -12421,7 +12594,15 @@ await client.paypoint.migrate({
|
|
|
12421
12594
|
<dl>
|
|
12422
12595
|
<dd>
|
|
12423
12596
|
|
|
12424
|
-
**
|
|
12597
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
12598
|
+
|
|
12599
|
+
</dd>
|
|
12600
|
+
</dl>
|
|
12601
|
+
|
|
12602
|
+
<dl>
|
|
12603
|
+
<dd>
|
|
12604
|
+
|
|
12605
|
+
**subdomain:** `string` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
12425
12606
|
|
|
12426
12607
|
</dd>
|
|
12427
12608
|
</dl>
|
|
@@ -12441,8 +12622,286 @@ await client.paypoint.migrate({
|
|
|
12441
12622
|
</dl>
|
|
12442
12623
|
</details>
|
|
12443
12624
|
|
|
12444
|
-
|
|
12445
|
-
<
|
|
12625
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">removePage</a>(entry, subdomain) -> Payabli.PayabliApiResponseGeneric2Part</code></summary>
|
|
12626
|
+
<dl>
|
|
12627
|
+
<dd>
|
|
12628
|
+
|
|
12629
|
+
#### 📝 Description
|
|
12630
|
+
|
|
12631
|
+
<dl>
|
|
12632
|
+
<dd>
|
|
12633
|
+
|
|
12634
|
+
<dl>
|
|
12635
|
+
<dd>
|
|
12636
|
+
|
|
12637
|
+
Deletes a payment page in a paypoint.
|
|
12638
|
+
</dd>
|
|
12639
|
+
</dl>
|
|
12640
|
+
</dd>
|
|
12641
|
+
</dl>
|
|
12642
|
+
|
|
12643
|
+
#### 🔌 Usage
|
|
12644
|
+
|
|
12645
|
+
<dl>
|
|
12646
|
+
<dd>
|
|
12647
|
+
|
|
12648
|
+
<dl>
|
|
12649
|
+
<dd>
|
|
12650
|
+
|
|
12651
|
+
```typescript
|
|
12652
|
+
await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
12653
|
+
|
|
12654
|
+
```
|
|
12655
|
+
</dd>
|
|
12656
|
+
</dl>
|
|
12657
|
+
</dd>
|
|
12658
|
+
</dl>
|
|
12659
|
+
|
|
12660
|
+
#### ⚙️ Parameters
|
|
12661
|
+
|
|
12662
|
+
<dl>
|
|
12663
|
+
<dd>
|
|
12664
|
+
|
|
12665
|
+
<dl>
|
|
12666
|
+
<dd>
|
|
12667
|
+
|
|
12668
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
12669
|
+
|
|
12670
|
+
</dd>
|
|
12671
|
+
</dl>
|
|
12672
|
+
|
|
12673
|
+
<dl>
|
|
12674
|
+
<dd>
|
|
12675
|
+
|
|
12676
|
+
**subdomain:** `string` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
12677
|
+
|
|
12678
|
+
</dd>
|
|
12679
|
+
</dl>
|
|
12680
|
+
|
|
12681
|
+
<dl>
|
|
12682
|
+
<dd>
|
|
12683
|
+
|
|
12684
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12685
|
+
|
|
12686
|
+
</dd>
|
|
12687
|
+
</dl>
|
|
12688
|
+
</dd>
|
|
12689
|
+
</dl>
|
|
12690
|
+
|
|
12691
|
+
|
|
12692
|
+
</dd>
|
|
12693
|
+
</dl>
|
|
12694
|
+
</details>
|
|
12695
|
+
|
|
12696
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">saveLogo</a>(entry, { ...params }) -> Payabli.PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
12697
|
+
<dl>
|
|
12698
|
+
<dd>
|
|
12699
|
+
|
|
12700
|
+
#### 📝 Description
|
|
12701
|
+
|
|
12702
|
+
<dl>
|
|
12703
|
+
<dd>
|
|
12704
|
+
|
|
12705
|
+
<dl>
|
|
12706
|
+
<dd>
|
|
12707
|
+
|
|
12708
|
+
Updates a paypoint logo.
|
|
12709
|
+
</dd>
|
|
12710
|
+
</dl>
|
|
12711
|
+
</dd>
|
|
12712
|
+
</dl>
|
|
12713
|
+
|
|
12714
|
+
#### 🔌 Usage
|
|
12715
|
+
|
|
12716
|
+
<dl>
|
|
12717
|
+
<dd>
|
|
12718
|
+
|
|
12719
|
+
<dl>
|
|
12720
|
+
<dd>
|
|
12721
|
+
|
|
12722
|
+
```typescript
|
|
12723
|
+
await client.paypoint.saveLogo("8cfec329267", {});
|
|
12724
|
+
|
|
12725
|
+
```
|
|
12726
|
+
</dd>
|
|
12727
|
+
</dl>
|
|
12728
|
+
</dd>
|
|
12729
|
+
</dl>
|
|
12730
|
+
|
|
12731
|
+
#### ⚙️ Parameters
|
|
12732
|
+
|
|
12733
|
+
<dl>
|
|
12734
|
+
<dd>
|
|
12735
|
+
|
|
12736
|
+
<dl>
|
|
12737
|
+
<dd>
|
|
12738
|
+
|
|
12739
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
12740
|
+
|
|
12741
|
+
</dd>
|
|
12742
|
+
</dl>
|
|
12743
|
+
|
|
12744
|
+
<dl>
|
|
12745
|
+
<dd>
|
|
12746
|
+
|
|
12747
|
+
**request:** `Payabli.FileContent`
|
|
12748
|
+
|
|
12749
|
+
</dd>
|
|
12750
|
+
</dl>
|
|
12751
|
+
|
|
12752
|
+
<dl>
|
|
12753
|
+
<dd>
|
|
12754
|
+
|
|
12755
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12756
|
+
|
|
12757
|
+
</dd>
|
|
12758
|
+
</dl>
|
|
12759
|
+
</dd>
|
|
12760
|
+
</dl>
|
|
12761
|
+
|
|
12762
|
+
|
|
12763
|
+
</dd>
|
|
12764
|
+
</dl>
|
|
12765
|
+
</details>
|
|
12766
|
+
|
|
12767
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">settingsPage</a>(entry) -> Payabli.SettingsQueryRecord</code></summary>
|
|
12768
|
+
<dl>
|
|
12769
|
+
<dd>
|
|
12770
|
+
|
|
12771
|
+
#### 📝 Description
|
|
12772
|
+
|
|
12773
|
+
<dl>
|
|
12774
|
+
<dd>
|
|
12775
|
+
|
|
12776
|
+
<dl>
|
|
12777
|
+
<dd>
|
|
12778
|
+
|
|
12779
|
+
Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.
|
|
12780
|
+
</dd>
|
|
12781
|
+
</dl>
|
|
12782
|
+
</dd>
|
|
12783
|
+
</dl>
|
|
12784
|
+
|
|
12785
|
+
#### 🔌 Usage
|
|
12786
|
+
|
|
12787
|
+
<dl>
|
|
12788
|
+
<dd>
|
|
12789
|
+
|
|
12790
|
+
<dl>
|
|
12791
|
+
<dd>
|
|
12792
|
+
|
|
12793
|
+
```typescript
|
|
12794
|
+
await client.paypoint.settingsPage("8cfec329267");
|
|
12795
|
+
|
|
12796
|
+
```
|
|
12797
|
+
</dd>
|
|
12798
|
+
</dl>
|
|
12799
|
+
</dd>
|
|
12800
|
+
</dl>
|
|
12801
|
+
|
|
12802
|
+
#### ⚙️ Parameters
|
|
12803
|
+
|
|
12804
|
+
<dl>
|
|
12805
|
+
<dd>
|
|
12806
|
+
|
|
12807
|
+
<dl>
|
|
12808
|
+
<dd>
|
|
12809
|
+
|
|
12810
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
12811
|
+
|
|
12812
|
+
</dd>
|
|
12813
|
+
</dl>
|
|
12814
|
+
|
|
12815
|
+
<dl>
|
|
12816
|
+
<dd>
|
|
12817
|
+
|
|
12818
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12819
|
+
|
|
12820
|
+
</dd>
|
|
12821
|
+
</dl>
|
|
12822
|
+
</dd>
|
|
12823
|
+
</dl>
|
|
12824
|
+
|
|
12825
|
+
|
|
12826
|
+
</dd>
|
|
12827
|
+
</dl>
|
|
12828
|
+
</details>
|
|
12829
|
+
|
|
12830
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">migrate</a>({ ...params }) -> Payabli.MigratePaypointResponse</code></summary>
|
|
12831
|
+
<dl>
|
|
12832
|
+
<dd>
|
|
12833
|
+
|
|
12834
|
+
#### 📝 Description
|
|
12835
|
+
|
|
12836
|
+
<dl>
|
|
12837
|
+
<dd>
|
|
12838
|
+
|
|
12839
|
+
<dl>
|
|
12840
|
+
<dd>
|
|
12841
|
+
|
|
12842
|
+
Migrates a paypoint to a new parent organization.
|
|
12843
|
+
</dd>
|
|
12844
|
+
</dl>
|
|
12845
|
+
</dd>
|
|
12846
|
+
</dl>
|
|
12847
|
+
|
|
12848
|
+
#### 🔌 Usage
|
|
12849
|
+
|
|
12850
|
+
<dl>
|
|
12851
|
+
<dd>
|
|
12852
|
+
|
|
12853
|
+
<dl>
|
|
12854
|
+
<dd>
|
|
12855
|
+
|
|
12856
|
+
```typescript
|
|
12857
|
+
await client.paypoint.migrate({
|
|
12858
|
+
entryPoint: "473abc123def",
|
|
12859
|
+
newParentOrganizationId: 123,
|
|
12860
|
+
notificationRequest: {
|
|
12861
|
+
notificationUrl: "https://webhook-test.yoursie.com",
|
|
12862
|
+
webHeaderParameters: [{
|
|
12863
|
+
key: "testheader",
|
|
12864
|
+
value: "1234567890"
|
|
12865
|
+
}]
|
|
12866
|
+
}
|
|
12867
|
+
});
|
|
12868
|
+
|
|
12869
|
+
```
|
|
12870
|
+
</dd>
|
|
12871
|
+
</dl>
|
|
12872
|
+
</dd>
|
|
12873
|
+
</dl>
|
|
12874
|
+
|
|
12875
|
+
#### ⚙️ Parameters
|
|
12876
|
+
|
|
12877
|
+
<dl>
|
|
12878
|
+
<dd>
|
|
12879
|
+
|
|
12880
|
+
<dl>
|
|
12881
|
+
<dd>
|
|
12882
|
+
|
|
12883
|
+
**request:** `Payabli.PaypointMoveRequest`
|
|
12884
|
+
|
|
12885
|
+
</dd>
|
|
12886
|
+
</dl>
|
|
12887
|
+
|
|
12888
|
+
<dl>
|
|
12889
|
+
<dd>
|
|
12890
|
+
|
|
12891
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12892
|
+
|
|
12893
|
+
</dd>
|
|
12894
|
+
</dl>
|
|
12895
|
+
</dd>
|
|
12896
|
+
</dl>
|
|
12897
|
+
|
|
12898
|
+
|
|
12899
|
+
</dd>
|
|
12900
|
+
</dl>
|
|
12901
|
+
</details>
|
|
12902
|
+
|
|
12903
|
+
## Query
|
|
12904
|
+
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listBatchDetails</a>(entry, { ...params }) -> Payabli.QueryBatchesDetailResponse</code></summary>
|
|
12446
12905
|
<dl>
|
|
12447
12906
|
<dd>
|
|
12448
12907
|
|
|
@@ -14089,6 +14548,156 @@ await client.query.listSubscriptionsOrg(123, {
|
|
|
14089
14548
|
</dl>
|
|
14090
14549
|
|
|
14091
14550
|
|
|
14551
|
+
</dd>
|
|
14552
|
+
</dl>
|
|
14553
|
+
</details>
|
|
14554
|
+
|
|
14555
|
+
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listPayoutSubscriptions</a>(entry, { ...params }) -> Payabli.QueryPayoutSubscriptionResponse</code></summary>
|
|
14556
|
+
<dl>
|
|
14557
|
+
<dd>
|
|
14558
|
+
|
|
14559
|
+
#### 📝 Description
|
|
14560
|
+
|
|
14561
|
+
<dl>
|
|
14562
|
+
<dd>
|
|
14563
|
+
|
|
14564
|
+
<dl>
|
|
14565
|
+
<dd>
|
|
14566
|
+
|
|
14567
|
+
Returns a list of payout subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
14568
|
+
</dd>
|
|
14569
|
+
</dl>
|
|
14570
|
+
</dd>
|
|
14571
|
+
</dl>
|
|
14572
|
+
|
|
14573
|
+
#### 🔌 Usage
|
|
14574
|
+
|
|
14575
|
+
<dl>
|
|
14576
|
+
<dd>
|
|
14577
|
+
|
|
14578
|
+
<dl>
|
|
14579
|
+
<dd>
|
|
14580
|
+
|
|
14581
|
+
```typescript
|
|
14582
|
+
await client.query.listPayoutSubscriptions("8cfec329267", {
|
|
14583
|
+
fromRecord: 0,
|
|
14584
|
+
limitRecord: 20,
|
|
14585
|
+
sortBy: "desc(field_name)"
|
|
14586
|
+
});
|
|
14587
|
+
|
|
14588
|
+
```
|
|
14589
|
+
</dd>
|
|
14590
|
+
</dl>
|
|
14591
|
+
</dd>
|
|
14592
|
+
</dl>
|
|
14593
|
+
|
|
14594
|
+
#### ⚙️ Parameters
|
|
14595
|
+
|
|
14596
|
+
<dl>
|
|
14597
|
+
<dd>
|
|
14598
|
+
|
|
14599
|
+
<dl>
|
|
14600
|
+
<dd>
|
|
14601
|
+
|
|
14602
|
+
**entry:** `Payabli.Entry`
|
|
14603
|
+
|
|
14604
|
+
</dd>
|
|
14605
|
+
</dl>
|
|
14606
|
+
|
|
14607
|
+
<dl>
|
|
14608
|
+
<dd>
|
|
14609
|
+
|
|
14610
|
+
**request:** `Payabli.ListPayoutSubscriptionsRequest`
|
|
14611
|
+
|
|
14612
|
+
</dd>
|
|
14613
|
+
</dl>
|
|
14614
|
+
|
|
14615
|
+
<dl>
|
|
14616
|
+
<dd>
|
|
14617
|
+
|
|
14618
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
14619
|
+
|
|
14620
|
+
</dd>
|
|
14621
|
+
</dl>
|
|
14622
|
+
</dd>
|
|
14623
|
+
</dl>
|
|
14624
|
+
|
|
14625
|
+
|
|
14626
|
+
</dd>
|
|
14627
|
+
</dl>
|
|
14628
|
+
</details>
|
|
14629
|
+
|
|
14630
|
+
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listPayoutSubscriptionsOrg</a>(orgId, { ...params }) -> Payabli.QueryPayoutSubscriptionResponse</code></summary>
|
|
14631
|
+
<dl>
|
|
14632
|
+
<dd>
|
|
14633
|
+
|
|
14634
|
+
#### 📝 Description
|
|
14635
|
+
|
|
14636
|
+
<dl>
|
|
14637
|
+
<dd>
|
|
14638
|
+
|
|
14639
|
+
<dl>
|
|
14640
|
+
<dd>
|
|
14641
|
+
|
|
14642
|
+
Returns a list of payout subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
14643
|
+
</dd>
|
|
14644
|
+
</dl>
|
|
14645
|
+
</dd>
|
|
14646
|
+
</dl>
|
|
14647
|
+
|
|
14648
|
+
#### 🔌 Usage
|
|
14649
|
+
|
|
14650
|
+
<dl>
|
|
14651
|
+
<dd>
|
|
14652
|
+
|
|
14653
|
+
<dl>
|
|
14654
|
+
<dd>
|
|
14655
|
+
|
|
14656
|
+
```typescript
|
|
14657
|
+
await client.query.listPayoutSubscriptionsOrg(123, {
|
|
14658
|
+
fromRecord: 0,
|
|
14659
|
+
limitRecord: 20,
|
|
14660
|
+
sortBy: "desc(field_name)"
|
|
14661
|
+
});
|
|
14662
|
+
|
|
14663
|
+
```
|
|
14664
|
+
</dd>
|
|
14665
|
+
</dl>
|
|
14666
|
+
</dd>
|
|
14667
|
+
</dl>
|
|
14668
|
+
|
|
14669
|
+
#### ⚙️ Parameters
|
|
14670
|
+
|
|
14671
|
+
<dl>
|
|
14672
|
+
<dd>
|
|
14673
|
+
|
|
14674
|
+
<dl>
|
|
14675
|
+
<dd>
|
|
14676
|
+
|
|
14677
|
+
**orgId:** `number` — The numeric identifier for organization, assigned by Payabli.
|
|
14678
|
+
|
|
14679
|
+
</dd>
|
|
14680
|
+
</dl>
|
|
14681
|
+
|
|
14682
|
+
<dl>
|
|
14683
|
+
<dd>
|
|
14684
|
+
|
|
14685
|
+
**request:** `Payabli.ListPayoutSubscriptionsOrgRequest`
|
|
14686
|
+
|
|
14687
|
+
</dd>
|
|
14688
|
+
</dl>
|
|
14689
|
+
|
|
14690
|
+
<dl>
|
|
14691
|
+
<dd>
|
|
14692
|
+
|
|
14693
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
14694
|
+
|
|
14695
|
+
</dd>
|
|
14696
|
+
</dl>
|
|
14697
|
+
</dd>
|
|
14698
|
+
</dl>
|
|
14699
|
+
|
|
14700
|
+
|
|
14092
14701
|
</dd>
|
|
14093
14702
|
</dl>
|
|
14094
14703
|
</details>
|
|
@@ -14108,9 +14717,8 @@ await client.query.listSubscriptionsOrg(123, {
|
|
|
14108
14717
|
Retrieve a list of transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
14109
14718
|
By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.
|
|
14110
14719
|
For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
14111
|
-
``` curl
|
|
14112
|
-
|
|
14113
|
-
--header 'requestToken: <api-key>'
|
|
14720
|
+
``` curl -X GET https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
|
|
14721
|
+
-H 'requestToken: <API TOKEN>'
|
|
14114
14722
|
|
|
14115
14723
|
```
|
|
14116
14724
|
</dd>
|
|
@@ -14197,9 +14805,8 @@ By default, this endpoint returns only transactions from the last 60 days. To qu
|
|
|
14197
14805
|
For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
14198
14806
|
|
|
14199
14807
|
```
|
|
14200
|
-
curl
|
|
14201
|
-
|
|
14202
|
-
--header 'requestToken: <api-key>'
|
|
14808
|
+
curl -X GET "https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59"\
|
|
14809
|
+
-H 'requestToken: <API TOKEN>'
|
|
14203
14810
|
|
|
14204
14811
|
```
|
|
14205
14812
|
</dd>
|