@payabli/sdk-node 0.0.134 → 0.0.136
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/README.md +13 -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 +67 -0
- package/dist/cjs/api/resources/ghostCard/client/Client.js +201 -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 +53 -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/NotificationStandardRequest.d.ts +0 -31
- package/dist/cjs/api/types/NotificationStandardRequest.js +0 -31
- 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 +67 -0
- package/dist/esm/api/resources/ghostCard/client/Client.mjs +164 -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 +53 -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/NotificationStandardRequest.d.mts +0 -31
- package/dist/esm/api/types/NotificationStandardRequest.mjs +0 -31
- 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 +682 -78
package/reference.md
CHANGED
|
@@ -5141,6 +5141,169 @@ 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
|
+
</dd>
|
|
5165
|
+
</dl>
|
|
5166
|
+
</dd>
|
|
5167
|
+
</dl>
|
|
5168
|
+
|
|
5169
|
+
#### 🔌 Usage
|
|
5170
|
+
|
|
5171
|
+
<dl>
|
|
5172
|
+
<dd>
|
|
5173
|
+
|
|
5174
|
+
<dl>
|
|
5175
|
+
<dd>
|
|
5176
|
+
|
|
5177
|
+
```typescript
|
|
5178
|
+
await client.ghostCard.createGhostCard("8cfec2e0fa", {
|
|
5179
|
+
vendorId: 42,
|
|
5180
|
+
expenseLimit: 500,
|
|
5181
|
+
maxNumberOfUses: 3,
|
|
5182
|
+
exactAmount: false,
|
|
5183
|
+
expenseLimitPeriod: "monthly",
|
|
5184
|
+
billingCycle: "monthly",
|
|
5185
|
+
billingCycleDay: "1",
|
|
5186
|
+
dailyTransactionCount: 5,
|
|
5187
|
+
dailyAmountLimit: 200,
|
|
5188
|
+
transactionAmountLimit: 100,
|
|
5189
|
+
mcc: "5411",
|
|
5190
|
+
tcc: "R",
|
|
5191
|
+
misc1: "PO-98765",
|
|
5192
|
+
misc2: "Dept-Finance"
|
|
5193
|
+
});
|
|
5194
|
+
|
|
5195
|
+
```
|
|
5196
|
+
</dd>
|
|
5197
|
+
</dl>
|
|
5198
|
+
</dd>
|
|
5199
|
+
</dl>
|
|
5200
|
+
|
|
5201
|
+
#### ⚙️ Parameters
|
|
5202
|
+
|
|
5203
|
+
<dl>
|
|
5204
|
+
<dd>
|
|
5205
|
+
|
|
5206
|
+
<dl>
|
|
5207
|
+
<dd>
|
|
5208
|
+
|
|
5209
|
+
**entry:** `Payabli.Entry`
|
|
5210
|
+
|
|
5211
|
+
</dd>
|
|
5212
|
+
</dl>
|
|
5213
|
+
|
|
5214
|
+
<dl>
|
|
5215
|
+
<dd>
|
|
5216
|
+
|
|
5217
|
+
**request:** `Payabli.CreateGhostCardRequestBody`
|
|
5218
|
+
|
|
5219
|
+
</dd>
|
|
5220
|
+
</dl>
|
|
5221
|
+
|
|
5222
|
+
<dl>
|
|
5223
|
+
<dd>
|
|
5224
|
+
|
|
5225
|
+
**requestOptions:** `GhostCardClient.RequestOptions`
|
|
5226
|
+
|
|
5227
|
+
</dd>
|
|
5228
|
+
</dl>
|
|
5229
|
+
</dd>
|
|
5230
|
+
</dl>
|
|
5231
|
+
|
|
5232
|
+
|
|
5233
|
+
</dd>
|
|
5234
|
+
</dl>
|
|
5235
|
+
</details>
|
|
5236
|
+
|
|
5237
|
+
<details><summary><code>client.ghostCard.<a href="/src/api/resources/ghostCard/client/Client.ts">updateCard</a>(entry, { ...params }) -> Payabli.PayabliApiResponse</code></summary>
|
|
5238
|
+
<dl>
|
|
5239
|
+
<dd>
|
|
5240
|
+
|
|
5241
|
+
#### 📝 Description
|
|
5242
|
+
|
|
5243
|
+
<dl>
|
|
5244
|
+
<dd>
|
|
5245
|
+
|
|
5246
|
+
<dl>
|
|
5247
|
+
<dd>
|
|
5248
|
+
|
|
5249
|
+
Updates the status of a virtual card (including ghost cards) under a paypoint.
|
|
5250
|
+
</dd>
|
|
5251
|
+
</dl>
|
|
5252
|
+
</dd>
|
|
5253
|
+
</dl>
|
|
5254
|
+
|
|
5255
|
+
#### 🔌 Usage
|
|
5256
|
+
|
|
5257
|
+
<dl>
|
|
5258
|
+
<dd>
|
|
5259
|
+
|
|
5260
|
+
<dl>
|
|
5261
|
+
<dd>
|
|
5262
|
+
|
|
5263
|
+
```typescript
|
|
5264
|
+
await client.ghostCard.updateCard("8cfec2e0fa", {
|
|
5265
|
+
cardToken: "gc_abc123def456",
|
|
5266
|
+
status: "Cancelled"
|
|
5267
|
+
});
|
|
5268
|
+
|
|
5269
|
+
```
|
|
5270
|
+
</dd>
|
|
5271
|
+
</dl>
|
|
5272
|
+
</dd>
|
|
5273
|
+
</dl>
|
|
5274
|
+
|
|
5275
|
+
#### ⚙️ Parameters
|
|
5276
|
+
|
|
5277
|
+
<dl>
|
|
5278
|
+
<dd>
|
|
5279
|
+
|
|
5280
|
+
<dl>
|
|
5281
|
+
<dd>
|
|
5282
|
+
|
|
5283
|
+
**entry:** `Payabli.Entry`
|
|
5284
|
+
|
|
5285
|
+
</dd>
|
|
5286
|
+
</dl>
|
|
5287
|
+
|
|
5288
|
+
<dl>
|
|
5289
|
+
<dd>
|
|
5290
|
+
|
|
5291
|
+
**request:** `Payabli.UpdateCardRequestBody`
|
|
5292
|
+
|
|
5293
|
+
</dd>
|
|
5294
|
+
</dl>
|
|
5295
|
+
|
|
5296
|
+
<dl>
|
|
5297
|
+
<dd>
|
|
5298
|
+
|
|
5299
|
+
**requestOptions:** `GhostCardClient.RequestOptions`
|
|
5300
|
+
|
|
5301
|
+
</dd>
|
|
5302
|
+
</dl>
|
|
5303
|
+
</dd>
|
|
5304
|
+
</dl>
|
|
5305
|
+
|
|
5306
|
+
|
|
5144
5307
|
</dd>
|
|
5145
5308
|
</dl>
|
|
5146
5309
|
</details>
|
|
@@ -11894,8 +12057,8 @@ await client.paymentMethodDomain.verifyPaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
11894
12057
|
</dl>
|
|
11895
12058
|
</details>
|
|
11896
12059
|
|
|
11897
|
-
##
|
|
11898
|
-
<details><summary><code>client.
|
|
12060
|
+
## PayoutSubscription
|
|
12061
|
+
<details><summary><code>client.payoutSubscription.<a href="/src/api/resources/payoutSubscription/client/Client.ts">createPayoutSubscription</a>({ ...params }) -> Payabli.AddPayoutSubscriptionResponse</code></summary>
|
|
11899
12062
|
<dl>
|
|
11900
12063
|
<dd>
|
|
11901
12064
|
|
|
@@ -11907,7 +12070,7 @@ await client.paymentMethodDomain.verifyPaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
11907
12070
|
<dl>
|
|
11908
12071
|
<dd>
|
|
11909
12072
|
|
|
11910
|
-
|
|
12073
|
+
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
12074
|
</dd>
|
|
11912
12075
|
</dl>
|
|
11913
12076
|
</dd>
|
|
@@ -11922,7 +12085,37 @@ Gets the basic details for a paypoint.
|
|
|
11922
12085
|
<dd>
|
|
11923
12086
|
|
|
11924
12087
|
```typescript
|
|
11925
|
-
await client.
|
|
12088
|
+
await client.payoutSubscription.createPayoutSubscription({
|
|
12089
|
+
body: {
|
|
12090
|
+
entryPoint: "d193cf9a46",
|
|
12091
|
+
paymentMethod: {
|
|
12092
|
+
method: "ach",
|
|
12093
|
+
achHolder: "Herman Coatings",
|
|
12094
|
+
achRouting: "021000021",
|
|
12095
|
+
achAccount: "3453445666",
|
|
12096
|
+
achAccountType: "checking"
|
|
12097
|
+
},
|
|
12098
|
+
paymentDetails: {
|
|
12099
|
+
totalAmount: 500,
|
|
12100
|
+
serviceFee: 0,
|
|
12101
|
+
currency: "USD"
|
|
12102
|
+
},
|
|
12103
|
+
vendorData: {
|
|
12104
|
+
vendorId: 1501
|
|
12105
|
+
},
|
|
12106
|
+
billData: [{
|
|
12107
|
+
invoiceNumber: "INV-5001",
|
|
12108
|
+
netAmount: "500",
|
|
12109
|
+
invoiceDate: "2025-08-01",
|
|
12110
|
+
dueDate: "2025-08-15"
|
|
12111
|
+
}],
|
|
12112
|
+
scheduleDetails: {
|
|
12113
|
+
startDate: "09/01/2025",
|
|
12114
|
+
endDate: "09/01/2026",
|
|
12115
|
+
frequency: "monthly"
|
|
12116
|
+
}
|
|
12117
|
+
}
|
|
12118
|
+
});
|
|
11926
12119
|
|
|
11927
12120
|
```
|
|
11928
12121
|
</dd>
|
|
@@ -11938,7 +12131,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11938
12131
|
<dl>
|
|
11939
12132
|
<dd>
|
|
11940
12133
|
|
|
11941
|
-
**
|
|
12134
|
+
**request:** `Payabli.RequestPayoutSchedule`
|
|
11942
12135
|
|
|
11943
12136
|
</dd>
|
|
11944
12137
|
</dl>
|
|
@@ -11946,7 +12139,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11946
12139
|
<dl>
|
|
11947
12140
|
<dd>
|
|
11948
12141
|
|
|
11949
|
-
**requestOptions:** `
|
|
12142
|
+
**requestOptions:** `PayoutSubscriptionClient.RequestOptions`
|
|
11950
12143
|
|
|
11951
12144
|
</dd>
|
|
11952
12145
|
</dl>
|
|
@@ -11958,7 +12151,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11958
12151
|
</dl>
|
|
11959
12152
|
</details>
|
|
11960
12153
|
|
|
11961
|
-
<details><summary><code>client.
|
|
12154
|
+
<details><summary><code>client.payoutSubscription.<a href="/src/api/resources/payoutSubscription/client/Client.ts">getPayoutSubscription</a>(id) -> Payabli.GetPayoutSubscriptionResponse</code></summary>
|
|
11962
12155
|
<dl>
|
|
11963
12156
|
<dd>
|
|
11964
12157
|
|
|
@@ -11970,7 +12163,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11970
12163
|
<dl>
|
|
11971
12164
|
<dd>
|
|
11972
12165
|
|
|
11973
|
-
Retrieves
|
|
12166
|
+
Retrieves a single payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
11974
12167
|
</dd>
|
|
11975
12168
|
</dl>
|
|
11976
12169
|
</dd>
|
|
@@ -11985,7 +12178,7 @@ Retrieves the basic details for a paypoint by ID.
|
|
|
11985
12178
|
<dd>
|
|
11986
12179
|
|
|
11987
12180
|
```typescript
|
|
11988
|
-
await client.
|
|
12181
|
+
await client.payoutSubscription.getPayoutSubscription(42);
|
|
11989
12182
|
|
|
11990
12183
|
```
|
|
11991
12184
|
</dd>
|
|
@@ -12001,7 +12194,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
12001
12194
|
<dl>
|
|
12002
12195
|
<dd>
|
|
12003
12196
|
|
|
12004
|
-
**
|
|
12197
|
+
**id:** `number` — The payout subscription ID.
|
|
12005
12198
|
|
|
12006
12199
|
</dd>
|
|
12007
12200
|
</dl>
|
|
@@ -12009,7 +12202,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
12009
12202
|
<dl>
|
|
12010
12203
|
<dd>
|
|
12011
12204
|
|
|
12012
|
-
**requestOptions:** `
|
|
12205
|
+
**requestOptions:** `PayoutSubscriptionClient.RequestOptions`
|
|
12013
12206
|
|
|
12014
12207
|
</dd>
|
|
12015
12208
|
</dl>
|
|
@@ -12021,7 +12214,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
12021
12214
|
</dl>
|
|
12022
12215
|
</details>
|
|
12023
12216
|
|
|
12024
|
-
<details><summary><code>client.
|
|
12217
|
+
<details><summary><code>client.payoutSubscription.<a href="/src/api/resources/payoutSubscription/client/Client.ts">updatePayoutSubscription</a>(id, { ...params }) -> Payabli.UpdatePayoutSubscriptionResponse</code></summary>
|
|
12025
12218
|
<dl>
|
|
12026
12219
|
<dd>
|
|
12027
12220
|
|
|
@@ -12033,7 +12226,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
12033
12226
|
<dl>
|
|
12034
12227
|
<dd>
|
|
12035
12228
|
|
|
12036
|
-
|
|
12229
|
+
Updates a payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
12037
12230
|
</dd>
|
|
12038
12231
|
</dl>
|
|
12039
12232
|
</dd>
|
|
@@ -12048,7 +12241,9 @@ Gets the details for a single paypoint.
|
|
|
12048
12241
|
<dd>
|
|
12049
12242
|
|
|
12050
12243
|
```typescript
|
|
12051
|
-
await client.
|
|
12244
|
+
await client.payoutSubscription.updatePayoutSubscription(42, {
|
|
12245
|
+
setPause: true
|
|
12246
|
+
});
|
|
12052
12247
|
|
|
12053
12248
|
```
|
|
12054
12249
|
</dd>
|
|
@@ -12064,7 +12259,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12064
12259
|
<dl>
|
|
12065
12260
|
<dd>
|
|
12066
12261
|
|
|
12067
|
-
**
|
|
12262
|
+
**id:** `number` — The payout subscription ID.
|
|
12068
12263
|
|
|
12069
12264
|
</dd>
|
|
12070
12265
|
</dl>
|
|
@@ -12072,7 +12267,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12072
12267
|
<dl>
|
|
12073
12268
|
<dd>
|
|
12074
12269
|
|
|
12075
|
-
**request:** `Payabli.
|
|
12270
|
+
**request:** `Payabli.UpdatePayoutSubscriptionBody`
|
|
12076
12271
|
|
|
12077
12272
|
</dd>
|
|
12078
12273
|
</dl>
|
|
@@ -12080,7 +12275,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12080
12275
|
<dl>
|
|
12081
12276
|
<dd>
|
|
12082
12277
|
|
|
12083
|
-
**requestOptions:** `
|
|
12278
|
+
**requestOptions:** `PayoutSubscriptionClient.RequestOptions`
|
|
12084
12279
|
|
|
12085
12280
|
</dd>
|
|
12086
12281
|
</dl>
|
|
@@ -12092,7 +12287,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12092
12287
|
</dl>
|
|
12093
12288
|
</details>
|
|
12094
12289
|
|
|
12095
|
-
<details><summary><code>client.
|
|
12290
|
+
<details><summary><code>client.payoutSubscription.<a href="/src/api/resources/payoutSubscription/client/Client.ts">deletePayoutSubscription</a>(id) -> Payabli.DeletePayoutSubscriptionResponse</code></summary>
|
|
12096
12291
|
<dl>
|
|
12097
12292
|
<dd>
|
|
12098
12293
|
|
|
@@ -12104,7 +12299,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
12104
12299
|
<dl>
|
|
12105
12300
|
<dd>
|
|
12106
12301
|
|
|
12107
|
-
|
|
12302
|
+
Deletes a payout subscription and prevents future payouts. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
12108
12303
|
</dd>
|
|
12109
12304
|
</dl>
|
|
12110
12305
|
</dd>
|
|
@@ -12119,7 +12314,7 @@ Gets the details for single payment page for a paypoint.
|
|
|
12119
12314
|
<dd>
|
|
12120
12315
|
|
|
12121
12316
|
```typescript
|
|
12122
|
-
await client.
|
|
12317
|
+
await client.payoutSubscription.deletePayoutSubscription(42);
|
|
12123
12318
|
|
|
12124
12319
|
```
|
|
12125
12320
|
</dd>
|
|
@@ -12135,15 +12330,7 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
12135
12330
|
<dl>
|
|
12136
12331
|
<dd>
|
|
12137
12332
|
|
|
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`.
|
|
12333
|
+
**id:** `number` — The payout subscription ID.
|
|
12147
12334
|
|
|
12148
12335
|
</dd>
|
|
12149
12336
|
</dl>
|
|
@@ -12151,7 +12338,7 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
12151
12338
|
<dl>
|
|
12152
12339
|
<dd>
|
|
12153
12340
|
|
|
12154
|
-
**requestOptions:** `
|
|
12341
|
+
**requestOptions:** `PayoutSubscriptionClient.RequestOptions`
|
|
12155
12342
|
|
|
12156
12343
|
</dd>
|
|
12157
12344
|
</dl>
|
|
@@ -12163,7 +12350,8 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
12163
12350
|
</dl>
|
|
12164
12351
|
</details>
|
|
12165
12352
|
|
|
12166
|
-
|
|
12353
|
+
## Paypoint
|
|
12354
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getBasicEntry</a>(entry) -> Payabli.GetBasicEntryResponse</code></summary>
|
|
12167
12355
|
<dl>
|
|
12168
12356
|
<dd>
|
|
12169
12357
|
|
|
@@ -12175,7 +12363,7 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
12175
12363
|
<dl>
|
|
12176
12364
|
<dd>
|
|
12177
12365
|
|
|
12178
|
-
|
|
12366
|
+
Gets the basic details for a paypoint.
|
|
12179
12367
|
</dd>
|
|
12180
12368
|
</dl>
|
|
12181
12369
|
</dd>
|
|
@@ -12190,7 +12378,7 @@ Deletes a payment page in a paypoint.
|
|
|
12190
12378
|
<dd>
|
|
12191
12379
|
|
|
12192
12380
|
```typescript
|
|
12193
|
-
await client.paypoint.
|
|
12381
|
+
await client.paypoint.getBasicEntry("8cfec329267");
|
|
12194
12382
|
|
|
12195
12383
|
```
|
|
12196
12384
|
</dd>
|
|
@@ -12214,14 +12402,6 @@ await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
|
12214
12402
|
<dl>
|
|
12215
12403
|
<dd>
|
|
12216
12404
|
|
|
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
12405
|
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12226
12406
|
|
|
12227
12407
|
</dd>
|
|
@@ -12234,7 +12414,7 @@ await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
|
12234
12414
|
</dl>
|
|
12235
12415
|
</details>
|
|
12236
12416
|
|
|
12237
|
-
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">
|
|
12417
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getBasicEntryById</a>(IdPaypoint) -> Payabli.GetBasicEntryByIdResponse</code></summary>
|
|
12238
12418
|
<dl>
|
|
12239
12419
|
<dd>
|
|
12240
12420
|
|
|
@@ -12246,7 +12426,7 @@ await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
|
12246
12426
|
<dl>
|
|
12247
12427
|
<dd>
|
|
12248
12428
|
|
|
12249
|
-
|
|
12429
|
+
Retrieves the basic details for a paypoint by ID.
|
|
12250
12430
|
</dd>
|
|
12251
12431
|
</dl>
|
|
12252
12432
|
</dd>
|
|
@@ -12261,7 +12441,7 @@ Updates a paypoint logo.
|
|
|
12261
12441
|
<dd>
|
|
12262
12442
|
|
|
12263
12443
|
```typescript
|
|
12264
|
-
await client.paypoint.
|
|
12444
|
+
await client.paypoint.getBasicEntryById("198");
|
|
12265
12445
|
|
|
12266
12446
|
```
|
|
12267
12447
|
</dd>
|
|
@@ -12277,15 +12457,7 @@ await client.paypoint.saveLogo("8cfec329267", {});
|
|
|
12277
12457
|
<dl>
|
|
12278
12458
|
<dd>
|
|
12279
12459
|
|
|
12280
|
-
**
|
|
12281
|
-
|
|
12282
|
-
</dd>
|
|
12283
|
-
</dl>
|
|
12284
|
-
|
|
12285
|
-
<dl>
|
|
12286
|
-
<dd>
|
|
12287
|
-
|
|
12288
|
-
**request:** `Payabli.FileContent`
|
|
12460
|
+
**IdPaypoint:** `string` — Paypoint ID. You can find this value by querying `/api/Query/paypoints/{orgId}`
|
|
12289
12461
|
|
|
12290
12462
|
</dd>
|
|
12291
12463
|
</dl>
|
|
@@ -12305,7 +12477,7 @@ await client.paypoint.saveLogo("8cfec329267", {});
|
|
|
12305
12477
|
</dl>
|
|
12306
12478
|
</details>
|
|
12307
12479
|
|
|
12308
|
-
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">
|
|
12480
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getEntryConfig</a>(entry, { ...params }) -> Payabli.GetEntryConfigResponse</code></summary>
|
|
12309
12481
|
<dl>
|
|
12310
12482
|
<dd>
|
|
12311
12483
|
|
|
@@ -12317,7 +12489,7 @@ await client.paypoint.saveLogo("8cfec329267", {});
|
|
|
12317
12489
|
<dl>
|
|
12318
12490
|
<dd>
|
|
12319
12491
|
|
|
12320
|
-
|
|
12492
|
+
Gets the details for a single paypoint.
|
|
12321
12493
|
</dd>
|
|
12322
12494
|
</dl>
|
|
12323
12495
|
</dd>
|
|
@@ -12332,7 +12504,7 @@ Retrieves an paypoint's basic settings like custom fields, identifiers, and invo
|
|
|
12332
12504
|
<dd>
|
|
12333
12505
|
|
|
12334
12506
|
```typescript
|
|
12335
|
-
await client.paypoint.
|
|
12507
|
+
await client.paypoint.getEntryConfig("8cfec329267");
|
|
12336
12508
|
|
|
12337
12509
|
```
|
|
12338
12510
|
</dd>
|
|
@@ -12356,6 +12528,14 @@ await client.paypoint.settingsPage("8cfec329267");
|
|
|
12356
12528
|
<dl>
|
|
12357
12529
|
<dd>
|
|
12358
12530
|
|
|
12531
|
+
**request:** `Payabli.GetEntryConfigRequest`
|
|
12532
|
+
|
|
12533
|
+
</dd>
|
|
12534
|
+
</dl>
|
|
12535
|
+
|
|
12536
|
+
<dl>
|
|
12537
|
+
<dd>
|
|
12538
|
+
|
|
12359
12539
|
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12360
12540
|
|
|
12361
12541
|
</dd>
|
|
@@ -12368,7 +12548,7 @@ await client.paypoint.settingsPage("8cfec329267");
|
|
|
12368
12548
|
</dl>
|
|
12369
12549
|
</details>
|
|
12370
12550
|
|
|
12371
|
-
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">
|
|
12551
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getPage</a>(entry, subdomain) -> Payabli.PayabliPages</code></summary>
|
|
12372
12552
|
<dl>
|
|
12373
12553
|
<dd>
|
|
12374
12554
|
|
|
@@ -12380,7 +12560,7 @@ await client.paypoint.settingsPage("8cfec329267");
|
|
|
12380
12560
|
<dl>
|
|
12381
12561
|
<dd>
|
|
12382
12562
|
|
|
12383
|
-
|
|
12563
|
+
Gets the details for single payment page for a paypoint.
|
|
12384
12564
|
</dd>
|
|
12385
12565
|
</dl>
|
|
12386
12566
|
</dd>
|
|
@@ -12395,17 +12575,7 @@ Migrates a paypoint to a new parent organization.
|
|
|
12395
12575
|
<dd>
|
|
12396
12576
|
|
|
12397
12577
|
```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
|
-
});
|
|
12578
|
+
await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
12409
12579
|
|
|
12410
12580
|
```
|
|
12411
12581
|
</dd>
|
|
@@ -12421,7 +12591,15 @@ await client.paypoint.migrate({
|
|
|
12421
12591
|
<dl>
|
|
12422
12592
|
<dd>
|
|
12423
12593
|
|
|
12424
|
-
**
|
|
12594
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
12595
|
+
|
|
12596
|
+
</dd>
|
|
12597
|
+
</dl>
|
|
12598
|
+
|
|
12599
|
+
<dl>
|
|
12600
|
+
<dd>
|
|
12601
|
+
|
|
12602
|
+
**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
12603
|
|
|
12426
12604
|
</dd>
|
|
12427
12605
|
</dl>
|
|
@@ -12441,8 +12619,286 @@ await client.paypoint.migrate({
|
|
|
12441
12619
|
</dl>
|
|
12442
12620
|
</details>
|
|
12443
12621
|
|
|
12444
|
-
|
|
12445
|
-
<
|
|
12622
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">removePage</a>(entry, subdomain) -> Payabli.PayabliApiResponseGeneric2Part</code></summary>
|
|
12623
|
+
<dl>
|
|
12624
|
+
<dd>
|
|
12625
|
+
|
|
12626
|
+
#### 📝 Description
|
|
12627
|
+
|
|
12628
|
+
<dl>
|
|
12629
|
+
<dd>
|
|
12630
|
+
|
|
12631
|
+
<dl>
|
|
12632
|
+
<dd>
|
|
12633
|
+
|
|
12634
|
+
Deletes a payment page in a paypoint.
|
|
12635
|
+
</dd>
|
|
12636
|
+
</dl>
|
|
12637
|
+
</dd>
|
|
12638
|
+
</dl>
|
|
12639
|
+
|
|
12640
|
+
#### 🔌 Usage
|
|
12641
|
+
|
|
12642
|
+
<dl>
|
|
12643
|
+
<dd>
|
|
12644
|
+
|
|
12645
|
+
<dl>
|
|
12646
|
+
<dd>
|
|
12647
|
+
|
|
12648
|
+
```typescript
|
|
12649
|
+
await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
12650
|
+
|
|
12651
|
+
```
|
|
12652
|
+
</dd>
|
|
12653
|
+
</dl>
|
|
12654
|
+
</dd>
|
|
12655
|
+
</dl>
|
|
12656
|
+
|
|
12657
|
+
#### ⚙️ Parameters
|
|
12658
|
+
|
|
12659
|
+
<dl>
|
|
12660
|
+
<dd>
|
|
12661
|
+
|
|
12662
|
+
<dl>
|
|
12663
|
+
<dd>
|
|
12664
|
+
|
|
12665
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
12666
|
+
|
|
12667
|
+
</dd>
|
|
12668
|
+
</dl>
|
|
12669
|
+
|
|
12670
|
+
<dl>
|
|
12671
|
+
<dd>
|
|
12672
|
+
|
|
12673
|
+
**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`.
|
|
12674
|
+
|
|
12675
|
+
</dd>
|
|
12676
|
+
</dl>
|
|
12677
|
+
|
|
12678
|
+
<dl>
|
|
12679
|
+
<dd>
|
|
12680
|
+
|
|
12681
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12682
|
+
|
|
12683
|
+
</dd>
|
|
12684
|
+
</dl>
|
|
12685
|
+
</dd>
|
|
12686
|
+
</dl>
|
|
12687
|
+
|
|
12688
|
+
|
|
12689
|
+
</dd>
|
|
12690
|
+
</dl>
|
|
12691
|
+
</details>
|
|
12692
|
+
|
|
12693
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">saveLogo</a>(entry, { ...params }) -> Payabli.PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
12694
|
+
<dl>
|
|
12695
|
+
<dd>
|
|
12696
|
+
|
|
12697
|
+
#### 📝 Description
|
|
12698
|
+
|
|
12699
|
+
<dl>
|
|
12700
|
+
<dd>
|
|
12701
|
+
|
|
12702
|
+
<dl>
|
|
12703
|
+
<dd>
|
|
12704
|
+
|
|
12705
|
+
Updates a paypoint logo.
|
|
12706
|
+
</dd>
|
|
12707
|
+
</dl>
|
|
12708
|
+
</dd>
|
|
12709
|
+
</dl>
|
|
12710
|
+
|
|
12711
|
+
#### 🔌 Usage
|
|
12712
|
+
|
|
12713
|
+
<dl>
|
|
12714
|
+
<dd>
|
|
12715
|
+
|
|
12716
|
+
<dl>
|
|
12717
|
+
<dd>
|
|
12718
|
+
|
|
12719
|
+
```typescript
|
|
12720
|
+
await client.paypoint.saveLogo("8cfec329267", {});
|
|
12721
|
+
|
|
12722
|
+
```
|
|
12723
|
+
</dd>
|
|
12724
|
+
</dl>
|
|
12725
|
+
</dd>
|
|
12726
|
+
</dl>
|
|
12727
|
+
|
|
12728
|
+
#### ⚙️ Parameters
|
|
12729
|
+
|
|
12730
|
+
<dl>
|
|
12731
|
+
<dd>
|
|
12732
|
+
|
|
12733
|
+
<dl>
|
|
12734
|
+
<dd>
|
|
12735
|
+
|
|
12736
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
12737
|
+
|
|
12738
|
+
</dd>
|
|
12739
|
+
</dl>
|
|
12740
|
+
|
|
12741
|
+
<dl>
|
|
12742
|
+
<dd>
|
|
12743
|
+
|
|
12744
|
+
**request:** `Payabli.FileContent`
|
|
12745
|
+
|
|
12746
|
+
</dd>
|
|
12747
|
+
</dl>
|
|
12748
|
+
|
|
12749
|
+
<dl>
|
|
12750
|
+
<dd>
|
|
12751
|
+
|
|
12752
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12753
|
+
|
|
12754
|
+
</dd>
|
|
12755
|
+
</dl>
|
|
12756
|
+
</dd>
|
|
12757
|
+
</dl>
|
|
12758
|
+
|
|
12759
|
+
|
|
12760
|
+
</dd>
|
|
12761
|
+
</dl>
|
|
12762
|
+
</details>
|
|
12763
|
+
|
|
12764
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">settingsPage</a>(entry) -> Payabli.SettingsQueryRecord</code></summary>
|
|
12765
|
+
<dl>
|
|
12766
|
+
<dd>
|
|
12767
|
+
|
|
12768
|
+
#### 📝 Description
|
|
12769
|
+
|
|
12770
|
+
<dl>
|
|
12771
|
+
<dd>
|
|
12772
|
+
|
|
12773
|
+
<dl>
|
|
12774
|
+
<dd>
|
|
12775
|
+
|
|
12776
|
+
Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.
|
|
12777
|
+
</dd>
|
|
12778
|
+
</dl>
|
|
12779
|
+
</dd>
|
|
12780
|
+
</dl>
|
|
12781
|
+
|
|
12782
|
+
#### 🔌 Usage
|
|
12783
|
+
|
|
12784
|
+
<dl>
|
|
12785
|
+
<dd>
|
|
12786
|
+
|
|
12787
|
+
<dl>
|
|
12788
|
+
<dd>
|
|
12789
|
+
|
|
12790
|
+
```typescript
|
|
12791
|
+
await client.paypoint.settingsPage("8cfec329267");
|
|
12792
|
+
|
|
12793
|
+
```
|
|
12794
|
+
</dd>
|
|
12795
|
+
</dl>
|
|
12796
|
+
</dd>
|
|
12797
|
+
</dl>
|
|
12798
|
+
|
|
12799
|
+
#### ⚙️ Parameters
|
|
12800
|
+
|
|
12801
|
+
<dl>
|
|
12802
|
+
<dd>
|
|
12803
|
+
|
|
12804
|
+
<dl>
|
|
12805
|
+
<dd>
|
|
12806
|
+
|
|
12807
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
12808
|
+
|
|
12809
|
+
</dd>
|
|
12810
|
+
</dl>
|
|
12811
|
+
|
|
12812
|
+
<dl>
|
|
12813
|
+
<dd>
|
|
12814
|
+
|
|
12815
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12816
|
+
|
|
12817
|
+
</dd>
|
|
12818
|
+
</dl>
|
|
12819
|
+
</dd>
|
|
12820
|
+
</dl>
|
|
12821
|
+
|
|
12822
|
+
|
|
12823
|
+
</dd>
|
|
12824
|
+
</dl>
|
|
12825
|
+
</details>
|
|
12826
|
+
|
|
12827
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">migrate</a>({ ...params }) -> Payabli.MigratePaypointResponse</code></summary>
|
|
12828
|
+
<dl>
|
|
12829
|
+
<dd>
|
|
12830
|
+
|
|
12831
|
+
#### 📝 Description
|
|
12832
|
+
|
|
12833
|
+
<dl>
|
|
12834
|
+
<dd>
|
|
12835
|
+
|
|
12836
|
+
<dl>
|
|
12837
|
+
<dd>
|
|
12838
|
+
|
|
12839
|
+
Migrates a paypoint to a new parent organization.
|
|
12840
|
+
</dd>
|
|
12841
|
+
</dl>
|
|
12842
|
+
</dd>
|
|
12843
|
+
</dl>
|
|
12844
|
+
|
|
12845
|
+
#### 🔌 Usage
|
|
12846
|
+
|
|
12847
|
+
<dl>
|
|
12848
|
+
<dd>
|
|
12849
|
+
|
|
12850
|
+
<dl>
|
|
12851
|
+
<dd>
|
|
12852
|
+
|
|
12853
|
+
```typescript
|
|
12854
|
+
await client.paypoint.migrate({
|
|
12855
|
+
entryPoint: "473abc123def",
|
|
12856
|
+
newParentOrganizationId: 123,
|
|
12857
|
+
notificationRequest: {
|
|
12858
|
+
notificationUrl: "https://webhook-test.yoursie.com",
|
|
12859
|
+
webHeaderParameters: [{
|
|
12860
|
+
key: "testheader",
|
|
12861
|
+
value: "1234567890"
|
|
12862
|
+
}]
|
|
12863
|
+
}
|
|
12864
|
+
});
|
|
12865
|
+
|
|
12866
|
+
```
|
|
12867
|
+
</dd>
|
|
12868
|
+
</dl>
|
|
12869
|
+
</dd>
|
|
12870
|
+
</dl>
|
|
12871
|
+
|
|
12872
|
+
#### ⚙️ Parameters
|
|
12873
|
+
|
|
12874
|
+
<dl>
|
|
12875
|
+
<dd>
|
|
12876
|
+
|
|
12877
|
+
<dl>
|
|
12878
|
+
<dd>
|
|
12879
|
+
|
|
12880
|
+
**request:** `Payabli.PaypointMoveRequest`
|
|
12881
|
+
|
|
12882
|
+
</dd>
|
|
12883
|
+
</dl>
|
|
12884
|
+
|
|
12885
|
+
<dl>
|
|
12886
|
+
<dd>
|
|
12887
|
+
|
|
12888
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
12889
|
+
|
|
12890
|
+
</dd>
|
|
12891
|
+
</dl>
|
|
12892
|
+
</dd>
|
|
12893
|
+
</dl>
|
|
12894
|
+
|
|
12895
|
+
|
|
12896
|
+
</dd>
|
|
12897
|
+
</dl>
|
|
12898
|
+
</details>
|
|
12899
|
+
|
|
12900
|
+
## Query
|
|
12901
|
+
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listBatchDetails</a>(entry, { ...params }) -> Payabli.QueryBatchesDetailResponse</code></summary>
|
|
12446
12902
|
<dl>
|
|
12447
12903
|
<dd>
|
|
12448
12904
|
|
|
@@ -14089,6 +14545,156 @@ await client.query.listSubscriptionsOrg(123, {
|
|
|
14089
14545
|
</dl>
|
|
14090
14546
|
|
|
14091
14547
|
|
|
14548
|
+
</dd>
|
|
14549
|
+
</dl>
|
|
14550
|
+
</details>
|
|
14551
|
+
|
|
14552
|
+
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listPayoutSubscriptions</a>(entry, { ...params }) -> Payabli.QueryPayoutSubscriptionResponse</code></summary>
|
|
14553
|
+
<dl>
|
|
14554
|
+
<dd>
|
|
14555
|
+
|
|
14556
|
+
#### 📝 Description
|
|
14557
|
+
|
|
14558
|
+
<dl>
|
|
14559
|
+
<dd>
|
|
14560
|
+
|
|
14561
|
+
<dl>
|
|
14562
|
+
<dd>
|
|
14563
|
+
|
|
14564
|
+
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.
|
|
14565
|
+
</dd>
|
|
14566
|
+
</dl>
|
|
14567
|
+
</dd>
|
|
14568
|
+
</dl>
|
|
14569
|
+
|
|
14570
|
+
#### 🔌 Usage
|
|
14571
|
+
|
|
14572
|
+
<dl>
|
|
14573
|
+
<dd>
|
|
14574
|
+
|
|
14575
|
+
<dl>
|
|
14576
|
+
<dd>
|
|
14577
|
+
|
|
14578
|
+
```typescript
|
|
14579
|
+
await client.query.listPayoutSubscriptions("8cfec329267", {
|
|
14580
|
+
fromRecord: 0,
|
|
14581
|
+
limitRecord: 20,
|
|
14582
|
+
sortBy: "desc(field_name)"
|
|
14583
|
+
});
|
|
14584
|
+
|
|
14585
|
+
```
|
|
14586
|
+
</dd>
|
|
14587
|
+
</dl>
|
|
14588
|
+
</dd>
|
|
14589
|
+
</dl>
|
|
14590
|
+
|
|
14591
|
+
#### ⚙️ Parameters
|
|
14592
|
+
|
|
14593
|
+
<dl>
|
|
14594
|
+
<dd>
|
|
14595
|
+
|
|
14596
|
+
<dl>
|
|
14597
|
+
<dd>
|
|
14598
|
+
|
|
14599
|
+
**entry:** `Payabli.Entry`
|
|
14600
|
+
|
|
14601
|
+
</dd>
|
|
14602
|
+
</dl>
|
|
14603
|
+
|
|
14604
|
+
<dl>
|
|
14605
|
+
<dd>
|
|
14606
|
+
|
|
14607
|
+
**request:** `Payabli.ListPayoutSubscriptionsRequest`
|
|
14608
|
+
|
|
14609
|
+
</dd>
|
|
14610
|
+
</dl>
|
|
14611
|
+
|
|
14612
|
+
<dl>
|
|
14613
|
+
<dd>
|
|
14614
|
+
|
|
14615
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
14616
|
+
|
|
14617
|
+
</dd>
|
|
14618
|
+
</dl>
|
|
14619
|
+
</dd>
|
|
14620
|
+
</dl>
|
|
14621
|
+
|
|
14622
|
+
|
|
14623
|
+
</dd>
|
|
14624
|
+
</dl>
|
|
14625
|
+
</details>
|
|
14626
|
+
|
|
14627
|
+
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listPayoutSubscriptionsOrg</a>(orgId, { ...params }) -> Payabli.QueryPayoutSubscriptionResponse</code></summary>
|
|
14628
|
+
<dl>
|
|
14629
|
+
<dd>
|
|
14630
|
+
|
|
14631
|
+
#### 📝 Description
|
|
14632
|
+
|
|
14633
|
+
<dl>
|
|
14634
|
+
<dd>
|
|
14635
|
+
|
|
14636
|
+
<dl>
|
|
14637
|
+
<dd>
|
|
14638
|
+
|
|
14639
|
+
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.
|
|
14640
|
+
</dd>
|
|
14641
|
+
</dl>
|
|
14642
|
+
</dd>
|
|
14643
|
+
</dl>
|
|
14644
|
+
|
|
14645
|
+
#### 🔌 Usage
|
|
14646
|
+
|
|
14647
|
+
<dl>
|
|
14648
|
+
<dd>
|
|
14649
|
+
|
|
14650
|
+
<dl>
|
|
14651
|
+
<dd>
|
|
14652
|
+
|
|
14653
|
+
```typescript
|
|
14654
|
+
await client.query.listPayoutSubscriptionsOrg(123, {
|
|
14655
|
+
fromRecord: 0,
|
|
14656
|
+
limitRecord: 20,
|
|
14657
|
+
sortBy: "desc(field_name)"
|
|
14658
|
+
});
|
|
14659
|
+
|
|
14660
|
+
```
|
|
14661
|
+
</dd>
|
|
14662
|
+
</dl>
|
|
14663
|
+
</dd>
|
|
14664
|
+
</dl>
|
|
14665
|
+
|
|
14666
|
+
#### ⚙️ Parameters
|
|
14667
|
+
|
|
14668
|
+
<dl>
|
|
14669
|
+
<dd>
|
|
14670
|
+
|
|
14671
|
+
<dl>
|
|
14672
|
+
<dd>
|
|
14673
|
+
|
|
14674
|
+
**orgId:** `number` — The numeric identifier for organization, assigned by Payabli.
|
|
14675
|
+
|
|
14676
|
+
</dd>
|
|
14677
|
+
</dl>
|
|
14678
|
+
|
|
14679
|
+
<dl>
|
|
14680
|
+
<dd>
|
|
14681
|
+
|
|
14682
|
+
**request:** `Payabli.ListPayoutSubscriptionsOrgRequest`
|
|
14683
|
+
|
|
14684
|
+
</dd>
|
|
14685
|
+
</dl>
|
|
14686
|
+
|
|
14687
|
+
<dl>
|
|
14688
|
+
<dd>
|
|
14689
|
+
|
|
14690
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
14691
|
+
|
|
14692
|
+
</dd>
|
|
14693
|
+
</dl>
|
|
14694
|
+
</dd>
|
|
14695
|
+
</dl>
|
|
14696
|
+
|
|
14697
|
+
|
|
14092
14698
|
</dd>
|
|
14093
14699
|
</dl>
|
|
14094
14700
|
</details>
|
|
@@ -14108,9 +14714,8 @@ await client.query.listSubscriptionsOrg(123, {
|
|
|
14108
14714
|
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
14715
|
By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.
|
|
14110
14716
|
For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
14111
|
-
``` curl
|
|
14112
|
-
|
|
14113
|
-
--header 'requestToken: <api-key>'
|
|
14717
|
+
``` 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\
|
|
14718
|
+
-H 'requestToken: <API TOKEN>'
|
|
14114
14719
|
|
|
14115
14720
|
```
|
|
14116
14721
|
</dd>
|
|
@@ -14197,9 +14802,8 @@ By default, this endpoint returns only transactions from the last 60 days. To qu
|
|
|
14197
14802
|
For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
14198
14803
|
|
|
14199
14804
|
```
|
|
14200
|
-
curl
|
|
14201
|
-
|
|
14202
|
-
--header 'requestToken: <api-key>'
|
|
14805
|
+
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"\
|
|
14806
|
+
-H 'requestToken: <API TOKEN>'
|
|
14203
14807
|
|
|
14204
14808
|
```
|
|
14205
14809
|
</dd>
|