@payabli/sdk-node 0.0.116 → 0.0.123
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 +31 -2
- package/dist/cjs/BaseClient.d.ts +13 -4
- package/dist/cjs/BaseClient.js +59 -0
- package/dist/cjs/Client.d.ts +88 -88
- package/dist/cjs/Client.js +31 -72
- package/dist/cjs/api/errors/BadRequestError.js +5 -1
- package/dist/cjs/api/errors/ConflictError.js +5 -1
- package/dist/cjs/api/errors/ForbiddenError.js +5 -1
- package/dist/cjs/api/errors/InternalServerError.js +5 -1
- package/dist/cjs/api/errors/ServiceUnavailableError.js +5 -1
- package/dist/cjs/api/errors/UnauthorizedError.js +5 -1
- package/dist/cjs/api/resources/bill/client/Client.d.ts +34 -35
- package/dist/cjs/api/resources/bill/client/Client.js +69 -216
- package/dist/cjs/api/resources/boarding/client/Client.d.ts +28 -29
- package/dist/cjs/api/resources/boarding/client/Client.js +51 -198
- package/dist/cjs/api/resources/chargeBacks/client/Client.d.ts +18 -17
- package/dist/cjs/api/resources/chargeBacks/client/Client.js +38 -79
- package/dist/cjs/api/resources/checkCapture/client/Client.d.ts +8 -9
- package/dist/cjs/api/resources/checkCapture/client/Client.js +11 -28
- package/dist/cjs/api/resources/cloud/client/Client.d.ts +18 -19
- package/dist/cjs/api/resources/cloud/client/Client.js +33 -89
- package/dist/cjs/api/resources/customer/client/Client.d.ts +18 -19
- package/dist/cjs/api/resources/customer/client/Client.js +31 -113
- package/dist/cjs/api/resources/export/client/Client.d.ts +94 -91
- package/dist/cjs/api/resources/export/client/Client.js +205 -582
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.d.ts +12 -13
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.js +19 -62
- package/dist/cjs/api/resources/import/client/Client.d.ts +12 -13
- package/dist/cjs/api/resources/import/client/Client.js +19 -62
- package/dist/cjs/api/resources/invoice/client/Client.d.ts +37 -36
- package/dist/cjs/api/resources/invoice/client/Client.js +67 -212
- package/dist/cjs/api/resources/invoice/client/requests/AddInvoiceRequest.d.ts +5 -3
- package/dist/cjs/api/resources/lineItem/client/Client.d.ts +16 -17
- package/dist/cjs/api/resources/lineItem/client/Client.js +27 -96
- package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +40 -41
- package/dist/cjs/api/resources/moneyIn/client/Client.js +79 -249
- package/dist/cjs/api/resources/moneyIn/errors/CaptureError.js +5 -1
- package/dist/cjs/api/resources/moneyIn/errors/InvalidTransStatusError.js +5 -1
- package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +44 -28
- package/dist/cjs/api/resources/moneyOut/client/Client.js +105 -168
- package/dist/cjs/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.ts +2 -1
- package/dist/cjs/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.ts +3 -1
- package/dist/cjs/api/resources/notification/client/Client.d.ts +30 -18
- package/dist/cjs/api/resources/notification/client/Client.js +45 -101
- package/dist/cjs/api/resources/notificationlogs/client/Client.d.ts +14 -15
- package/dist/cjs/api/resources/notificationlogs/client/Client.js +23 -79
- package/dist/cjs/api/resources/ocr/client/Client.d.ts +14 -11
- package/dist/cjs/api/resources/ocr/client/Client.js +19 -45
- package/dist/cjs/api/resources/organization/client/Client.d.ts +20 -21
- package/dist/cjs/api/resources/organization/client/Client.js +35 -130
- package/dist/cjs/api/resources/paymentLink/client/Client.d.ts +27 -28
- package/dist/cjs/api/resources/paymentLink/client/Client.js +46 -167
- package/dist/cjs/api/resources/paymentLink/client/requests/PayLinkDataBill.d.ts +1 -1
- package/dist/cjs/api/resources/paymentLink/client/requests/PayLinkDataInvoice.d.ts +1 -1
- package/dist/cjs/api/resources/paymentLink/client/requests/PayLinkDataOut.d.ts +1 -1
- package/dist/cjs/api/resources/paymentLink/types/PaymentPageRequestBody.d.ts +2 -2
- package/dist/cjs/api/resources/paymentMethodDomain/client/Client.d.ts +20 -21
- package/dist/cjs/api/resources/paymentMethodDomain/client/Client.js +35 -130
- package/dist/cjs/api/resources/paypoint/client/Client.d.ts +23 -24
- package/dist/cjs/api/resources/paypoint/client/Client.js +44 -152
- package/dist/cjs/api/resources/query/client/Client.d.ts +72 -73
- package/dist/cjs/api/resources/query/client/Client.js +137 -572
- package/dist/cjs/api/resources/query/client/requests/ListPayoutOrgRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListPayoutRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransactionsRequest.d.ts +1 -0
- package/dist/cjs/api/resources/statistic/client/Client.d.ts +51 -52
- package/dist/cjs/api/resources/statistic/client/Client.js +80 -133
- package/dist/cjs/api/resources/statistic/client/requests/BasicStatsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/statistic/types/StatBasicExtendedQueryRecord.d.ts +76 -0
- package/dist/cjs/api/resources/statistic/types/StatBasicExtendedQueryRecord.js +3 -0
- package/dist/cjs/api/resources/statistic/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/statistic/types/index.js +1 -0
- package/dist/cjs/api/resources/subscription/client/Client.d.ts +14 -15
- package/dist/cjs/api/resources/subscription/client/Client.js +23 -79
- package/dist/cjs/api/resources/templates/client/Client.d.ts +16 -17
- package/dist/cjs/api/resources/templates/client/Client.js +28 -84
- package/dist/cjs/api/resources/tokenStorage/client/Client.d.ts +14 -15
- package/dist/cjs/api/resources/tokenStorage/client/Client.js +23 -79
- package/dist/cjs/api/resources/tokenStorage/types/GetMethodResponse.d.ts +1 -1
- package/dist/cjs/api/resources/user/client/Client.d.ts +55 -34
- package/dist/cjs/api/resources/user/client/Client.js +84 -222
- package/dist/cjs/api/resources/vendor/client/Client.d.ts +14 -15
- package/dist/cjs/api/resources/vendor/client/Client.js +23 -79
- package/dist/cjs/api/resources/wallet/client/Client.d.ts +14 -15
- package/dist/cjs/api/resources/wallet/client/Client.js +23 -79
- package/dist/cjs/api/types/ApplicationDetailsRecord.d.ts +2 -2
- package/dist/cjs/api/types/Frequency.d.ts +1 -1
- package/dist/cjs/api/types/Frequency.js +1 -1
- package/dist/cjs/api/types/FrequencyList.d.ts +1 -1
- package/dist/cjs/api/types/NotificationContent.d.ts +1 -0
- package/dist/cjs/api/types/NotificationContent.js +1 -0
- package/dist/cjs/api/types/NotificationStandardRequest.d.ts +1 -0
- package/dist/cjs/api/types/NotificationStandardRequest.js +1 -0
- package/dist/cjs/api/types/PayorDataResponse.d.ts +1 -1
- package/dist/cjs/api/types/QueryResponseSettlements.d.ts +1 -1
- package/dist/cjs/auth/HeaderAuthProvider.d.ts +16 -0
- package/dist/cjs/auth/HeaderAuthProvider.js +71 -0
- package/dist/cjs/auth/index.d.ts +1 -0
- package/dist/cjs/auth/index.js +5 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +7 -0
- package/dist/cjs/core/auth/AuthProvider.js +2 -0
- package/dist/cjs/core/auth/AuthRequest.d.ts +9 -0
- package/dist/cjs/core/auth/AuthRequest.js +2 -0
- package/dist/cjs/core/auth/BasicAuth.d.ts +8 -0
- package/dist/cjs/core/auth/BasicAuth.js +27 -0
- package/dist/cjs/core/auth/BearerToken.d.ts +7 -0
- package/dist/cjs/core/auth/BearerToken.js +16 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.d.ts +5 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.js +9 -0
- package/dist/cjs/core/auth/index.d.ts +5 -0
- package/dist/cjs/core/auth/index.js +9 -0
- package/dist/cjs/core/base64.d.ts +2 -0
- package/dist/cjs/core/base64.js +26 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +6 -7
- package/dist/cjs/core/fetcher/Fetcher.d.ts +5 -1
- package/dist/cjs/core/fetcher/Fetcher.js +42 -24
- package/dist/cjs/core/fetcher/getResponseBody.js +18 -4
- package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -1
- package/dist/cjs/core/fetcher/makeRequest.js +0 -2
- package/dist/cjs/core/fetcher/requestWithRetries.js +0 -9
- package/dist/cjs/core/fetcher/signals.d.ts +1 -7
- package/dist/cjs/core/fetcher/signals.js +0 -12
- package/dist/cjs/core/index.d.ts +2 -0
- package/dist/cjs/core/index.js +2 -0
- package/dist/cjs/core/logging/logger.js +1 -1
- package/dist/cjs/core/runtime/runtime.js +11 -10
- package/dist/cjs/core/url/join.js +0 -1
- package/dist/cjs/errors/PayabliError.js +5 -1
- package/dist/cjs/errors/PayabliTimeoutError.js +5 -1
- package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/cjs/errors/handleNonStatusCodeError.js +65 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +13 -4
- package/dist/esm/BaseClient.mjs +24 -1
- package/dist/esm/Client.d.mts +88 -88
- package/dist/esm/Client.mjs +59 -67
- package/dist/esm/api/errors/BadRequestError.mjs +5 -1
- package/dist/esm/api/errors/ConflictError.mjs +5 -1
- package/dist/esm/api/errors/ForbiddenError.mjs +5 -1
- package/dist/esm/api/errors/InternalServerError.mjs +5 -1
- package/dist/esm/api/errors/ServiceUnavailableError.mjs +5 -1
- package/dist/esm/api/errors/UnauthorizedError.mjs +5 -1
- package/dist/esm/api/resources/bill/client/Client.d.mts +34 -35
- package/dist/esm/api/resources/bill/client/Client.mjs +67 -214
- package/dist/esm/api/resources/boarding/client/Client.d.mts +28 -29
- package/dist/esm/api/resources/boarding/client/Client.mjs +50 -197
- package/dist/esm/api/resources/chargeBacks/client/Client.d.mts +18 -17
- package/dist/esm/api/resources/chargeBacks/client/Client.mjs +36 -77
- package/dist/esm/api/resources/checkCapture/client/Client.d.mts +8 -9
- package/dist/esm/api/resources/checkCapture/client/Client.mjs +10 -27
- package/dist/esm/api/resources/cloud/client/Client.d.mts +18 -19
- package/dist/esm/api/resources/cloud/client/Client.mjs +31 -87
- package/dist/esm/api/resources/customer/client/Client.d.mts +18 -19
- package/dist/esm/api/resources/customer/client/Client.mjs +29 -111
- package/dist/esm/api/resources/export/client/Client.d.mts +94 -91
- package/dist/esm/api/resources/export/client/Client.mjs +204 -581
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.d.mts +12 -13
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.mjs +17 -60
- package/dist/esm/api/resources/import/client/Client.d.mts +12 -13
- package/dist/esm/api/resources/import/client/Client.mjs +17 -60
- package/dist/esm/api/resources/invoice/client/Client.d.mts +37 -36
- package/dist/esm/api/resources/invoice/client/Client.mjs +65 -210
- package/dist/esm/api/resources/invoice/client/requests/AddInvoiceRequest.d.mts +5 -3
- package/dist/esm/api/resources/lineItem/client/Client.d.mts +16 -17
- package/dist/esm/api/resources/lineItem/client/Client.mjs +25 -94
- package/dist/esm/api/resources/moneyIn/client/Client.d.mts +40 -41
- package/dist/esm/api/resources/moneyIn/client/Client.mjs +77 -247
- package/dist/esm/api/resources/moneyIn/errors/CaptureError.mjs +5 -1
- package/dist/esm/api/resources/moneyIn/errors/InvalidTransStatusError.mjs +5 -1
- package/dist/esm/api/resources/moneyOut/client/Client.d.mts +44 -28
- package/dist/esm/api/resources/moneyOut/client/Client.mjs +103 -166
- package/dist/esm/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.mts +2 -1
- package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.mts +3 -1
- package/dist/esm/api/resources/notification/client/Client.d.mts +30 -18
- package/dist/esm/api/resources/notification/client/Client.mjs +44 -100
- package/dist/esm/api/resources/notificationlogs/client/Client.d.mts +14 -15
- package/dist/esm/api/resources/notificationlogs/client/Client.mjs +22 -78
- package/dist/esm/api/resources/ocr/client/Client.d.mts +14 -11
- package/dist/esm/api/resources/ocr/client/Client.mjs +18 -44
- package/dist/esm/api/resources/organization/client/Client.d.mts +20 -21
- package/dist/esm/api/resources/organization/client/Client.mjs +33 -128
- package/dist/esm/api/resources/paymentLink/client/Client.d.mts +27 -28
- package/dist/esm/api/resources/paymentLink/client/Client.mjs +44 -165
- package/dist/esm/api/resources/paymentLink/client/requests/PayLinkDataBill.d.mts +1 -1
- package/dist/esm/api/resources/paymentLink/client/requests/PayLinkDataInvoice.d.mts +1 -1
- package/dist/esm/api/resources/paymentLink/client/requests/PayLinkDataOut.d.mts +1 -1
- package/dist/esm/api/resources/paymentLink/types/PaymentPageRequestBody.d.mts +2 -2
- package/dist/esm/api/resources/paymentMethodDomain/client/Client.d.mts +20 -21
- package/dist/esm/api/resources/paymentMethodDomain/client/Client.mjs +34 -129
- package/dist/esm/api/resources/paypoint/client/Client.d.mts +23 -24
- package/dist/esm/api/resources/paypoint/client/Client.mjs +43 -151
- package/dist/esm/api/resources/query/client/Client.d.mts +72 -73
- package/dist/esm/api/resources/query/client/Client.mjs +136 -571
- package/dist/esm/api/resources/query/client/requests/ListPayoutOrgRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListPayoutRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListTransactionsRequest.d.mts +1 -0
- package/dist/esm/api/resources/statistic/client/Client.d.mts +51 -52
- package/dist/esm/api/resources/statistic/client/Client.mjs +79 -132
- package/dist/esm/api/resources/statistic/client/requests/BasicStatsRequest.d.mts +2 -2
- package/dist/esm/api/resources/statistic/types/StatBasicExtendedQueryRecord.d.mts +76 -0
- package/dist/esm/api/resources/statistic/types/StatBasicExtendedQueryRecord.mjs +2 -0
- package/dist/esm/api/resources/statistic/types/index.d.mts +1 -0
- package/dist/esm/api/resources/statistic/types/index.mjs +1 -0
- package/dist/esm/api/resources/subscription/client/Client.d.mts +14 -15
- package/dist/esm/api/resources/subscription/client/Client.mjs +21 -77
- package/dist/esm/api/resources/templates/client/Client.d.mts +16 -17
- package/dist/esm/api/resources/templates/client/Client.mjs +27 -83
- package/dist/esm/api/resources/tokenStorage/client/Client.d.mts +14 -15
- package/dist/esm/api/resources/tokenStorage/client/Client.mjs +21 -77
- package/dist/esm/api/resources/tokenStorage/types/GetMethodResponse.d.mts +1 -1
- package/dist/esm/api/resources/user/client/Client.d.mts +55 -34
- package/dist/esm/api/resources/user/client/Client.mjs +83 -221
- package/dist/esm/api/resources/vendor/client/Client.d.mts +14 -15
- package/dist/esm/api/resources/vendor/client/Client.mjs +22 -78
- package/dist/esm/api/resources/wallet/client/Client.d.mts +14 -15
- package/dist/esm/api/resources/wallet/client/Client.mjs +22 -78
- package/dist/esm/api/types/ApplicationDetailsRecord.d.mts +2 -2
- package/dist/esm/api/types/Frequency.d.mts +1 -1
- package/dist/esm/api/types/Frequency.mjs +1 -1
- package/dist/esm/api/types/FrequencyList.d.mts +1 -1
- package/dist/esm/api/types/NotificationContent.d.mts +1 -0
- package/dist/esm/api/types/NotificationContent.mjs +1 -0
- package/dist/esm/api/types/NotificationStandardRequest.d.mts +1 -0
- package/dist/esm/api/types/NotificationStandardRequest.mjs +1 -0
- package/dist/esm/api/types/PayorDataResponse.d.mts +1 -1
- package/dist/esm/api/types/QueryResponseSettlements.d.mts +1 -1
- package/dist/esm/auth/HeaderAuthProvider.d.mts +16 -0
- package/dist/esm/auth/HeaderAuthProvider.mjs +34 -0
- package/dist/esm/auth/index.d.mts +1 -0
- package/dist/esm/auth/index.mjs +1 -0
- package/dist/esm/core/auth/AuthProvider.d.mts +7 -0
- package/dist/esm/core/auth/AuthProvider.mjs +1 -0
- package/dist/esm/core/auth/AuthRequest.d.mts +9 -0
- package/dist/esm/core/auth/AuthRequest.mjs +1 -0
- package/dist/esm/core/auth/BasicAuth.d.mts +8 -0
- package/dist/esm/core/auth/BasicAuth.mjs +24 -0
- package/dist/esm/core/auth/BearerToken.d.mts +7 -0
- package/dist/esm/core/auth/BearerToken.mjs +13 -0
- package/dist/esm/core/auth/NoOpAuthProvider.d.mts +5 -0
- package/dist/esm/core/auth/NoOpAuthProvider.mjs +5 -0
- package/dist/esm/core/auth/index.d.mts +5 -0
- package/dist/esm/core/auth/index.mjs +3 -0
- package/dist/esm/core/base64.d.mts +2 -0
- package/dist/esm/core/base64.mjs +22 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +6 -7
- package/dist/esm/core/fetcher/Fetcher.d.mts +5 -1
- package/dist/esm/core/fetcher/Fetcher.mjs +42 -24
- package/dist/esm/core/fetcher/getResponseBody.mjs +18 -4
- package/dist/esm/core/fetcher/makeRequest.d.mts +1 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +0 -2
- package/dist/esm/core/fetcher/requestWithRetries.mjs +0 -9
- package/dist/esm/core/fetcher/signals.d.mts +1 -7
- package/dist/esm/core/fetcher/signals.mjs +0 -12
- package/dist/esm/core/index.d.mts +2 -0
- package/dist/esm/core/index.mjs +2 -0
- package/dist/esm/core/logging/logger.mjs +1 -1
- package/dist/esm/core/runtime/runtime.mjs +11 -10
- package/dist/esm/core/url/join.mjs +0 -1
- package/dist/esm/errors/PayabliError.mjs +5 -1
- package/dist/esm/errors/PayabliTimeoutError.mjs +5 -1
- package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
- package/dist/esm/errors/handleNonStatusCodeError.mjs +29 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +5 -2
- package/reference.md +768 -478
- package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +0 -4
- package/dist/cjs/core/fetcher/ResponseWithBody.js +0 -6
- package/dist/esm/core/fetcher/ResponseWithBody.d.mts +0 -4
- package/dist/esm/core/fetcher/ResponseWithBody.mjs +0 -3
package/reference.md
CHANGED
|
@@ -95,7 +95,7 @@ await client.bill.addBill("8cfec329267", {
|
|
|
95
95
|
<dl>
|
|
96
96
|
<dd>
|
|
97
97
|
|
|
98
|
-
**requestOptions:** `
|
|
98
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
99
99
|
|
|
100
100
|
</dd>
|
|
101
101
|
</dl>
|
|
@@ -107,7 +107,7 @@ await client.bill.addBill("8cfec329267", {
|
|
|
107
107
|
</dl>
|
|
108
108
|
</details>
|
|
109
109
|
|
|
110
|
-
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">deleteAttachedFromBill</a>(
|
|
110
|
+
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">deleteAttachedFromBill</a>(idBill, filename, { ...params }) -> Payabli.BillResponse</code></summary>
|
|
111
111
|
<dl>
|
|
112
112
|
<dd>
|
|
113
113
|
|
|
@@ -134,7 +134,7 @@ Delete a file attached to a bill.
|
|
|
134
134
|
<dd>
|
|
135
135
|
|
|
136
136
|
```typescript
|
|
137
|
-
await client.bill.deleteAttachedFromBill("0_Bill.pdf"
|
|
137
|
+
await client.bill.deleteAttachedFromBill(285, "0_Bill.pdf");
|
|
138
138
|
|
|
139
139
|
```
|
|
140
140
|
</dd>
|
|
@@ -150,6 +150,14 @@ await client.bill.deleteAttachedFromBill("0_Bill.pdf", 285);
|
|
|
150
150
|
<dl>
|
|
151
151
|
<dd>
|
|
152
152
|
|
|
153
|
+
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
154
|
+
|
|
155
|
+
</dd>
|
|
156
|
+
</dl>
|
|
157
|
+
|
|
158
|
+
<dl>
|
|
159
|
+
<dd>
|
|
160
|
+
|
|
153
161
|
**filename:** `string`
|
|
154
162
|
|
|
155
163
|
The filename in Payabli. Filename is `zipName` in response to a
|
|
@@ -175,14 +183,6 @@ request to `/api/Invoice/{idInvoice}`. Here, the filename is
|
|
|
175
183
|
<dl>
|
|
176
184
|
<dd>
|
|
177
185
|
|
|
178
|
-
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
179
|
-
|
|
180
|
-
</dd>
|
|
181
|
-
</dl>
|
|
182
|
-
|
|
183
|
-
<dl>
|
|
184
|
-
<dd>
|
|
185
|
-
|
|
186
186
|
**request:** `Payabli.DeleteAttachedFromBillRequest`
|
|
187
187
|
|
|
188
188
|
</dd>
|
|
@@ -191,7 +191,7 @@ request to `/api/Invoice/{idInvoice}`. Here, the filename is
|
|
|
191
191
|
<dl>
|
|
192
192
|
<dd>
|
|
193
193
|
|
|
194
|
-
**requestOptions:** `
|
|
194
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
195
195
|
|
|
196
196
|
</dd>
|
|
197
197
|
</dl>
|
|
@@ -254,7 +254,7 @@ await client.bill.deleteBill(285);
|
|
|
254
254
|
<dl>
|
|
255
255
|
<dd>
|
|
256
256
|
|
|
257
|
-
**requestOptions:** `
|
|
257
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
258
258
|
|
|
259
259
|
</dd>
|
|
260
260
|
</dl>
|
|
@@ -328,7 +328,7 @@ await client.bill.editBill(285, {
|
|
|
328
328
|
<dl>
|
|
329
329
|
<dd>
|
|
330
330
|
|
|
331
|
-
**requestOptions:** `
|
|
331
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
332
332
|
|
|
333
333
|
</dd>
|
|
334
334
|
</dl>
|
|
@@ -340,7 +340,7 @@ await client.bill.editBill(285, {
|
|
|
340
340
|
</dl>
|
|
341
341
|
</details>
|
|
342
342
|
|
|
343
|
-
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">getAttachedFromBill</a>(
|
|
343
|
+
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">getAttachedFromBill</a>(idBill, filename, { ...params }) -> Payabli.FileContent</code></summary>
|
|
344
344
|
<dl>
|
|
345
345
|
<dd>
|
|
346
346
|
|
|
@@ -367,7 +367,7 @@ Retrieves a file attached to a bill, either as a binary file or as a Base64-enco
|
|
|
367
367
|
<dd>
|
|
368
368
|
|
|
369
369
|
```typescript
|
|
370
|
-
await client.bill.getAttachedFromBill("0_Bill.pdf",
|
|
370
|
+
await client.bill.getAttachedFromBill(285, "0_Bill.pdf", {
|
|
371
371
|
returnObject: true
|
|
372
372
|
});
|
|
373
373
|
|
|
@@ -385,6 +385,14 @@ await client.bill.getAttachedFromBill("0_Bill.pdf", 285, {
|
|
|
385
385
|
<dl>
|
|
386
386
|
<dd>
|
|
387
387
|
|
|
388
|
+
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
389
|
+
|
|
390
|
+
</dd>
|
|
391
|
+
</dl>
|
|
392
|
+
|
|
393
|
+
<dl>
|
|
394
|
+
<dd>
|
|
395
|
+
|
|
388
396
|
**filename:** `string`
|
|
389
397
|
|
|
390
398
|
The filename in Payabli. Filename is `zipName` in response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
|
|
@@ -405,14 +413,6 @@ The filename in Payabli. Filename is `zipName` in response to a request to `/api
|
|
|
405
413
|
<dl>
|
|
406
414
|
<dd>
|
|
407
415
|
|
|
408
|
-
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
409
|
-
|
|
410
|
-
</dd>
|
|
411
|
-
</dl>
|
|
412
|
-
|
|
413
|
-
<dl>
|
|
414
|
-
<dd>
|
|
415
|
-
|
|
416
416
|
**request:** `Payabli.GetAttachedFromBillRequest`
|
|
417
417
|
|
|
418
418
|
</dd>
|
|
@@ -421,7 +421,7 @@ The filename in Payabli. Filename is `zipName` in response to a request to `/api
|
|
|
421
421
|
<dl>
|
|
422
422
|
<dd>
|
|
423
423
|
|
|
424
|
-
**requestOptions:** `
|
|
424
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
425
425
|
|
|
426
426
|
</dd>
|
|
427
427
|
</dl>
|
|
@@ -484,7 +484,7 @@ await client.bill.getBill(285);
|
|
|
484
484
|
<dl>
|
|
485
485
|
<dd>
|
|
486
486
|
|
|
487
|
-
**requestOptions:** `
|
|
487
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
488
488
|
|
|
489
489
|
</dd>
|
|
490
490
|
</dl>
|
|
@@ -559,7 +559,7 @@ await client.bill.listBills("8cfec329267", {
|
|
|
559
559
|
<dl>
|
|
560
560
|
<dd>
|
|
561
561
|
|
|
562
|
-
**requestOptions:** `
|
|
562
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
563
563
|
|
|
564
564
|
</dd>
|
|
565
565
|
</dl>
|
|
@@ -634,7 +634,7 @@ await client.bill.listBillsOrg(123, {
|
|
|
634
634
|
<dl>
|
|
635
635
|
<dd>
|
|
636
636
|
|
|
637
|
-
**requestOptions:** `
|
|
637
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
638
638
|
|
|
639
639
|
</dd>
|
|
640
640
|
</dl>
|
|
@@ -705,7 +705,7 @@ await client.bill.modifyApprovalBill(285, ["string"]);
|
|
|
705
705
|
<dl>
|
|
706
706
|
<dd>
|
|
707
707
|
|
|
708
|
-
**requestOptions:** `
|
|
708
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
709
709
|
|
|
710
710
|
</dd>
|
|
711
711
|
</dl>
|
|
@@ -779,7 +779,7 @@ await client.bill.sendToApprovalBill(285, {
|
|
|
779
779
|
<dl>
|
|
780
780
|
<dd>
|
|
781
781
|
|
|
782
|
-
**requestOptions:** `
|
|
782
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
783
783
|
|
|
784
784
|
</dd>
|
|
785
785
|
</dl>
|
|
@@ -791,7 +791,7 @@ await client.bill.sendToApprovalBill(285, {
|
|
|
791
791
|
</dl>
|
|
792
792
|
</details>
|
|
793
793
|
|
|
794
|
-
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">setApprovedBill</a>(
|
|
794
|
+
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">setApprovedBill</a>(idBill, approved, { ...params }) -> Payabli.SetApprovedBillResponse</code></summary>
|
|
795
795
|
<dl>
|
|
796
796
|
<dd>
|
|
797
797
|
|
|
@@ -818,7 +818,7 @@ Approve or disapprove a bill by ID.
|
|
|
818
818
|
<dd>
|
|
819
819
|
|
|
820
820
|
```typescript
|
|
821
|
-
await client.bill.setApprovedBill("true"
|
|
821
|
+
await client.bill.setApprovedBill(285, "true");
|
|
822
822
|
|
|
823
823
|
```
|
|
824
824
|
</dd>
|
|
@@ -834,7 +834,7 @@ await client.bill.setApprovedBill("true", 285);
|
|
|
834
834
|
<dl>
|
|
835
835
|
<dd>
|
|
836
836
|
|
|
837
|
-
**
|
|
837
|
+
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
838
838
|
|
|
839
839
|
</dd>
|
|
840
840
|
</dl>
|
|
@@ -842,7 +842,7 @@ await client.bill.setApprovedBill("true", 285);
|
|
|
842
842
|
<dl>
|
|
843
843
|
<dd>
|
|
844
844
|
|
|
845
|
-
**
|
|
845
|
+
**approved:** `string` — String representing the approved status. Accepted values: 'true' or 'false'.
|
|
846
846
|
|
|
847
847
|
</dd>
|
|
848
848
|
</dl>
|
|
@@ -858,7 +858,7 @@ await client.bill.setApprovedBill("true", 285);
|
|
|
858
858
|
<dl>
|
|
859
859
|
<dd>
|
|
860
860
|
|
|
861
|
-
**requestOptions:** `
|
|
861
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
862
862
|
|
|
863
863
|
</dd>
|
|
864
864
|
</dl>
|
|
@@ -1019,7 +1019,7 @@ await client.boarding.addApplication({
|
|
|
1019
1019
|
<dl>
|
|
1020
1020
|
<dd>
|
|
1021
1021
|
|
|
1022
|
-
**requestOptions:** `
|
|
1022
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1023
1023
|
|
|
1024
1024
|
</dd>
|
|
1025
1025
|
</dl>
|
|
@@ -1082,7 +1082,7 @@ await client.boarding.deleteApplication(352);
|
|
|
1082
1082
|
<dl>
|
|
1083
1083
|
<dd>
|
|
1084
1084
|
|
|
1085
|
-
**requestOptions:** `
|
|
1085
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1086
1086
|
|
|
1087
1087
|
</dd>
|
|
1088
1088
|
</dl>
|
|
@@ -1145,7 +1145,7 @@ await client.boarding.getApplication(352);
|
|
|
1145
1145
|
<dl>
|
|
1146
1146
|
<dd>
|
|
1147
1147
|
|
|
1148
|
-
**requestOptions:** `
|
|
1148
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1149
1149
|
|
|
1150
1150
|
</dd>
|
|
1151
1151
|
</dl>
|
|
@@ -1219,7 +1219,7 @@ await client.boarding.getApplicationByAuth("17E", {
|
|
|
1219
1219
|
<dl>
|
|
1220
1220
|
<dd>
|
|
1221
1221
|
|
|
1222
|
-
**requestOptions:** `
|
|
1222
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1223
1223
|
|
|
1224
1224
|
</dd>
|
|
1225
1225
|
</dl>
|
|
@@ -1282,7 +1282,7 @@ await client.boarding.getByIdLinkApplication(91);
|
|
|
1282
1282
|
<dl>
|
|
1283
1283
|
<dd>
|
|
1284
1284
|
|
|
1285
|
-
**requestOptions:** `
|
|
1285
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1286
1286
|
|
|
1287
1287
|
</dd>
|
|
1288
1288
|
</dl>
|
|
@@ -1345,7 +1345,7 @@ await client.boarding.getByTemplateIdLinkApplication(80);
|
|
|
1345
1345
|
<dl>
|
|
1346
1346
|
<dd>
|
|
1347
1347
|
|
|
1348
|
-
**requestOptions:** `
|
|
1348
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1349
1349
|
|
|
1350
1350
|
</dd>
|
|
1351
1351
|
</dl>
|
|
@@ -1424,7 +1424,7 @@ await client.boarding.getExternalApplication(352, "mail2");
|
|
|
1424
1424
|
<dl>
|
|
1425
1425
|
<dd>
|
|
1426
1426
|
|
|
1427
|
-
**requestOptions:** `
|
|
1427
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1428
1428
|
|
|
1429
1429
|
</dd>
|
|
1430
1430
|
</dl>
|
|
@@ -1487,7 +1487,7 @@ await client.boarding.getLinkApplication("myorgaccountname-00091");
|
|
|
1487
1487
|
<dl>
|
|
1488
1488
|
<dd>
|
|
1489
1489
|
|
|
1490
|
-
**requestOptions:** `
|
|
1490
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1491
1491
|
|
|
1492
1492
|
</dd>
|
|
1493
1493
|
</dl>
|
|
@@ -1562,7 +1562,7 @@ await client.boarding.listApplications(123, {
|
|
|
1562
1562
|
<dl>
|
|
1563
1563
|
<dd>
|
|
1564
1564
|
|
|
1565
|
-
**requestOptions:** `
|
|
1565
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1566
1566
|
|
|
1567
1567
|
</dd>
|
|
1568
1568
|
</dl>
|
|
@@ -1637,7 +1637,7 @@ await client.boarding.listBoardingLinks(123, {
|
|
|
1637
1637
|
<dl>
|
|
1638
1638
|
<dd>
|
|
1639
1639
|
|
|
1640
|
-
**requestOptions:** `
|
|
1640
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1641
1641
|
|
|
1642
1642
|
</dd>
|
|
1643
1643
|
</dl>
|
|
@@ -1708,7 +1708,7 @@ await client.boarding.updateApplication(352, {});
|
|
|
1708
1708
|
<dl>
|
|
1709
1709
|
<dd>
|
|
1710
1710
|
|
|
1711
|
-
**requestOptions:** `
|
|
1711
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1712
1712
|
|
|
1713
1713
|
</dd>
|
|
1714
1714
|
</dl>
|
|
@@ -1721,7 +1721,7 @@ await client.boarding.updateApplication(352, {});
|
|
|
1721
1721
|
</details>
|
|
1722
1722
|
|
|
1723
1723
|
## ChargeBacks
|
|
1724
|
-
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">addResponse</a>(
|
|
1724
|
+
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">addResponse</a>(Id, { ...params }) -> Payabli.AddResponseResponse</code></summary>
|
|
1725
1725
|
<dl>
|
|
1726
1726
|
<dd>
|
|
1727
1727
|
|
|
@@ -1766,7 +1766,7 @@ await client.chargeBacks.addResponse(1000000, {
|
|
|
1766
1766
|
<dl>
|
|
1767
1767
|
<dd>
|
|
1768
1768
|
|
|
1769
|
-
**
|
|
1769
|
+
**Id:** `number` — ID of the chargeback or return record.
|
|
1770
1770
|
|
|
1771
1771
|
</dd>
|
|
1772
1772
|
</dl>
|
|
@@ -1782,7 +1782,7 @@ await client.chargeBacks.addResponse(1000000, {
|
|
|
1782
1782
|
<dl>
|
|
1783
1783
|
<dd>
|
|
1784
1784
|
|
|
1785
|
-
**requestOptions:** `
|
|
1785
|
+
**requestOptions:** `ChargeBacksClient.RequestOptions`
|
|
1786
1786
|
|
|
1787
1787
|
</dd>
|
|
1788
1788
|
</dl>
|
|
@@ -1794,7 +1794,7 @@ await client.chargeBacks.addResponse(1000000, {
|
|
|
1794
1794
|
</dl>
|
|
1795
1795
|
</details>
|
|
1796
1796
|
|
|
1797
|
-
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">getChargeback</a>(
|
|
1797
|
+
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">getChargeback</a>(Id) -> Payabli.ChargebackQueryRecords</code></summary>
|
|
1798
1798
|
<dl>
|
|
1799
1799
|
<dd>
|
|
1800
1800
|
|
|
@@ -1837,7 +1837,7 @@ await client.chargeBacks.getChargeback(1000000);
|
|
|
1837
1837
|
<dl>
|
|
1838
1838
|
<dd>
|
|
1839
1839
|
|
|
1840
|
-
**
|
|
1840
|
+
**Id:** `number` — ID of the chargeback or return record. This is returned as `chargebackId` in the [RecievedChargeback](/developers/developer-guides/webhook-payloads#receivedChargeback) and [ReceivedAchReturn](/developers/developer-guides/webhook-payloads#receivedachreturn) webhook notifications.
|
|
1841
1841
|
|
|
1842
1842
|
</dd>
|
|
1843
1843
|
</dl>
|
|
@@ -1845,7 +1845,7 @@ await client.chargeBacks.getChargeback(1000000);
|
|
|
1845
1845
|
<dl>
|
|
1846
1846
|
<dd>
|
|
1847
1847
|
|
|
1848
|
-
**requestOptions:** `
|
|
1848
|
+
**requestOptions:** `ChargeBacksClient.RequestOptions`
|
|
1849
1849
|
|
|
1850
1850
|
</dd>
|
|
1851
1851
|
</dl>
|
|
@@ -1857,10 +1857,24 @@ await client.chargeBacks.getChargeback(1000000);
|
|
|
1857
1857
|
</dl>
|
|
1858
1858
|
</details>
|
|
1859
1859
|
|
|
1860
|
-
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">getChargebackAttachment</a>(
|
|
1860
|
+
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">getChargebackAttachment</a>(Id, fileName) -> string</code></summary>
|
|
1861
|
+
<dl>
|
|
1862
|
+
<dd>
|
|
1863
|
+
|
|
1864
|
+
#### 📝 Description
|
|
1865
|
+
|
|
1866
|
+
<dl>
|
|
1867
|
+
<dd>
|
|
1868
|
+
|
|
1861
1869
|
<dl>
|
|
1862
1870
|
<dd>
|
|
1863
1871
|
|
|
1872
|
+
Retrieves a chargeback attachment file by its file name.
|
|
1873
|
+
</dd>
|
|
1874
|
+
</dl>
|
|
1875
|
+
</dd>
|
|
1876
|
+
</dl>
|
|
1877
|
+
|
|
1864
1878
|
#### 🔌 Usage
|
|
1865
1879
|
|
|
1866
1880
|
<dl>
|
|
@@ -1870,7 +1884,7 @@ await client.chargeBacks.getChargeback(1000000);
|
|
|
1870
1884
|
<dd>
|
|
1871
1885
|
|
|
1872
1886
|
```typescript
|
|
1873
|
-
await client.chargeBacks.getChargebackAttachment("fileName"
|
|
1887
|
+
await client.chargeBacks.getChargebackAttachment(1000000, "fileName");
|
|
1874
1888
|
|
|
1875
1889
|
```
|
|
1876
1890
|
</dd>
|
|
@@ -1886,7 +1900,7 @@ await client.chargeBacks.getChargebackAttachment("fileName", 1000000);
|
|
|
1886
1900
|
<dl>
|
|
1887
1901
|
<dd>
|
|
1888
1902
|
|
|
1889
|
-
**
|
|
1903
|
+
**Id:** `number` — The ID of chargeback or return record.
|
|
1890
1904
|
|
|
1891
1905
|
</dd>
|
|
1892
1906
|
</dl>
|
|
@@ -1894,7 +1908,7 @@ await client.chargeBacks.getChargebackAttachment("fileName", 1000000);
|
|
|
1894
1908
|
<dl>
|
|
1895
1909
|
<dd>
|
|
1896
1910
|
|
|
1897
|
-
**
|
|
1911
|
+
**fileName:** `string` — The chargeback attachment's file name.
|
|
1898
1912
|
|
|
1899
1913
|
</dd>
|
|
1900
1914
|
</dl>
|
|
@@ -1902,7 +1916,7 @@ await client.chargeBacks.getChargebackAttachment("fileName", 1000000);
|
|
|
1902
1916
|
<dl>
|
|
1903
1917
|
<dd>
|
|
1904
1918
|
|
|
1905
|
-
**requestOptions:** `
|
|
1919
|
+
**requestOptions:** `ChargeBacksClient.RequestOptions`
|
|
1906
1920
|
|
|
1907
1921
|
</dd>
|
|
1908
1922
|
</dl>
|
|
@@ -1971,7 +1985,7 @@ await client.checkCapture.checkProcessing({
|
|
|
1971
1985
|
<dl>
|
|
1972
1986
|
<dd>
|
|
1973
1987
|
|
|
1974
|
-
**requestOptions:** `
|
|
1988
|
+
**requestOptions:** `CheckCaptureClient.RequestOptions`
|
|
1975
1989
|
|
|
1976
1990
|
</dd>
|
|
1977
1991
|
</dl>
|
|
@@ -2046,7 +2060,7 @@ await client.cloud.addDevice("8cfec329267", {
|
|
|
2046
2060
|
<dl>
|
|
2047
2061
|
<dd>
|
|
2048
2062
|
|
|
2049
|
-
**requestOptions:** `
|
|
2063
|
+
**requestOptions:** `CloudClient.RequestOptions`
|
|
2050
2064
|
|
|
2051
2065
|
</dd>
|
|
2052
2066
|
</dl>
|
|
@@ -2058,7 +2072,7 @@ await client.cloud.addDevice("8cfec329267", {
|
|
|
2058
2072
|
</dl>
|
|
2059
2073
|
</details>
|
|
2060
2074
|
|
|
2061
|
-
<details><summary><code>client.cloud.<a href="/src/api/resources/cloud/client/Client.ts">historyDevice</a>(
|
|
2075
|
+
<details><summary><code>client.cloud.<a href="/src/api/resources/cloud/client/Client.ts">historyDevice</a>(entry, deviceId) -> Payabli.CloudQueryApiResponse</code></summary>
|
|
2062
2076
|
<dl>
|
|
2063
2077
|
<dd>
|
|
2064
2078
|
|
|
@@ -2085,7 +2099,7 @@ Retrieve the registration history for a device.
|
|
|
2085
2099
|
<dd>
|
|
2086
2100
|
|
|
2087
2101
|
```typescript
|
|
2088
|
-
await client.cloud.historyDevice("
|
|
2102
|
+
await client.cloud.historyDevice("8cfec329267", "WXGDWB");
|
|
2089
2103
|
|
|
2090
2104
|
```
|
|
2091
2105
|
</dd>
|
|
@@ -2101,7 +2115,7 @@ await client.cloud.historyDevice("WXGDWB", "8cfec329267");
|
|
|
2101
2115
|
<dl>
|
|
2102
2116
|
<dd>
|
|
2103
2117
|
|
|
2104
|
-
**
|
|
2118
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2105
2119
|
|
|
2106
2120
|
</dd>
|
|
2107
2121
|
</dl>
|
|
@@ -2109,7 +2123,7 @@ await client.cloud.historyDevice("WXGDWB", "8cfec329267");
|
|
|
2109
2123
|
<dl>
|
|
2110
2124
|
<dd>
|
|
2111
2125
|
|
|
2112
|
-
**
|
|
2126
|
+
**deviceId:** `string` — ID of the cloud device.
|
|
2113
2127
|
|
|
2114
2128
|
</dd>
|
|
2115
2129
|
</dl>
|
|
@@ -2117,7 +2131,7 @@ await client.cloud.historyDevice("WXGDWB", "8cfec329267");
|
|
|
2117
2131
|
<dl>
|
|
2118
2132
|
<dd>
|
|
2119
2133
|
|
|
2120
|
-
**requestOptions:** `
|
|
2134
|
+
**requestOptions:** `CloudClient.RequestOptions`
|
|
2121
2135
|
|
|
2122
2136
|
</dd>
|
|
2123
2137
|
</dl>
|
|
@@ -2188,7 +2202,7 @@ await client.cloud.listDevice("8cfec329267");
|
|
|
2188
2202
|
<dl>
|
|
2189
2203
|
<dd>
|
|
2190
2204
|
|
|
2191
|
-
**requestOptions:** `
|
|
2205
|
+
**requestOptions:** `CloudClient.RequestOptions`
|
|
2192
2206
|
|
|
2193
2207
|
</dd>
|
|
2194
2208
|
</dl>
|
|
@@ -2200,7 +2214,7 @@ await client.cloud.listDevice("8cfec329267");
|
|
|
2200
2214
|
</dl>
|
|
2201
2215
|
</details>
|
|
2202
2216
|
|
|
2203
|
-
<details><summary><code>client.cloud.<a href="/src/api/resources/cloud/client/Client.ts">removeDevice</a>(
|
|
2217
|
+
<details><summary><code>client.cloud.<a href="/src/api/resources/cloud/client/Client.ts">removeDevice</a>(entry, deviceId) -> Payabli.RemoveDeviceResponse</code></summary>
|
|
2204
2218
|
<dl>
|
|
2205
2219
|
<dd>
|
|
2206
2220
|
|
|
@@ -2227,7 +2241,7 @@ Remove a cloud device from an entrypoint.
|
|
|
2227
2241
|
<dd>
|
|
2228
2242
|
|
|
2229
2243
|
```typescript
|
|
2230
|
-
await client.cloud.removeDevice("6c361c7d-674c-44cc-b790-382b75d1xxx"
|
|
2244
|
+
await client.cloud.removeDevice("8cfec329267", "6c361c7d-674c-44cc-b790-382b75d1xxx");
|
|
2231
2245
|
|
|
2232
2246
|
```
|
|
2233
2247
|
</dd>
|
|
@@ -2243,7 +2257,7 @@ await client.cloud.removeDevice("6c361c7d-674c-44cc-b790-382b75d1xxx", "8cfec329
|
|
|
2243
2257
|
<dl>
|
|
2244
2258
|
<dd>
|
|
2245
2259
|
|
|
2246
|
-
**
|
|
2260
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2247
2261
|
|
|
2248
2262
|
</dd>
|
|
2249
2263
|
</dl>
|
|
@@ -2251,7 +2265,7 @@ await client.cloud.removeDevice("6c361c7d-674c-44cc-b790-382b75d1xxx", "8cfec329
|
|
|
2251
2265
|
<dl>
|
|
2252
2266
|
<dd>
|
|
2253
2267
|
|
|
2254
|
-
**
|
|
2268
|
+
**deviceId:** `string` — ID of the cloud device.
|
|
2255
2269
|
|
|
2256
2270
|
</dd>
|
|
2257
2271
|
</dl>
|
|
@@ -2259,7 +2273,7 @@ await client.cloud.removeDevice("6c361c7d-674c-44cc-b790-382b75d1xxx", "8cfec329
|
|
|
2259
2273
|
<dl>
|
|
2260
2274
|
<dd>
|
|
2261
2275
|
|
|
2262
|
-
**requestOptions:** `
|
|
2276
|
+
**requestOptions:** `CloudClient.RequestOptions`
|
|
2263
2277
|
|
|
2264
2278
|
</dd>
|
|
2265
2279
|
</dl>
|
|
@@ -2346,7 +2360,7 @@ await client.customer.addCustomer("8cfec329267", {
|
|
|
2346
2360
|
<dl>
|
|
2347
2361
|
<dd>
|
|
2348
2362
|
|
|
2349
|
-
**requestOptions:** `
|
|
2363
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2350
2364
|
|
|
2351
2365
|
</dd>
|
|
2352
2366
|
</dl>
|
|
@@ -2409,7 +2423,7 @@ await client.customer.deleteCustomer(998);
|
|
|
2409
2423
|
<dl>
|
|
2410
2424
|
<dd>
|
|
2411
2425
|
|
|
2412
|
-
**requestOptions:** `
|
|
2426
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2413
2427
|
|
|
2414
2428
|
</dd>
|
|
2415
2429
|
</dl>
|
|
@@ -2472,7 +2486,7 @@ await client.customer.getCustomer(998);
|
|
|
2472
2486
|
<dl>
|
|
2473
2487
|
<dd>
|
|
2474
2488
|
|
|
2475
|
-
**requestOptions:** `
|
|
2489
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2476
2490
|
|
|
2477
2491
|
</dd>
|
|
2478
2492
|
</dl>
|
|
@@ -2543,7 +2557,7 @@ await client.customer.linkCustomerTransaction(998, "45-as456777hhhhhhhhhh7777777
|
|
|
2543
2557
|
<dl>
|
|
2544
2558
|
<dd>
|
|
2545
2559
|
|
|
2546
|
-
**requestOptions:** `
|
|
2560
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2547
2561
|
|
|
2548
2562
|
</dd>
|
|
2549
2563
|
</dl>
|
|
@@ -2606,7 +2620,7 @@ await client.customer.requestConsent(998);
|
|
|
2606
2620
|
<dl>
|
|
2607
2621
|
<dd>
|
|
2608
2622
|
|
|
2609
|
-
**requestOptions:** `
|
|
2623
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2610
2624
|
|
|
2611
2625
|
</dd>
|
|
2612
2626
|
</dl>
|
|
@@ -2685,7 +2699,7 @@ await client.customer.updateCustomer(998, {
|
|
|
2685
2699
|
<dl>
|
|
2686
2700
|
<dd>
|
|
2687
2701
|
|
|
2688
|
-
**requestOptions:** `
|
|
2702
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2689
2703
|
|
|
2690
2704
|
</dd>
|
|
2691
2705
|
</dl>
|
|
@@ -2769,7 +2783,7 @@ await client.export.exportApplications("csv", 123, {
|
|
|
2769
2783
|
<dl>
|
|
2770
2784
|
<dd>
|
|
2771
2785
|
|
|
2772
|
-
**requestOptions:** `
|
|
2786
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
2773
2787
|
|
|
2774
2788
|
</dd>
|
|
2775
2789
|
</dl>
|
|
@@ -2781,10 +2795,24 @@ await client.export.exportApplications("csv", 123, {
|
|
|
2781
2795
|
</dl>
|
|
2782
2796
|
</details>
|
|
2783
2797
|
|
|
2784
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatchDetails</a>(
|
|
2798
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatchDetails</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
2799
|
+
<dl>
|
|
2800
|
+
<dd>
|
|
2801
|
+
|
|
2802
|
+
#### 📝 Description
|
|
2803
|
+
|
|
2785
2804
|
<dl>
|
|
2786
2805
|
<dd>
|
|
2787
2806
|
|
|
2807
|
+
<dl>
|
|
2808
|
+
<dd>
|
|
2809
|
+
|
|
2810
|
+
This endpoint is deprecated. Export batch details for a paypoint. Use filters to limit results.
|
|
2811
|
+
</dd>
|
|
2812
|
+
</dl>
|
|
2813
|
+
</dd>
|
|
2814
|
+
</dl>
|
|
2815
|
+
|
|
2788
2816
|
#### 🔌 Usage
|
|
2789
2817
|
|
|
2790
2818
|
<dl>
|
|
@@ -2794,7 +2822,7 @@ await client.export.exportApplications("csv", 123, {
|
|
|
2794
2822
|
<dd>
|
|
2795
2823
|
|
|
2796
2824
|
```typescript
|
|
2797
|
-
await client.export.exportBatchDetails("
|
|
2825
|
+
await client.export.exportBatchDetails("csv", "8cfec329267", {
|
|
2798
2826
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
2799
2827
|
fromRecord: 251,
|
|
2800
2828
|
limitRecord: 1000
|
|
@@ -2814,7 +2842,7 @@ await client.export.exportBatchDetails("8cfec329267", "csv", {
|
|
|
2814
2842
|
<dl>
|
|
2815
2843
|
<dd>
|
|
2816
2844
|
|
|
2817
|
-
**
|
|
2845
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
2818
2846
|
|
|
2819
2847
|
</dd>
|
|
2820
2848
|
</dl>
|
|
@@ -2822,7 +2850,7 @@ await client.export.exportBatchDetails("8cfec329267", "csv", {
|
|
|
2822
2850
|
<dl>
|
|
2823
2851
|
<dd>
|
|
2824
2852
|
|
|
2825
|
-
**
|
|
2853
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2826
2854
|
|
|
2827
2855
|
</dd>
|
|
2828
2856
|
</dl>
|
|
@@ -2838,7 +2866,7 @@ await client.export.exportBatchDetails("8cfec329267", "csv", {
|
|
|
2838
2866
|
<dl>
|
|
2839
2867
|
<dd>
|
|
2840
2868
|
|
|
2841
|
-
**requestOptions:** `
|
|
2869
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
2842
2870
|
|
|
2843
2871
|
</dd>
|
|
2844
2872
|
</dl>
|
|
@@ -2854,6 +2882,20 @@ await client.export.exportBatchDetails("8cfec329267", "csv", {
|
|
|
2854
2882
|
<dl>
|
|
2855
2883
|
<dd>
|
|
2856
2884
|
|
|
2885
|
+
#### 📝 Description
|
|
2886
|
+
|
|
2887
|
+
<dl>
|
|
2888
|
+
<dd>
|
|
2889
|
+
|
|
2890
|
+
<dl>
|
|
2891
|
+
<dd>
|
|
2892
|
+
|
|
2893
|
+
This endpoint is deprecated. Export batch details for an organization. Use filters to limit results.
|
|
2894
|
+
</dd>
|
|
2895
|
+
</dl>
|
|
2896
|
+
</dd>
|
|
2897
|
+
</dl>
|
|
2898
|
+
|
|
2857
2899
|
#### 🔌 Usage
|
|
2858
2900
|
|
|
2859
2901
|
<dl>
|
|
@@ -2907,7 +2949,7 @@ await client.export.exportBatchDetailsOrg("csv", 123, {
|
|
|
2907
2949
|
<dl>
|
|
2908
2950
|
<dd>
|
|
2909
2951
|
|
|
2910
|
-
**requestOptions:** `
|
|
2952
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
2911
2953
|
|
|
2912
2954
|
</dd>
|
|
2913
2955
|
</dl>
|
|
@@ -2919,7 +2961,7 @@ await client.export.exportBatchDetailsOrg("csv", 123, {
|
|
|
2919
2961
|
</dl>
|
|
2920
2962
|
</details>
|
|
2921
2963
|
|
|
2922
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatches</a>(
|
|
2964
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatches</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
2923
2965
|
<dl>
|
|
2924
2966
|
<dd>
|
|
2925
2967
|
|
|
@@ -2946,7 +2988,7 @@ Export a list of batches for an entrypoint. Use filters to limit results.
|
|
|
2946
2988
|
<dd>
|
|
2947
2989
|
|
|
2948
2990
|
```typescript
|
|
2949
|
-
await client.export.exportBatches("
|
|
2991
|
+
await client.export.exportBatches("csv", "8cfec329267", {
|
|
2950
2992
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
2951
2993
|
fromRecord: 251,
|
|
2952
2994
|
limitRecord: 1000
|
|
@@ -2966,7 +3008,7 @@ await client.export.exportBatches("8cfec329267", "csv", {
|
|
|
2966
3008
|
<dl>
|
|
2967
3009
|
<dd>
|
|
2968
3010
|
|
|
2969
|
-
**
|
|
3011
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
2970
3012
|
|
|
2971
3013
|
</dd>
|
|
2972
3014
|
</dl>
|
|
@@ -2974,7 +3016,7 @@ await client.export.exportBatches("8cfec329267", "csv", {
|
|
|
2974
3016
|
<dl>
|
|
2975
3017
|
<dd>
|
|
2976
3018
|
|
|
2977
|
-
**
|
|
3019
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2978
3020
|
|
|
2979
3021
|
</dd>
|
|
2980
3022
|
</dl>
|
|
@@ -2990,7 +3032,7 @@ await client.export.exportBatches("8cfec329267", "csv", {
|
|
|
2990
3032
|
<dl>
|
|
2991
3033
|
<dd>
|
|
2992
3034
|
|
|
2993
|
-
**requestOptions:** `
|
|
3035
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
2994
3036
|
|
|
2995
3037
|
</dd>
|
|
2996
3038
|
</dl>
|
|
@@ -3073,7 +3115,7 @@ await client.export.exportBatchesOrg("csv", 123, {
|
|
|
3073
3115
|
<dl>
|
|
3074
3116
|
<dd>
|
|
3075
3117
|
|
|
3076
|
-
**requestOptions:** `
|
|
3118
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3077
3119
|
|
|
3078
3120
|
</dd>
|
|
3079
3121
|
</dl>
|
|
@@ -3085,7 +3127,7 @@ await client.export.exportBatchesOrg("csv", 123, {
|
|
|
3085
3127
|
</dl>
|
|
3086
3128
|
</details>
|
|
3087
3129
|
|
|
3088
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatchesOut</a>(
|
|
3130
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatchesOut</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3089
3131
|
<dl>
|
|
3090
3132
|
<dd>
|
|
3091
3133
|
|
|
@@ -3112,7 +3154,7 @@ Export a list of money out batches for a paypoint. Use filters to limit results.
|
|
|
3112
3154
|
<dd>
|
|
3113
3155
|
|
|
3114
3156
|
```typescript
|
|
3115
|
-
await client.export.exportBatchesOut("
|
|
3157
|
+
await client.export.exportBatchesOut("csv", "8cfec329267", {
|
|
3116
3158
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3117
3159
|
fromRecord: 251,
|
|
3118
3160
|
limitRecord: 1000
|
|
@@ -3132,7 +3174,7 @@ await client.export.exportBatchesOut("8cfec329267", "csv", {
|
|
|
3132
3174
|
<dl>
|
|
3133
3175
|
<dd>
|
|
3134
3176
|
|
|
3135
|
-
**
|
|
3177
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3136
3178
|
|
|
3137
3179
|
</dd>
|
|
3138
3180
|
</dl>
|
|
@@ -3140,7 +3182,7 @@ await client.export.exportBatchesOut("8cfec329267", "csv", {
|
|
|
3140
3182
|
<dl>
|
|
3141
3183
|
<dd>
|
|
3142
3184
|
|
|
3143
|
-
**
|
|
3185
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3144
3186
|
|
|
3145
3187
|
</dd>
|
|
3146
3188
|
</dl>
|
|
@@ -3156,7 +3198,7 @@ await client.export.exportBatchesOut("8cfec329267", "csv", {
|
|
|
3156
3198
|
<dl>
|
|
3157
3199
|
<dd>
|
|
3158
3200
|
|
|
3159
|
-
**requestOptions:** `
|
|
3201
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3160
3202
|
|
|
3161
3203
|
</dd>
|
|
3162
3204
|
</dl>
|
|
@@ -3239,7 +3281,7 @@ await client.export.exportBatchesOutOrg("csv", 123, {
|
|
|
3239
3281
|
<dl>
|
|
3240
3282
|
<dd>
|
|
3241
3283
|
|
|
3242
|
-
**requestOptions:** `
|
|
3284
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3243
3285
|
|
|
3244
3286
|
</dd>
|
|
3245
3287
|
</dl>
|
|
@@ -3251,7 +3293,7 @@ await client.export.exportBatchesOutOrg("csv", 123, {
|
|
|
3251
3293
|
</dl>
|
|
3252
3294
|
</details>
|
|
3253
3295
|
|
|
3254
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBills</a>(
|
|
3296
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBills</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3255
3297
|
<dl>
|
|
3256
3298
|
<dd>
|
|
3257
3299
|
|
|
@@ -3278,7 +3320,7 @@ Export a list of bills for an entrypoint. Use filters to limit results.
|
|
|
3278
3320
|
<dd>
|
|
3279
3321
|
|
|
3280
3322
|
```typescript
|
|
3281
|
-
await client.export.exportBills("
|
|
3323
|
+
await client.export.exportBills("csv", "8cfec329267", {
|
|
3282
3324
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3283
3325
|
fromRecord: 251,
|
|
3284
3326
|
limitRecord: 1000
|
|
@@ -3298,7 +3340,7 @@ await client.export.exportBills("8cfec329267", "csv", {
|
|
|
3298
3340
|
<dl>
|
|
3299
3341
|
<dd>
|
|
3300
3342
|
|
|
3301
|
-
**
|
|
3343
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3302
3344
|
|
|
3303
3345
|
</dd>
|
|
3304
3346
|
</dl>
|
|
@@ -3306,7 +3348,7 @@ await client.export.exportBills("8cfec329267", "csv", {
|
|
|
3306
3348
|
<dl>
|
|
3307
3349
|
<dd>
|
|
3308
3350
|
|
|
3309
|
-
**
|
|
3351
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3310
3352
|
|
|
3311
3353
|
</dd>
|
|
3312
3354
|
</dl>
|
|
@@ -3322,7 +3364,7 @@ await client.export.exportBills("8cfec329267", "csv", {
|
|
|
3322
3364
|
<dl>
|
|
3323
3365
|
<dd>
|
|
3324
3366
|
|
|
3325
|
-
**requestOptions:** `
|
|
3367
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3326
3368
|
|
|
3327
3369
|
</dd>
|
|
3328
3370
|
</dl>
|
|
@@ -3405,7 +3447,7 @@ await client.export.exportBillsOrg("csv", 123, {
|
|
|
3405
3447
|
<dl>
|
|
3406
3448
|
<dd>
|
|
3407
3449
|
|
|
3408
|
-
**requestOptions:** `
|
|
3450
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3409
3451
|
|
|
3410
3452
|
</dd>
|
|
3411
3453
|
</dl>
|
|
@@ -3417,7 +3459,7 @@ await client.export.exportBillsOrg("csv", 123, {
|
|
|
3417
3459
|
</dl>
|
|
3418
3460
|
</details>
|
|
3419
3461
|
|
|
3420
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportChargebacks</a>(
|
|
3462
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportChargebacks</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3421
3463
|
<dl>
|
|
3422
3464
|
<dd>
|
|
3423
3465
|
|
|
@@ -3444,7 +3486,7 @@ Export a list of chargebacks and ACH returns for an entrypoint. Use filters to l
|
|
|
3444
3486
|
<dd>
|
|
3445
3487
|
|
|
3446
3488
|
```typescript
|
|
3447
|
-
await client.export.exportChargebacks("
|
|
3489
|
+
await client.export.exportChargebacks("csv", "8cfec329267", {
|
|
3448
3490
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3449
3491
|
fromRecord: 251,
|
|
3450
3492
|
limitRecord: 1000
|
|
@@ -3464,7 +3506,7 @@ await client.export.exportChargebacks("8cfec329267", "csv", {
|
|
|
3464
3506
|
<dl>
|
|
3465
3507
|
<dd>
|
|
3466
3508
|
|
|
3467
|
-
**
|
|
3509
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3468
3510
|
|
|
3469
3511
|
</dd>
|
|
3470
3512
|
</dl>
|
|
@@ -3472,7 +3514,7 @@ await client.export.exportChargebacks("8cfec329267", "csv", {
|
|
|
3472
3514
|
<dl>
|
|
3473
3515
|
<dd>
|
|
3474
3516
|
|
|
3475
|
-
**
|
|
3517
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3476
3518
|
|
|
3477
3519
|
</dd>
|
|
3478
3520
|
</dl>
|
|
@@ -3488,7 +3530,7 @@ await client.export.exportChargebacks("8cfec329267", "csv", {
|
|
|
3488
3530
|
<dl>
|
|
3489
3531
|
<dd>
|
|
3490
3532
|
|
|
3491
|
-
**requestOptions:** `
|
|
3533
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3492
3534
|
|
|
3493
3535
|
</dd>
|
|
3494
3536
|
</dl>
|
|
@@ -3571,7 +3613,7 @@ await client.export.exportChargebacksOrg("csv", 123, {
|
|
|
3571
3613
|
<dl>
|
|
3572
3614
|
<dd>
|
|
3573
3615
|
|
|
3574
|
-
**requestOptions:** `
|
|
3616
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3575
3617
|
|
|
3576
3618
|
</dd>
|
|
3577
3619
|
</dl>
|
|
@@ -3583,7 +3625,7 @@ await client.export.exportChargebacksOrg("csv", 123, {
|
|
|
3583
3625
|
</dl>
|
|
3584
3626
|
</details>
|
|
3585
3627
|
|
|
3586
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportCustomers</a>(
|
|
3628
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportCustomers</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3587
3629
|
<dl>
|
|
3588
3630
|
<dd>
|
|
3589
3631
|
|
|
@@ -3610,7 +3652,7 @@ Export a list of customers for an entrypoint. Use filters to limit results.
|
|
|
3610
3652
|
<dd>
|
|
3611
3653
|
|
|
3612
3654
|
```typescript
|
|
3613
|
-
await client.export.exportCustomers("
|
|
3655
|
+
await client.export.exportCustomers("csv", "8cfec329267", {
|
|
3614
3656
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3615
3657
|
fromRecord: 251,
|
|
3616
3658
|
limitRecord: 1000
|
|
@@ -3630,7 +3672,7 @@ await client.export.exportCustomers("8cfec329267", "csv", {
|
|
|
3630
3672
|
<dl>
|
|
3631
3673
|
<dd>
|
|
3632
3674
|
|
|
3633
|
-
**
|
|
3675
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3634
3676
|
|
|
3635
3677
|
</dd>
|
|
3636
3678
|
</dl>
|
|
@@ -3638,7 +3680,7 @@ await client.export.exportCustomers("8cfec329267", "csv", {
|
|
|
3638
3680
|
<dl>
|
|
3639
3681
|
<dd>
|
|
3640
3682
|
|
|
3641
|
-
**
|
|
3683
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3642
3684
|
|
|
3643
3685
|
</dd>
|
|
3644
3686
|
</dl>
|
|
@@ -3654,7 +3696,7 @@ await client.export.exportCustomers("8cfec329267", "csv", {
|
|
|
3654
3696
|
<dl>
|
|
3655
3697
|
<dd>
|
|
3656
3698
|
|
|
3657
|
-
**requestOptions:** `
|
|
3699
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3658
3700
|
|
|
3659
3701
|
</dd>
|
|
3660
3702
|
</dl>
|
|
@@ -3737,7 +3779,7 @@ await client.export.exportCustomersOrg("csv", 123, {
|
|
|
3737
3779
|
<dl>
|
|
3738
3780
|
<dd>
|
|
3739
3781
|
|
|
3740
|
-
**requestOptions:** `
|
|
3782
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3741
3783
|
|
|
3742
3784
|
</dd>
|
|
3743
3785
|
</dl>
|
|
@@ -3749,7 +3791,7 @@ await client.export.exportCustomersOrg("csv", 123, {
|
|
|
3749
3791
|
</dl>
|
|
3750
3792
|
</details>
|
|
3751
3793
|
|
|
3752
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportInvoices</a>(
|
|
3794
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportInvoices</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3753
3795
|
<dl>
|
|
3754
3796
|
<dd>
|
|
3755
3797
|
|
|
@@ -3776,7 +3818,7 @@ Export list of invoices for an entrypoint. Use filters to limit results.
|
|
|
3776
3818
|
<dd>
|
|
3777
3819
|
|
|
3778
3820
|
```typescript
|
|
3779
|
-
await client.export.exportInvoices("
|
|
3821
|
+
await client.export.exportInvoices("csv", "8cfec329267", {
|
|
3780
3822
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3781
3823
|
fromRecord: 251,
|
|
3782
3824
|
limitRecord: 1000
|
|
@@ -3796,7 +3838,7 @@ await client.export.exportInvoices("8cfec329267", "csv", {
|
|
|
3796
3838
|
<dl>
|
|
3797
3839
|
<dd>
|
|
3798
3840
|
|
|
3799
|
-
**
|
|
3841
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3800
3842
|
|
|
3801
3843
|
</dd>
|
|
3802
3844
|
</dl>
|
|
@@ -3804,7 +3846,7 @@ await client.export.exportInvoices("8cfec329267", "csv", {
|
|
|
3804
3846
|
<dl>
|
|
3805
3847
|
<dd>
|
|
3806
3848
|
|
|
3807
|
-
**
|
|
3849
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3808
3850
|
|
|
3809
3851
|
</dd>
|
|
3810
3852
|
</dl>
|
|
@@ -3820,7 +3862,7 @@ await client.export.exportInvoices("8cfec329267", "csv", {
|
|
|
3820
3862
|
<dl>
|
|
3821
3863
|
<dd>
|
|
3822
3864
|
|
|
3823
|
-
**requestOptions:** `
|
|
3865
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3824
3866
|
|
|
3825
3867
|
</dd>
|
|
3826
3868
|
</dl>
|
|
@@ -3903,7 +3945,7 @@ await client.export.exportInvoicesOrg("csv", 123, {
|
|
|
3903
3945
|
<dl>
|
|
3904
3946
|
<dd>
|
|
3905
3947
|
|
|
3906
|
-
**requestOptions:** `
|
|
3948
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3907
3949
|
|
|
3908
3950
|
</dd>
|
|
3909
3951
|
</dl>
|
|
@@ -3986,7 +4028,7 @@ await client.export.exportOrganizations("csv", 123, {
|
|
|
3986
4028
|
<dl>
|
|
3987
4029
|
<dd>
|
|
3988
4030
|
|
|
3989
|
-
**requestOptions:** `
|
|
4031
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3990
4032
|
|
|
3991
4033
|
</dd>
|
|
3992
4034
|
</dl>
|
|
@@ -3998,7 +4040,7 @@ await client.export.exportOrganizations("csv", 123, {
|
|
|
3998
4040
|
</dl>
|
|
3999
4041
|
</details>
|
|
4000
4042
|
|
|
4001
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportPayout</a>(
|
|
4043
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportPayout</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4002
4044
|
<dl>
|
|
4003
4045
|
<dd>
|
|
4004
4046
|
|
|
@@ -4025,7 +4067,7 @@ Export a list of payouts and their statuses for an entrypoint. Use filters to li
|
|
|
4025
4067
|
<dd>
|
|
4026
4068
|
|
|
4027
4069
|
```typescript
|
|
4028
|
-
await client.export.exportPayout("
|
|
4070
|
+
await client.export.exportPayout("csv", "8cfec329267", {
|
|
4029
4071
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4030
4072
|
fromRecord: 251,
|
|
4031
4073
|
limitRecord: 1000
|
|
@@ -4045,7 +4087,7 @@ await client.export.exportPayout("8cfec329267", "csv", {
|
|
|
4045
4087
|
<dl>
|
|
4046
4088
|
<dd>
|
|
4047
4089
|
|
|
4048
|
-
**
|
|
4090
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4049
4091
|
|
|
4050
4092
|
</dd>
|
|
4051
4093
|
</dl>
|
|
@@ -4053,7 +4095,7 @@ await client.export.exportPayout("8cfec329267", "csv", {
|
|
|
4053
4095
|
<dl>
|
|
4054
4096
|
<dd>
|
|
4055
4097
|
|
|
4056
|
-
**
|
|
4098
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4057
4099
|
|
|
4058
4100
|
</dd>
|
|
4059
4101
|
</dl>
|
|
@@ -4069,7 +4111,7 @@ await client.export.exportPayout("8cfec329267", "csv", {
|
|
|
4069
4111
|
<dl>
|
|
4070
4112
|
<dd>
|
|
4071
4113
|
|
|
4072
|
-
**requestOptions:** `
|
|
4114
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4073
4115
|
|
|
4074
4116
|
</dd>
|
|
4075
4117
|
</dl>
|
|
@@ -4152,7 +4194,7 @@ await client.export.exportPayoutOrg("csv", 123, {
|
|
|
4152
4194
|
<dl>
|
|
4153
4195
|
<dd>
|
|
4154
4196
|
|
|
4155
|
-
**requestOptions:** `
|
|
4197
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4156
4198
|
|
|
4157
4199
|
</dd>
|
|
4158
4200
|
</dl>
|
|
@@ -4235,7 +4277,7 @@ await client.export.exportPaypoints("csv", 123, {
|
|
|
4235
4277
|
<dl>
|
|
4236
4278
|
<dd>
|
|
4237
4279
|
|
|
4238
|
-
**requestOptions:** `
|
|
4280
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4239
4281
|
|
|
4240
4282
|
</dd>
|
|
4241
4283
|
</dl>
|
|
@@ -4247,7 +4289,7 @@ await client.export.exportPaypoints("csv", 123, {
|
|
|
4247
4289
|
</dl>
|
|
4248
4290
|
</details>
|
|
4249
4291
|
|
|
4250
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportSettlements</a>(
|
|
4292
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportSettlements</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4251
4293
|
<dl>
|
|
4252
4294
|
<dd>
|
|
4253
4295
|
|
|
@@ -4274,7 +4316,7 @@ Export a list of settled transactions for an entrypoint. Use filters to limit re
|
|
|
4274
4316
|
<dd>
|
|
4275
4317
|
|
|
4276
4318
|
```typescript
|
|
4277
|
-
await client.export.exportSettlements("
|
|
4319
|
+
await client.export.exportSettlements("csv", "8cfec329267", {
|
|
4278
4320
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4279
4321
|
fromRecord: 251,
|
|
4280
4322
|
limitRecord: 1000
|
|
@@ -4294,7 +4336,7 @@ await client.export.exportSettlements("8cfec329267", "csv", {
|
|
|
4294
4336
|
<dl>
|
|
4295
4337
|
<dd>
|
|
4296
4338
|
|
|
4297
|
-
**
|
|
4339
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4298
4340
|
|
|
4299
4341
|
</dd>
|
|
4300
4342
|
</dl>
|
|
@@ -4302,7 +4344,7 @@ await client.export.exportSettlements("8cfec329267", "csv", {
|
|
|
4302
4344
|
<dl>
|
|
4303
4345
|
<dd>
|
|
4304
4346
|
|
|
4305
|
-
**
|
|
4347
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4306
4348
|
|
|
4307
4349
|
</dd>
|
|
4308
4350
|
</dl>
|
|
@@ -4318,7 +4360,7 @@ await client.export.exportSettlements("8cfec329267", "csv", {
|
|
|
4318
4360
|
<dl>
|
|
4319
4361
|
<dd>
|
|
4320
4362
|
|
|
4321
|
-
**requestOptions:** `
|
|
4363
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4322
4364
|
|
|
4323
4365
|
</dd>
|
|
4324
4366
|
</dl>
|
|
@@ -4401,7 +4443,7 @@ await client.export.exportSettlementsOrg("csv", 123, {
|
|
|
4401
4443
|
<dl>
|
|
4402
4444
|
<dd>
|
|
4403
4445
|
|
|
4404
|
-
**requestOptions:** `
|
|
4446
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4405
4447
|
|
|
4406
4448
|
</dd>
|
|
4407
4449
|
</dl>
|
|
@@ -4413,7 +4455,7 @@ await client.export.exportSettlementsOrg("csv", 123, {
|
|
|
4413
4455
|
</dl>
|
|
4414
4456
|
</details>
|
|
4415
4457
|
|
|
4416
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportSubscriptions</a>(
|
|
4458
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportSubscriptions</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4417
4459
|
<dl>
|
|
4418
4460
|
<dd>
|
|
4419
4461
|
|
|
@@ -4440,7 +4482,7 @@ Export a list of subscriptions for an entrypoint. Use filters to limit results.
|
|
|
4440
4482
|
<dd>
|
|
4441
4483
|
|
|
4442
4484
|
```typescript
|
|
4443
|
-
await client.export.exportSubscriptions("
|
|
4485
|
+
await client.export.exportSubscriptions("csv", "8cfec329267", {
|
|
4444
4486
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4445
4487
|
fromRecord: 251,
|
|
4446
4488
|
limitRecord: 1000
|
|
@@ -4460,7 +4502,7 @@ await client.export.exportSubscriptions("8cfec329267", "csv", {
|
|
|
4460
4502
|
<dl>
|
|
4461
4503
|
<dd>
|
|
4462
4504
|
|
|
4463
|
-
**
|
|
4505
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4464
4506
|
|
|
4465
4507
|
</dd>
|
|
4466
4508
|
</dl>
|
|
@@ -4468,7 +4510,7 @@ await client.export.exportSubscriptions("8cfec329267", "csv", {
|
|
|
4468
4510
|
<dl>
|
|
4469
4511
|
<dd>
|
|
4470
4512
|
|
|
4471
|
-
**
|
|
4513
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4472
4514
|
|
|
4473
4515
|
</dd>
|
|
4474
4516
|
</dl>
|
|
@@ -4484,7 +4526,7 @@ await client.export.exportSubscriptions("8cfec329267", "csv", {
|
|
|
4484
4526
|
<dl>
|
|
4485
4527
|
<dd>
|
|
4486
4528
|
|
|
4487
|
-
**requestOptions:** `
|
|
4529
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4488
4530
|
|
|
4489
4531
|
</dd>
|
|
4490
4532
|
</dl>
|
|
@@ -4567,7 +4609,7 @@ await client.export.exportSubscriptionsOrg("csv", 123, {
|
|
|
4567
4609
|
<dl>
|
|
4568
4610
|
<dd>
|
|
4569
4611
|
|
|
4570
|
-
**requestOptions:** `
|
|
4612
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4571
4613
|
|
|
4572
4614
|
</dd>
|
|
4573
4615
|
</dl>
|
|
@@ -4579,7 +4621,7 @@ await client.export.exportSubscriptionsOrg("csv", 123, {
|
|
|
4579
4621
|
</dl>
|
|
4580
4622
|
</details>
|
|
4581
4623
|
|
|
4582
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportTransactions</a>(
|
|
4624
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportTransactions</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4583
4625
|
<dl>
|
|
4584
4626
|
<dd>
|
|
4585
4627
|
|
|
@@ -4606,7 +4648,7 @@ Export a list of transactions for an entrypoint in a file in XLXS or CSV format.
|
|
|
4606
4648
|
<dd>
|
|
4607
4649
|
|
|
4608
4650
|
```typescript
|
|
4609
|
-
await client.export.exportTransactions("
|
|
4651
|
+
await client.export.exportTransactions("csv", "8cfec329267", {
|
|
4610
4652
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4611
4653
|
fromRecord: 251,
|
|
4612
4654
|
limitRecord: 1000
|
|
@@ -4626,7 +4668,7 @@ await client.export.exportTransactions("8cfec329267", "csv", {
|
|
|
4626
4668
|
<dl>
|
|
4627
4669
|
<dd>
|
|
4628
4670
|
|
|
4629
|
-
**
|
|
4671
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4630
4672
|
|
|
4631
4673
|
</dd>
|
|
4632
4674
|
</dl>
|
|
@@ -4634,7 +4676,7 @@ await client.export.exportTransactions("8cfec329267", "csv", {
|
|
|
4634
4676
|
<dl>
|
|
4635
4677
|
<dd>
|
|
4636
4678
|
|
|
4637
|
-
**
|
|
4679
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4638
4680
|
|
|
4639
4681
|
</dd>
|
|
4640
4682
|
</dl>
|
|
@@ -4650,7 +4692,7 @@ await client.export.exportTransactions("8cfec329267", "csv", {
|
|
|
4650
4692
|
<dl>
|
|
4651
4693
|
<dd>
|
|
4652
4694
|
|
|
4653
|
-
**requestOptions:** `
|
|
4695
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4654
4696
|
|
|
4655
4697
|
</dd>
|
|
4656
4698
|
</dl>
|
|
@@ -4733,7 +4775,7 @@ await client.export.exportTransactionsOrg("csv", 123, {
|
|
|
4733
4775
|
<dl>
|
|
4734
4776
|
<dd>
|
|
4735
4777
|
|
|
4736
|
-
**requestOptions:** `
|
|
4778
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4737
4779
|
|
|
4738
4780
|
</dd>
|
|
4739
4781
|
</dl>
|
|
@@ -4745,7 +4787,7 @@ await client.export.exportTransactionsOrg("csv", 123, {
|
|
|
4745
4787
|
</dl>
|
|
4746
4788
|
</details>
|
|
4747
4789
|
|
|
4748
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportTransferDetails</a>(
|
|
4790
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportTransferDetails</a>(format, entry, transferId, { ...params }) -> Payabli.File_</code></summary>
|
|
4749
4791
|
<dl>
|
|
4750
4792
|
<dd>
|
|
4751
4793
|
|
|
@@ -4772,7 +4814,7 @@ Export a list of transfer details for an entrypoint. Use filters to limit result
|
|
|
4772
4814
|
<dd>
|
|
4773
4815
|
|
|
4774
4816
|
```typescript
|
|
4775
|
-
await client.export.exportTransferDetails("
|
|
4817
|
+
await client.export.exportTransferDetails("csv", "8cfec329267", 1000000, {
|
|
4776
4818
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4777
4819
|
fromRecord: 251,
|
|
4778
4820
|
limitRecord: 1000,
|
|
@@ -4793,7 +4835,7 @@ await client.export.exportTransferDetails("8cfec329267", "csv", 1000000, {
|
|
|
4793
4835
|
<dl>
|
|
4794
4836
|
<dd>
|
|
4795
4837
|
|
|
4796
|
-
**
|
|
4838
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4797
4839
|
|
|
4798
4840
|
</dd>
|
|
4799
4841
|
</dl>
|
|
@@ -4801,7 +4843,7 @@ await client.export.exportTransferDetails("8cfec329267", "csv", 1000000, {
|
|
|
4801
4843
|
<dl>
|
|
4802
4844
|
<dd>
|
|
4803
4845
|
|
|
4804
|
-
**
|
|
4846
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4805
4847
|
|
|
4806
4848
|
</dd>
|
|
4807
4849
|
</dl>
|
|
@@ -4825,7 +4867,7 @@ await client.export.exportTransferDetails("8cfec329267", "csv", 1000000, {
|
|
|
4825
4867
|
<dl>
|
|
4826
4868
|
<dd>
|
|
4827
4869
|
|
|
4828
|
-
**requestOptions:** `
|
|
4870
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4829
4871
|
|
|
4830
4872
|
</dd>
|
|
4831
4873
|
</dl>
|
|
@@ -4901,7 +4943,7 @@ await client.export.exportTransfers("8cfec329267", {
|
|
|
4901
4943
|
<dl>
|
|
4902
4944
|
<dd>
|
|
4903
4945
|
|
|
4904
|
-
**requestOptions:** `
|
|
4946
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4905
4947
|
|
|
4906
4948
|
</dd>
|
|
4907
4949
|
</dl>
|
|
@@ -4913,7 +4955,7 @@ await client.export.exportTransfers("8cfec329267", {
|
|
|
4913
4955
|
</dl>
|
|
4914
4956
|
</details>
|
|
4915
4957
|
|
|
4916
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportVendors</a>(
|
|
4958
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportVendors</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4917
4959
|
<dl>
|
|
4918
4960
|
<dd>
|
|
4919
4961
|
|
|
@@ -4940,7 +4982,7 @@ Export a list of vendors for an entrypoint. Use filters to limit results.
|
|
|
4940
4982
|
<dd>
|
|
4941
4983
|
|
|
4942
4984
|
```typescript
|
|
4943
|
-
await client.export.exportVendors("
|
|
4985
|
+
await client.export.exportVendors("csv", "8cfec329267", {
|
|
4944
4986
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4945
4987
|
fromRecord: 251,
|
|
4946
4988
|
limitRecord: 1000
|
|
@@ -4960,7 +5002,7 @@ await client.export.exportVendors("8cfec329267", "csv", {
|
|
|
4960
5002
|
<dl>
|
|
4961
5003
|
<dd>
|
|
4962
5004
|
|
|
4963
|
-
**
|
|
5005
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4964
5006
|
|
|
4965
5007
|
</dd>
|
|
4966
5008
|
</dl>
|
|
@@ -4968,7 +5010,7 @@ await client.export.exportVendors("8cfec329267", "csv", {
|
|
|
4968
5010
|
<dl>
|
|
4969
5011
|
<dd>
|
|
4970
5012
|
|
|
4971
|
-
**
|
|
5013
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4972
5014
|
|
|
4973
5015
|
</dd>
|
|
4974
5016
|
</dl>
|
|
@@ -4984,7 +5026,7 @@ await client.export.exportVendors("8cfec329267", "csv", {
|
|
|
4984
5026
|
<dl>
|
|
4985
5027
|
<dd>
|
|
4986
5028
|
|
|
4987
|
-
**requestOptions:** `
|
|
5029
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4988
5030
|
|
|
4989
5031
|
</dd>
|
|
4990
5032
|
</dl>
|
|
@@ -5067,7 +5109,7 @@ await client.export.exportVendorsOrg("csv", 123, {
|
|
|
5067
5109
|
<dl>
|
|
5068
5110
|
<dd>
|
|
5069
5111
|
|
|
5070
|
-
**requestOptions:** `
|
|
5112
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
5071
5113
|
|
|
5072
5114
|
</dd>
|
|
5073
5115
|
</dl>
|
|
@@ -5139,7 +5181,7 @@ await client.hostedPaymentPages.loadPage("8cfec329267", "pay-your-fees-1");
|
|
|
5139
5181
|
<dl>
|
|
5140
5182
|
<dd>
|
|
5141
5183
|
|
|
5142
|
-
**requestOptions:** `
|
|
5184
|
+
**requestOptions:** `HostedPaymentPagesClient.RequestOptions`
|
|
5143
5185
|
|
|
5144
5186
|
</dd>
|
|
5145
5187
|
</dl>
|
|
@@ -5215,7 +5257,7 @@ await client.hostedPaymentPages.newPage("8cfec329267", {
|
|
|
5215
5257
|
<dl>
|
|
5216
5258
|
<dd>
|
|
5217
5259
|
|
|
5218
|
-
**requestOptions:** `
|
|
5260
|
+
**requestOptions:** `HostedPaymentPagesClient.RequestOptions`
|
|
5219
5261
|
|
|
5220
5262
|
</dd>
|
|
5221
5263
|
</dl>
|
|
@@ -5294,7 +5336,7 @@ await client.hostedPaymentPages.savePage("8cfec329267", "pay-your-fees-1", {});
|
|
|
5294
5336
|
<dl>
|
|
5295
5337
|
<dd>
|
|
5296
5338
|
|
|
5297
|
-
**requestOptions:** `
|
|
5339
|
+
**requestOptions:** `HostedPaymentPagesClient.RequestOptions`
|
|
5298
5340
|
|
|
5299
5341
|
</dd>
|
|
5300
5342
|
</dl>
|
|
@@ -5368,7 +5410,7 @@ await client.import.importBills("8cfec329267", {
|
|
|
5368
5410
|
<dl>
|
|
5369
5411
|
<dd>
|
|
5370
5412
|
|
|
5371
|
-
**requestOptions:** `
|
|
5413
|
+
**requestOptions:** `ImportClient.RequestOptions`
|
|
5372
5414
|
|
|
5373
5415
|
</dd>
|
|
5374
5416
|
</dl>
|
|
@@ -5441,7 +5483,7 @@ await client.import.importCustomer("8cfec329267", {
|
|
|
5441
5483
|
<dl>
|
|
5442
5484
|
<dd>
|
|
5443
5485
|
|
|
5444
|
-
**requestOptions:** `
|
|
5486
|
+
**requestOptions:** `ImportClient.RequestOptions`
|
|
5445
5487
|
|
|
5446
5488
|
</dd>
|
|
5447
5489
|
</dl>
|
|
@@ -5514,7 +5556,7 @@ await client.import.importVendor("8cfec329267", {
|
|
|
5514
5556
|
<dl>
|
|
5515
5557
|
<dd>
|
|
5516
5558
|
|
|
5517
|
-
**requestOptions:** `
|
|
5559
|
+
**requestOptions:** `ImportClient.RequestOptions`
|
|
5518
5560
|
|
|
5519
5561
|
</dd>
|
|
5520
5562
|
</dl>
|
|
@@ -5567,17 +5609,19 @@ await client.invoice.addInvoice("8cfec329267", {
|
|
|
5567
5609
|
itemDescription: "Consultation for Georgian tours",
|
|
5568
5610
|
itemCost: 100,
|
|
5569
5611
|
itemQty: 1,
|
|
5570
|
-
itemMode: 1
|
|
5612
|
+
itemMode: 1,
|
|
5613
|
+
itemTotalAmount: 1
|
|
5571
5614
|
}, {
|
|
5572
5615
|
itemProductName: "Deposit ",
|
|
5573
5616
|
itemDescription: "Deposit for trip planning",
|
|
5574
5617
|
itemCost: 882.37,
|
|
5575
|
-
itemQty: 1
|
|
5618
|
+
itemQty: 1,
|
|
5619
|
+
itemTotalAmount: 1
|
|
5576
5620
|
}],
|
|
5577
5621
|
invoiceDate: "2025-10-19",
|
|
5578
5622
|
invoiceType: 0,
|
|
5579
5623
|
invoiceStatus: 1,
|
|
5580
|
-
frequency: "
|
|
5624
|
+
frequency: "onetime",
|
|
5581
5625
|
invoiceAmount: 982.37,
|
|
5582
5626
|
discount: 10,
|
|
5583
5627
|
invoiceNumber: "INV-3"
|
|
@@ -5615,7 +5659,7 @@ await client.invoice.addInvoice("8cfec329267", {
|
|
|
5615
5659
|
<dl>
|
|
5616
5660
|
<dd>
|
|
5617
5661
|
|
|
5618
|
-
**requestOptions:** `
|
|
5662
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5619
5663
|
|
|
5620
5664
|
</dd>
|
|
5621
5665
|
</dl>
|
|
@@ -5627,7 +5671,7 @@ await client.invoice.addInvoice("8cfec329267", {
|
|
|
5627
5671
|
</dl>
|
|
5628
5672
|
</details>
|
|
5629
5673
|
|
|
5630
|
-
<details><summary><code>client.invoice.<a href="/src/api/resources/invoice/client/Client.ts">deleteAttachedFromInvoice</a>(
|
|
5674
|
+
<details><summary><code>client.invoice.<a href="/src/api/resources/invoice/client/Client.ts">deleteAttachedFromInvoice</a>(idInvoice, filename) -> Payabli.InvoiceResponseWithoutData</code></summary>
|
|
5631
5675
|
<dl>
|
|
5632
5676
|
<dd>
|
|
5633
5677
|
|
|
@@ -5654,7 +5698,7 @@ Deletes an invoice that's attached to a file.
|
|
|
5654
5698
|
<dd>
|
|
5655
5699
|
|
|
5656
5700
|
```typescript
|
|
5657
|
-
await client.invoice.deleteAttachedFromInvoice("0_Bill.pdf"
|
|
5701
|
+
await client.invoice.deleteAttachedFromInvoice(23548884, "0_Bill.pdf");
|
|
5658
5702
|
|
|
5659
5703
|
```
|
|
5660
5704
|
</dd>
|
|
@@ -5670,6 +5714,14 @@ await client.invoice.deleteAttachedFromInvoice("0_Bill.pdf", 23548884);
|
|
|
5670
5714
|
<dl>
|
|
5671
5715
|
<dd>
|
|
5672
5716
|
|
|
5717
|
+
**idInvoice:** `number` — Invoice ID
|
|
5718
|
+
|
|
5719
|
+
</dd>
|
|
5720
|
+
</dl>
|
|
5721
|
+
|
|
5722
|
+
<dl>
|
|
5723
|
+
<dd>
|
|
5724
|
+
|
|
5673
5725
|
**filename:** `string`
|
|
5674
5726
|
|
|
5675
5727
|
The filename in Payabli. Filename is `zipName` in response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
|
|
@@ -5690,15 +5742,7 @@ The filename in Payabli. Filename is `zipName` in response to a request to `/api
|
|
|
5690
5742
|
<dl>
|
|
5691
5743
|
<dd>
|
|
5692
5744
|
|
|
5693
|
-
**
|
|
5694
|
-
|
|
5695
|
-
</dd>
|
|
5696
|
-
</dl>
|
|
5697
|
-
|
|
5698
|
-
<dl>
|
|
5699
|
-
<dd>
|
|
5700
|
-
|
|
5701
|
-
**requestOptions:** `Invoice.RequestOptions`
|
|
5745
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5702
5746
|
|
|
5703
5747
|
</dd>
|
|
5704
5748
|
</dl>
|
|
@@ -5761,7 +5805,7 @@ await client.invoice.deleteInvoice(23548884);
|
|
|
5761
5805
|
<dl>
|
|
5762
5806
|
<dd>
|
|
5763
5807
|
|
|
5764
|
-
**requestOptions:** `
|
|
5808
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5765
5809
|
|
|
5766
5810
|
</dd>
|
|
5767
5811
|
</dl>
|
|
@@ -5846,7 +5890,7 @@ await client.invoice.editInvoice(332, {
|
|
|
5846
5890
|
<dl>
|
|
5847
5891
|
<dd>
|
|
5848
5892
|
|
|
5849
|
-
**requestOptions:** `
|
|
5893
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5850
5894
|
|
|
5851
5895
|
</dd>
|
|
5852
5896
|
</dl>
|
|
@@ -5858,7 +5902,7 @@ await client.invoice.editInvoice(332, {
|
|
|
5858
5902
|
</dl>
|
|
5859
5903
|
</details>
|
|
5860
5904
|
|
|
5861
|
-
<details><summary><code>client.invoice.<a href="/src/api/resources/invoice/client/Client.ts">getAttachedFileFromInvoice</a>(
|
|
5905
|
+
<details><summary><code>client.invoice.<a href="/src/api/resources/invoice/client/Client.ts">getAttachedFileFromInvoice</a>(idInvoice, filename, { ...params }) -> Payabli.FileContent</code></summary>
|
|
5862
5906
|
<dl>
|
|
5863
5907
|
<dd>
|
|
5864
5908
|
|
|
@@ -5885,7 +5929,7 @@ Retrieves a file attached to an invoice.
|
|
|
5885
5929
|
<dd>
|
|
5886
5930
|
|
|
5887
5931
|
```typescript
|
|
5888
|
-
await client.invoice.getAttachedFileFromInvoice("filename"
|
|
5932
|
+
await client.invoice.getAttachedFileFromInvoice(1, "filename");
|
|
5889
5933
|
|
|
5890
5934
|
```
|
|
5891
5935
|
</dd>
|
|
@@ -5901,6 +5945,14 @@ await client.invoice.getAttachedFileFromInvoice("filename", 1);
|
|
|
5901
5945
|
<dl>
|
|
5902
5946
|
<dd>
|
|
5903
5947
|
|
|
5948
|
+
**idInvoice:** `number` — Invoice ID
|
|
5949
|
+
|
|
5950
|
+
</dd>
|
|
5951
|
+
</dl>
|
|
5952
|
+
|
|
5953
|
+
<dl>
|
|
5954
|
+
<dd>
|
|
5955
|
+
|
|
5904
5956
|
**filename:** `string`
|
|
5905
5957
|
|
|
5906
5958
|
The filename in Payabli. Filename is `zipName` in the response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
|
|
@@ -5923,14 +5975,6 @@ The filename in Payabli. Filename is `zipName` in the response to a request to `
|
|
|
5923
5975
|
<dl>
|
|
5924
5976
|
<dd>
|
|
5925
5977
|
|
|
5926
|
-
**idInvoice:** `number` — Invoice ID
|
|
5927
|
-
|
|
5928
|
-
</dd>
|
|
5929
|
-
</dl>
|
|
5930
|
-
|
|
5931
|
-
<dl>
|
|
5932
|
-
<dd>
|
|
5933
|
-
|
|
5934
5978
|
**request:** `Payabli.GetAttachedFileFromInvoiceRequest`
|
|
5935
5979
|
|
|
5936
5980
|
</dd>
|
|
@@ -5939,7 +5983,7 @@ The filename in Payabli. Filename is `zipName` in the response to a request to `
|
|
|
5939
5983
|
<dl>
|
|
5940
5984
|
<dd>
|
|
5941
5985
|
|
|
5942
|
-
**requestOptions:** `
|
|
5986
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5943
5987
|
|
|
5944
5988
|
</dd>
|
|
5945
5989
|
</dl>
|
|
@@ -6002,7 +6046,7 @@ await client.invoice.getInvoice(23548884);
|
|
|
6002
6046
|
<dl>
|
|
6003
6047
|
<dd>
|
|
6004
6048
|
|
|
6005
|
-
**requestOptions:** `
|
|
6049
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6006
6050
|
|
|
6007
6051
|
</dd>
|
|
6008
6052
|
</dl>
|
|
@@ -6065,7 +6109,7 @@ await client.invoice.getInvoiceNumber("8cfec329267");
|
|
|
6065
6109
|
<dl>
|
|
6066
6110
|
<dd>
|
|
6067
6111
|
|
|
6068
|
-
**requestOptions:** `
|
|
6112
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6069
6113
|
|
|
6070
6114
|
</dd>
|
|
6071
6115
|
</dl>
|
|
@@ -6140,7 +6184,7 @@ await client.invoice.listInvoices("8cfec329267", {
|
|
|
6140
6184
|
<dl>
|
|
6141
6185
|
<dd>
|
|
6142
6186
|
|
|
6143
|
-
**requestOptions:** `
|
|
6187
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6144
6188
|
|
|
6145
6189
|
</dd>
|
|
6146
6190
|
</dl>
|
|
@@ -6215,7 +6259,7 @@ await client.invoice.listInvoicesOrg(123, {
|
|
|
6215
6259
|
<dl>
|
|
6216
6260
|
<dd>
|
|
6217
6261
|
|
|
6218
|
-
**requestOptions:** `
|
|
6262
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6219
6263
|
|
|
6220
6264
|
</dd>
|
|
6221
6265
|
</dl>
|
|
@@ -6289,7 +6333,7 @@ await client.invoice.sendInvoice(23548884, {
|
|
|
6289
6333
|
<dl>
|
|
6290
6334
|
<dd>
|
|
6291
6335
|
|
|
6292
|
-
**requestOptions:** `
|
|
6336
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6293
6337
|
|
|
6294
6338
|
</dd>
|
|
6295
6339
|
</dl>
|
|
@@ -6352,7 +6396,7 @@ await client.invoice.getInvoicePdf(23548884);
|
|
|
6352
6396
|
<dl>
|
|
6353
6397
|
<dd>
|
|
6354
6398
|
|
|
6355
|
-
**requestOptions:** `
|
|
6399
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6356
6400
|
|
|
6357
6401
|
</dd>
|
|
6358
6402
|
</dl>
|
|
@@ -6435,7 +6479,7 @@ await client.lineItem.addItem("47cae3d74", {
|
|
|
6435
6479
|
<dl>
|
|
6436
6480
|
<dd>
|
|
6437
6481
|
|
|
6438
|
-
**requestOptions:** `
|
|
6482
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6439
6483
|
|
|
6440
6484
|
</dd>
|
|
6441
6485
|
</dl>
|
|
@@ -6498,7 +6542,7 @@ await client.lineItem.deleteItem(700);
|
|
|
6498
6542
|
<dl>
|
|
6499
6543
|
<dd>
|
|
6500
6544
|
|
|
6501
|
-
**requestOptions:** `
|
|
6545
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6502
6546
|
|
|
6503
6547
|
</dd>
|
|
6504
6548
|
</dl>
|
|
@@ -6561,7 +6605,7 @@ await client.lineItem.getItem(700);
|
|
|
6561
6605
|
<dl>
|
|
6562
6606
|
<dd>
|
|
6563
6607
|
|
|
6564
|
-
**requestOptions:** `
|
|
6608
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6565
6609
|
|
|
6566
6610
|
</dd>
|
|
6567
6611
|
</dl>
|
|
@@ -6636,7 +6680,7 @@ await client.lineItem.listLineItems("8cfec329267", {
|
|
|
6636
6680
|
<dl>
|
|
6637
6681
|
<dd>
|
|
6638
6682
|
|
|
6639
|
-
**requestOptions:** `
|
|
6683
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6640
6684
|
|
|
6641
6685
|
</dd>
|
|
6642
6686
|
</dl>
|
|
@@ -6710,7 +6754,7 @@ await client.lineItem.updateItem(700, {
|
|
|
6710
6754
|
<dl>
|
|
6711
6755
|
<dd>
|
|
6712
6756
|
|
|
6713
|
-
**requestOptions:** `
|
|
6757
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6714
6758
|
|
|
6715
6759
|
</dd>
|
|
6716
6760
|
</dl>
|
|
@@ -6797,7 +6841,7 @@ await client.moneyIn.authorize({
|
|
|
6797
6841
|
<dl>
|
|
6798
6842
|
<dd>
|
|
6799
6843
|
|
|
6800
|
-
**requestOptions:** `
|
|
6844
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
6801
6845
|
|
|
6802
6846
|
</dd>
|
|
6803
6847
|
</dl>
|
|
@@ -6809,7 +6853,7 @@ await client.moneyIn.authorize({
|
|
|
6809
6853
|
</dl>
|
|
6810
6854
|
</details>
|
|
6811
6855
|
|
|
6812
|
-
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">capture</a>(
|
|
6856
|
+
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">capture</a>(transId, amount) -> Payabli.CaptureResponse</code></summary>
|
|
6813
6857
|
<dl>
|
|
6814
6858
|
<dd>
|
|
6815
6859
|
|
|
@@ -6841,7 +6885,7 @@ transaction](/api-reference/moneyin/authorize-a-transaction) to complete the tra
|
|
|
6841
6885
|
<dd>
|
|
6842
6886
|
|
|
6843
6887
|
```typescript
|
|
6844
|
-
await client.moneyIn.capture(
|
|
6888
|
+
await client.moneyIn.capture("10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13", 0);
|
|
6845
6889
|
|
|
6846
6890
|
```
|
|
6847
6891
|
</dd>
|
|
@@ -6857,7 +6901,7 @@ await client.moneyIn.capture(0, "10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13");
|
|
|
6857
6901
|
<dl>
|
|
6858
6902
|
<dd>
|
|
6859
6903
|
|
|
6860
|
-
**
|
|
6904
|
+
**transId:** `string` — ReferenceId for the transaction (PaymentId).
|
|
6861
6905
|
|
|
6862
6906
|
</dd>
|
|
6863
6907
|
</dl>
|
|
@@ -6865,7 +6909,7 @@ await client.moneyIn.capture(0, "10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13");
|
|
|
6865
6909
|
<dl>
|
|
6866
6910
|
<dd>
|
|
6867
6911
|
|
|
6868
|
-
**
|
|
6912
|
+
**amount:** `number` — Amount to be captured. The amount can't be greater the original total amount of the transaction. `0` captures the total amount authorized in the transaction. Partial captures aren't supported.
|
|
6869
6913
|
|
|
6870
6914
|
</dd>
|
|
6871
6915
|
</dl>
|
|
@@ -6873,7 +6917,7 @@ await client.moneyIn.capture(0, "10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13");
|
|
|
6873
6917
|
<dl>
|
|
6874
6918
|
<dd>
|
|
6875
6919
|
|
|
6876
|
-
**requestOptions:** `
|
|
6920
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
6877
6921
|
|
|
6878
6922
|
</dd>
|
|
6879
6923
|
</dl>
|
|
@@ -6951,7 +6995,7 @@ await client.moneyIn.captureAuth("10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13", {
|
|
|
6951
6995
|
<dl>
|
|
6952
6996
|
<dd>
|
|
6953
6997
|
|
|
6954
|
-
**requestOptions:** `
|
|
6998
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
6955
6999
|
|
|
6956
7000
|
</dd>
|
|
6957
7001
|
</dl>
|
|
@@ -7034,7 +7078,7 @@ await client.moneyIn.credit({
|
|
|
7034
7078
|
<dl>
|
|
7035
7079
|
<dd>
|
|
7036
7080
|
|
|
7037
|
-
**requestOptions:** `
|
|
7081
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7038
7082
|
|
|
7039
7083
|
</dd>
|
|
7040
7084
|
</dl>
|
|
@@ -7097,7 +7141,7 @@ await client.moneyIn.details("45-as456777hhhhhhhhhh77777777-324");
|
|
|
7097
7141
|
<dl>
|
|
7098
7142
|
<dd>
|
|
7099
7143
|
|
|
7100
|
-
**requestOptions:** `
|
|
7144
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7101
7145
|
|
|
7102
7146
|
</dd>
|
|
7103
7147
|
</dl>
|
|
@@ -7181,7 +7225,7 @@ await client.moneyIn.getpaid({
|
|
|
7181
7225
|
<dl>
|
|
7182
7226
|
<dd>
|
|
7183
7227
|
|
|
7184
|
-
**requestOptions:** `
|
|
7228
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7185
7229
|
|
|
7186
7230
|
</dd>
|
|
7187
7231
|
</dl>
|
|
@@ -7193,7 +7237,7 @@ await client.moneyIn.getpaid({
|
|
|
7193
7237
|
</dl>
|
|
7194
7238
|
</details>
|
|
7195
7239
|
|
|
7196
|
-
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">reverse</a>(
|
|
7240
|
+
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">reverse</a>(transId, amount) -> Payabli.ReverseResponse</code></summary>
|
|
7197
7241
|
<dl>
|
|
7198
7242
|
<dd>
|
|
7199
7243
|
|
|
@@ -7220,7 +7264,7 @@ A reversal either refunds or voids a transaction independent of the transaction'
|
|
|
7220
7264
|
<dd>
|
|
7221
7265
|
|
|
7222
7266
|
```typescript
|
|
7223
|
-
await client.moneyIn.reverse(
|
|
7267
|
+
await client.moneyIn.reverse("10-3ffa27df-b171-44e0-b251-e95fbfc7a723", 0);
|
|
7224
7268
|
|
|
7225
7269
|
```
|
|
7226
7270
|
</dd>
|
|
@@ -7236,6 +7280,14 @@ await client.moneyIn.reverse(0, "10-3ffa27df-b171-44e0-b251-e95fbfc7a723");
|
|
|
7236
7280
|
<dl>
|
|
7237
7281
|
<dd>
|
|
7238
7282
|
|
|
7283
|
+
**transId:** `string` — ReferenceId for the transaction (PaymentId).
|
|
7284
|
+
|
|
7285
|
+
</dd>
|
|
7286
|
+
</dl>
|
|
7287
|
+
|
|
7288
|
+
<dl>
|
|
7289
|
+
<dd>
|
|
7290
|
+
|
|
7239
7291
|
**amount:** `number`
|
|
7240
7292
|
|
|
7241
7293
|
|
|
@@ -7251,15 +7303,7 @@ An amount equal to zero will refunds the total amount authorized minus any servi
|
|
|
7251
7303
|
<dl>
|
|
7252
7304
|
<dd>
|
|
7253
7305
|
|
|
7254
|
-
**
|
|
7255
|
-
|
|
7256
|
-
</dd>
|
|
7257
|
-
</dl>
|
|
7258
|
-
|
|
7259
|
-
<dl>
|
|
7260
|
-
<dd>
|
|
7261
|
-
|
|
7262
|
-
**requestOptions:** `MoneyIn.RequestOptions`
|
|
7306
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7263
7307
|
|
|
7264
7308
|
</dd>
|
|
7265
7309
|
</dl>
|
|
@@ -7271,7 +7315,7 @@ An amount equal to zero will refunds the total amount authorized minus any servi
|
|
|
7271
7315
|
</dl>
|
|
7272
7316
|
</details>
|
|
7273
7317
|
|
|
7274
|
-
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">refund</a>(
|
|
7318
|
+
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">refund</a>(transId, amount) -> Payabli.RefundResponse</code></summary>
|
|
7275
7319
|
<dl>
|
|
7276
7320
|
<dd>
|
|
7277
7321
|
|
|
@@ -7298,7 +7342,7 @@ Refund a transaction that has settled and send money back to the account holder.
|
|
|
7298
7342
|
<dd>
|
|
7299
7343
|
|
|
7300
7344
|
```typescript
|
|
7301
|
-
await client.moneyIn.refund(
|
|
7345
|
+
await client.moneyIn.refund("10-3ffa27df-b171-44e0-b251-e95fbfc7a723", 0);
|
|
7302
7346
|
|
|
7303
7347
|
```
|
|
7304
7348
|
</dd>
|
|
@@ -7314,6 +7358,14 @@ await client.moneyIn.refund(0, "10-3ffa27df-b171-44e0-b251-e95fbfc7a723");
|
|
|
7314
7358
|
<dl>
|
|
7315
7359
|
<dd>
|
|
7316
7360
|
|
|
7361
|
+
**transId:** `string` — ReferenceId for the transaction (PaymentId).
|
|
7362
|
+
|
|
7363
|
+
</dd>
|
|
7364
|
+
</dl>
|
|
7365
|
+
|
|
7366
|
+
<dl>
|
|
7367
|
+
<dd>
|
|
7368
|
+
|
|
7317
7369
|
**amount:** `number`
|
|
7318
7370
|
|
|
7319
7371
|
|
|
@@ -7329,15 +7381,7 @@ An amount equal to zero will refund the total amount authorized minus any servic
|
|
|
7329
7381
|
<dl>
|
|
7330
7382
|
<dd>
|
|
7331
7383
|
|
|
7332
|
-
**
|
|
7333
|
-
|
|
7334
|
-
</dd>
|
|
7335
|
-
</dl>
|
|
7336
|
-
|
|
7337
|
-
<dl>
|
|
7338
|
-
<dd>
|
|
7339
|
-
|
|
7340
|
-
**requestOptions:** `MoneyIn.RequestOptions`
|
|
7384
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7341
7385
|
|
|
7342
7386
|
</dd>
|
|
7343
7387
|
</dl>
|
|
@@ -7426,7 +7470,7 @@ await client.moneyIn.refundWithInstructions("10-3ffa27df-b171-44e0-b251-e95fbfc7
|
|
|
7426
7470
|
<dl>
|
|
7427
7471
|
<dd>
|
|
7428
7472
|
|
|
7429
|
-
**requestOptions:** `
|
|
7473
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7430
7474
|
|
|
7431
7475
|
</dd>
|
|
7432
7476
|
</dl>
|
|
@@ -7489,7 +7533,7 @@ await client.moneyIn.reverseCredit("45-as456777hhhhhhhhhh77777777-324");
|
|
|
7489
7533
|
<dl>
|
|
7490
7534
|
<dd>
|
|
7491
7535
|
|
|
7492
|
-
**requestOptions:** `
|
|
7536
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7493
7537
|
|
|
7494
7538
|
</dd>
|
|
7495
7539
|
</dl>
|
|
@@ -7562,7 +7606,7 @@ await client.moneyIn.sendReceipt2Trans("45-as456777hhhhhhhhhh77777777-324", {
|
|
|
7562
7606
|
<dl>
|
|
7563
7607
|
<dd>
|
|
7564
7608
|
|
|
7565
|
-
**requestOptions:** `
|
|
7609
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7566
7610
|
|
|
7567
7611
|
</dd>
|
|
7568
7612
|
</dl>
|
|
@@ -7635,7 +7679,7 @@ await client.moneyIn.validate({
|
|
|
7635
7679
|
<dl>
|
|
7636
7680
|
<dd>
|
|
7637
7681
|
|
|
7638
|
-
**requestOptions:** `
|
|
7682
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7639
7683
|
|
|
7640
7684
|
</dd>
|
|
7641
7685
|
</dl>
|
|
@@ -7698,7 +7742,7 @@ await client.moneyIn.void("10-3ffa27df-b171-44e0-b251-e95fbfc7a723");
|
|
|
7698
7742
|
<dl>
|
|
7699
7743
|
<dd>
|
|
7700
7744
|
|
|
7701
|
-
**requestOptions:** `
|
|
7745
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7702
7746
|
|
|
7703
7747
|
</dd>
|
|
7704
7748
|
</dl>
|
|
@@ -7746,7 +7790,8 @@ await client.moneyOut.authorizeOut({
|
|
|
7746
7790
|
}],
|
|
7747
7791
|
orderDescription: "Window Painting",
|
|
7748
7792
|
paymentDetails: {
|
|
7749
|
-
totalAmount: 47
|
|
7793
|
+
totalAmount: 47,
|
|
7794
|
+
unbundled: false
|
|
7750
7795
|
},
|
|
7751
7796
|
paymentMethod: {
|
|
7752
7797
|
method: "managed"
|
|
@@ -7779,7 +7824,7 @@ await client.moneyOut.authorizeOut({
|
|
|
7779
7824
|
<dl>
|
|
7780
7825
|
<dd>
|
|
7781
7826
|
|
|
7782
|
-
**requestOptions:** `
|
|
7827
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
7783
7828
|
|
|
7784
7829
|
</dd>
|
|
7785
7830
|
</dl>
|
|
@@ -7842,7 +7887,7 @@ await client.moneyOut.cancelAllOut(["2-29", "2-28", "2-27"]);
|
|
|
7842
7887
|
<dl>
|
|
7843
7888
|
<dd>
|
|
7844
7889
|
|
|
7845
|
-
**requestOptions:** `
|
|
7890
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
7846
7891
|
|
|
7847
7892
|
</dd>
|
|
7848
7893
|
</dl>
|
|
@@ -7854,7 +7899,7 @@ await client.moneyOut.cancelAllOut(["2-29", "2-28", "2-27"]);
|
|
|
7854
7899
|
</dl>
|
|
7855
7900
|
</details>
|
|
7856
7901
|
|
|
7857
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
7902
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">cancelOutGet</a>(referenceId) -> Payabli.PayabliApiResponse0000</code></summary>
|
|
7858
7903
|
<dl>
|
|
7859
7904
|
<dd>
|
|
7860
7905
|
|
|
@@ -7881,7 +7926,7 @@ Cancel a payout transaction by ID.
|
|
|
7881
7926
|
<dd>
|
|
7882
7927
|
|
|
7883
7928
|
```typescript
|
|
7884
|
-
await client.moneyOut.
|
|
7929
|
+
await client.moneyOut.cancelOutGet("129-219");
|
|
7885
7930
|
|
|
7886
7931
|
```
|
|
7887
7932
|
</dd>
|
|
@@ -7905,7 +7950,7 @@ await client.moneyOut.cancelOut("129-219");
|
|
|
7905
7950
|
<dl>
|
|
7906
7951
|
<dd>
|
|
7907
7952
|
|
|
7908
|
-
**requestOptions:** `
|
|
7953
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
7909
7954
|
|
|
7910
7955
|
</dd>
|
|
7911
7956
|
</dl>
|
|
@@ -7917,7 +7962,7 @@ await client.moneyOut.cancelOut("129-219");
|
|
|
7917
7962
|
</dl>
|
|
7918
7963
|
</details>
|
|
7919
7964
|
|
|
7920
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
7965
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">cancelOutDelete</a>(referenceId) -> Payabli.PayabliApiResponse0000</code></summary>
|
|
7921
7966
|
<dl>
|
|
7922
7967
|
<dd>
|
|
7923
7968
|
|
|
@@ -7929,7 +7974,7 @@ await client.moneyOut.cancelOut("129-219");
|
|
|
7929
7974
|
<dl>
|
|
7930
7975
|
<dd>
|
|
7931
7976
|
|
|
7932
|
-
|
|
7977
|
+
Cancel a payout transaction by ID.
|
|
7933
7978
|
</dd>
|
|
7934
7979
|
</dl>
|
|
7935
7980
|
</dd>
|
|
@@ -7944,9 +7989,7 @@ Captures an array of authorized payout transactions for settlement. The maximum
|
|
|
7944
7989
|
<dd>
|
|
7945
7990
|
|
|
7946
7991
|
```typescript
|
|
7947
|
-
await client.moneyOut.
|
|
7948
|
-
body: ["2-29", "2-28", "2-27"]
|
|
7949
|
-
});
|
|
7992
|
+
await client.moneyOut.cancelOutDelete("129-219");
|
|
7950
7993
|
|
|
7951
7994
|
```
|
|
7952
7995
|
</dd>
|
|
@@ -7962,7 +8005,7 @@ await client.moneyOut.captureAllOut({
|
|
|
7962
8005
|
<dl>
|
|
7963
8006
|
<dd>
|
|
7964
8007
|
|
|
7965
|
-
**
|
|
8008
|
+
**referenceId:** `string` — The ID for the payout transaction.
|
|
7966
8009
|
|
|
7967
8010
|
</dd>
|
|
7968
8011
|
</dl>
|
|
@@ -7970,7 +8013,7 @@ await client.moneyOut.captureAllOut({
|
|
|
7970
8013
|
<dl>
|
|
7971
8014
|
<dd>
|
|
7972
8015
|
|
|
7973
|
-
**requestOptions:** `
|
|
8016
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
7974
8017
|
|
|
7975
8018
|
</dd>
|
|
7976
8019
|
</dl>
|
|
@@ -7982,7 +8025,7 @@ await client.moneyOut.captureAllOut({
|
|
|
7982
8025
|
</dl>
|
|
7983
8026
|
</details>
|
|
7984
8027
|
|
|
7985
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
8028
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">captureAllOut</a>({ ...params }) -> Payabli.CaptureAllOutResponse</code></summary>
|
|
7986
8029
|
<dl>
|
|
7987
8030
|
<dd>
|
|
7988
8031
|
|
|
@@ -7994,7 +8037,7 @@ await client.moneyOut.captureAllOut({
|
|
|
7994
8037
|
<dl>
|
|
7995
8038
|
<dd>
|
|
7996
8039
|
|
|
7997
|
-
Captures
|
|
8040
|
+
Captures an array of authorized payout transactions for settlement. The maximum number of transactions that can be captured in a single request is 500.
|
|
7998
8041
|
</dd>
|
|
7999
8042
|
</dl>
|
|
8000
8043
|
</dd>
|
|
@@ -8009,7 +8052,9 @@ Captures a single authorized payout transaction by ID.
|
|
|
8009
8052
|
<dd>
|
|
8010
8053
|
|
|
8011
8054
|
```typescript
|
|
8012
|
-
await client.moneyOut.
|
|
8055
|
+
await client.moneyOut.captureAllOut({
|
|
8056
|
+
body: ["2-29", "2-28", "2-27"]
|
|
8057
|
+
});
|
|
8013
8058
|
|
|
8014
8059
|
```
|
|
8015
8060
|
</dd>
|
|
@@ -8025,15 +8070,7 @@ await client.moneyOut.captureOut("129-219");
|
|
|
8025
8070
|
<dl>
|
|
8026
8071
|
<dd>
|
|
8027
8072
|
|
|
8028
|
-
**
|
|
8029
|
-
|
|
8030
|
-
</dd>
|
|
8031
|
-
</dl>
|
|
8032
|
-
|
|
8033
|
-
<dl>
|
|
8034
|
-
<dd>
|
|
8035
|
-
|
|
8036
|
-
**request:** `Payabli.CaptureOutRequest`
|
|
8073
|
+
**request:** `Payabli.CaptureAllOutRequest`
|
|
8037
8074
|
|
|
8038
8075
|
</dd>
|
|
8039
8076
|
</dl>
|
|
@@ -8041,7 +8078,7 @@ await client.moneyOut.captureOut("129-219");
|
|
|
8041
8078
|
<dl>
|
|
8042
8079
|
<dd>
|
|
8043
8080
|
|
|
8044
|
-
**requestOptions:** `
|
|
8081
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8045
8082
|
|
|
8046
8083
|
</dd>
|
|
8047
8084
|
</dl>
|
|
@@ -8053,7 +8090,7 @@ await client.moneyOut.captureOut("129-219");
|
|
|
8053
8090
|
</dl>
|
|
8054
8091
|
</details>
|
|
8055
8092
|
|
|
8056
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
8093
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">captureOut</a>(referenceId, { ...params }) -> Payabli.AuthCapturePayoutResponse</code></summary>
|
|
8057
8094
|
<dl>
|
|
8058
8095
|
<dd>
|
|
8059
8096
|
|
|
@@ -8065,7 +8102,7 @@ await client.moneyOut.captureOut("129-219");
|
|
|
8065
8102
|
<dl>
|
|
8066
8103
|
<dd>
|
|
8067
8104
|
|
|
8068
|
-
|
|
8105
|
+
Captures a single authorized payout transaction by ID.
|
|
8069
8106
|
</dd>
|
|
8070
8107
|
</dl>
|
|
8071
8108
|
</dd>
|
|
@@ -8080,7 +8117,7 @@ Returns details for a processed money out transaction.
|
|
|
8080
8117
|
<dd>
|
|
8081
8118
|
|
|
8082
8119
|
```typescript
|
|
8083
|
-
await client.moneyOut.
|
|
8120
|
+
await client.moneyOut.captureOut("129-219");
|
|
8084
8121
|
|
|
8085
8122
|
```
|
|
8086
8123
|
</dd>
|
|
@@ -8096,7 +8133,15 @@ await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
|
8096
8133
|
<dl>
|
|
8097
8134
|
<dd>
|
|
8098
8135
|
|
|
8099
|
-
**
|
|
8136
|
+
**referenceId:** `string` — The ID for the payout transaction.
|
|
8137
|
+
|
|
8138
|
+
</dd>
|
|
8139
|
+
</dl>
|
|
8140
|
+
|
|
8141
|
+
<dl>
|
|
8142
|
+
<dd>
|
|
8143
|
+
|
|
8144
|
+
**request:** `Payabli.CaptureOutRequest`
|
|
8100
8145
|
|
|
8101
8146
|
</dd>
|
|
8102
8147
|
</dl>
|
|
@@ -8104,7 +8149,7 @@ await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
|
8104
8149
|
<dl>
|
|
8105
8150
|
<dd>
|
|
8106
8151
|
|
|
8107
|
-
**requestOptions:** `
|
|
8152
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8108
8153
|
|
|
8109
8154
|
</dd>
|
|
8110
8155
|
</dl>
|
|
@@ -8116,7 +8161,7 @@ await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
|
8116
8161
|
</dl>
|
|
8117
8162
|
</details>
|
|
8118
8163
|
|
|
8119
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
8164
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">payoutDetails</a>(transId) -> Payabli.BillDetailResponse</code></summary>
|
|
8120
8165
|
<dl>
|
|
8121
8166
|
<dd>
|
|
8122
8167
|
|
|
@@ -8128,7 +8173,7 @@ await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
|
8128
8173
|
<dl>
|
|
8129
8174
|
<dd>
|
|
8130
8175
|
|
|
8131
|
-
|
|
8176
|
+
Returns details for a processed money out transaction.
|
|
8132
8177
|
</dd>
|
|
8133
8178
|
</dl>
|
|
8134
8179
|
</dd>
|
|
@@ -8143,7 +8188,7 @@ Retrieves vCard details for a single card in an entrypoint.
|
|
|
8143
8188
|
<dd>
|
|
8144
8189
|
|
|
8145
8190
|
```typescript
|
|
8146
|
-
await client.moneyOut.
|
|
8191
|
+
await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
8147
8192
|
|
|
8148
8193
|
```
|
|
8149
8194
|
</dd>
|
|
@@ -8159,7 +8204,70 @@ await client.moneyOut.vCardGet("20230403315245421165");
|
|
|
8159
8204
|
<dl>
|
|
8160
8205
|
<dd>
|
|
8161
8206
|
|
|
8162
|
-
**
|
|
8207
|
+
**transId:** `string` — ReferenceId for the transaction (PaymentId).
|
|
8208
|
+
|
|
8209
|
+
</dd>
|
|
8210
|
+
</dl>
|
|
8211
|
+
|
|
8212
|
+
<dl>
|
|
8213
|
+
<dd>
|
|
8214
|
+
|
|
8215
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8216
|
+
|
|
8217
|
+
</dd>
|
|
8218
|
+
</dl>
|
|
8219
|
+
</dd>
|
|
8220
|
+
</dl>
|
|
8221
|
+
|
|
8222
|
+
|
|
8223
|
+
</dd>
|
|
8224
|
+
</dl>
|
|
8225
|
+
</details>
|
|
8226
|
+
|
|
8227
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">vCardGet</a>(cardToken) -> Payabli.VCardGetResponse</code></summary>
|
|
8228
|
+
<dl>
|
|
8229
|
+
<dd>
|
|
8230
|
+
|
|
8231
|
+
#### 📝 Description
|
|
8232
|
+
|
|
8233
|
+
<dl>
|
|
8234
|
+
<dd>
|
|
8235
|
+
|
|
8236
|
+
<dl>
|
|
8237
|
+
<dd>
|
|
8238
|
+
|
|
8239
|
+
Retrieves vCard details for a single card in an entrypoint.
|
|
8240
|
+
</dd>
|
|
8241
|
+
</dl>
|
|
8242
|
+
</dd>
|
|
8243
|
+
</dl>
|
|
8244
|
+
|
|
8245
|
+
#### 🔌 Usage
|
|
8246
|
+
|
|
8247
|
+
<dl>
|
|
8248
|
+
<dd>
|
|
8249
|
+
|
|
8250
|
+
<dl>
|
|
8251
|
+
<dd>
|
|
8252
|
+
|
|
8253
|
+
```typescript
|
|
8254
|
+
await client.moneyOut.vCardGet("20230403315245421165");
|
|
8255
|
+
|
|
8256
|
+
```
|
|
8257
|
+
</dd>
|
|
8258
|
+
</dl>
|
|
8259
|
+
</dd>
|
|
8260
|
+
</dl>
|
|
8261
|
+
|
|
8262
|
+
#### ⚙️ Parameters
|
|
8263
|
+
|
|
8264
|
+
<dl>
|
|
8265
|
+
<dd>
|
|
8266
|
+
|
|
8267
|
+
<dl>
|
|
8268
|
+
<dd>
|
|
8269
|
+
|
|
8270
|
+
**cardToken:** `string` — ID for a virtual card.
|
|
8163
8271
|
|
|
8164
8272
|
</dd>
|
|
8165
8273
|
</dl>
|
|
@@ -8167,7 +8275,7 @@ await client.moneyOut.vCardGet("20230403315245421165");
|
|
|
8167
8275
|
<dl>
|
|
8168
8276
|
<dd>
|
|
8169
8277
|
|
|
8170
|
-
**requestOptions:** `
|
|
8278
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8171
8279
|
|
|
8172
8280
|
</dd>
|
|
8173
8281
|
</dl>
|
|
@@ -8232,7 +8340,7 @@ await client.moneyOut.sendVCardLink({
|
|
|
8232
8340
|
<dl>
|
|
8233
8341
|
<dd>
|
|
8234
8342
|
|
|
8235
|
-
**requestOptions:** `
|
|
8343
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8236
8344
|
|
|
8237
8345
|
</dd>
|
|
8238
8346
|
</dl>
|
|
@@ -8308,7 +8416,7 @@ in the response when you make a GET request to `/MoneyOut/details/{transId}`.
|
|
|
8308
8416
|
<dl>
|
|
8309
8417
|
<dd>
|
|
8310
8418
|
|
|
8311
|
-
**requestOptions:** `
|
|
8419
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8312
8420
|
|
|
8313
8421
|
</dd>
|
|
8314
8422
|
</dl>
|
|
@@ -8382,7 +8490,7 @@ await client.notification.addNotification({
|
|
|
8382
8490
|
<dl>
|
|
8383
8491
|
<dd>
|
|
8384
8492
|
|
|
8385
|
-
**requestOptions:** `
|
|
8493
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8386
8494
|
|
|
8387
8495
|
</dd>
|
|
8388
8496
|
</dl>
|
|
@@ -8445,7 +8553,7 @@ await client.notification.deleteNotification("1717");
|
|
|
8445
8553
|
<dl>
|
|
8446
8554
|
<dd>
|
|
8447
8555
|
|
|
8448
|
-
**requestOptions:** `
|
|
8556
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8449
8557
|
|
|
8450
8558
|
</dd>
|
|
8451
8559
|
</dl>
|
|
@@ -8508,7 +8616,7 @@ await client.notification.getNotification("1717");
|
|
|
8508
8616
|
<dl>
|
|
8509
8617
|
<dd>
|
|
8510
8618
|
|
|
8511
|
-
**requestOptions:** `
|
|
8619
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8512
8620
|
|
|
8513
8621
|
</dd>
|
|
8514
8622
|
</dl>
|
|
@@ -8589,7 +8697,7 @@ await client.notification.updateNotification("1717", {
|
|
|
8589
8697
|
<dl>
|
|
8590
8698
|
<dd>
|
|
8591
8699
|
|
|
8592
|
-
**requestOptions:** `
|
|
8700
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8593
8701
|
|
|
8594
8702
|
</dd>
|
|
8595
8703
|
</dl>
|
|
@@ -8601,7 +8709,7 @@ await client.notification.updateNotification("1717", {
|
|
|
8601
8709
|
</dl>
|
|
8602
8710
|
</details>
|
|
8603
8711
|
|
|
8604
|
-
<details><summary><code>client.notification.<a href="/src/api/resources/notification/client/Client.ts">getReportFile</a>(
|
|
8712
|
+
<details><summary><code>client.notification.<a href="/src/api/resources/notification/client/Client.ts">getReportFile</a>(Id) -> Payabli.File_</code></summary>
|
|
8605
8713
|
<dl>
|
|
8606
8714
|
<dd>
|
|
8607
8715
|
|
|
@@ -8644,7 +8752,7 @@ await client.notification.getReportFile(1000000);
|
|
|
8644
8752
|
<dl>
|
|
8645
8753
|
<dd>
|
|
8646
8754
|
|
|
8647
|
-
**
|
|
8755
|
+
**Id:** `number` — Report ID
|
|
8648
8756
|
|
|
8649
8757
|
</dd>
|
|
8650
8758
|
</dl>
|
|
@@ -8652,7 +8760,7 @@ await client.notification.getReportFile(1000000);
|
|
|
8652
8760
|
<dl>
|
|
8653
8761
|
<dd>
|
|
8654
8762
|
|
|
8655
|
-
**requestOptions:** `
|
|
8763
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8656
8764
|
|
|
8657
8765
|
</dd>
|
|
8658
8766
|
</dl>
|
|
@@ -8729,7 +8837,7 @@ await client.notificationlogs.searchNotificationLogs({
|
|
|
8729
8837
|
<dl>
|
|
8730
8838
|
<dd>
|
|
8731
8839
|
|
|
8732
|
-
**requestOptions:** `
|
|
8840
|
+
**requestOptions:** `NotificationlogsClient.RequestOptions`
|
|
8733
8841
|
|
|
8734
8842
|
</dd>
|
|
8735
8843
|
</dl>
|
|
@@ -8793,7 +8901,7 @@ await client.notificationlogs.getNotificationLog("550e8400-e29b-41d4-a716-446655
|
|
|
8793
8901
|
<dl>
|
|
8794
8902
|
<dd>
|
|
8795
8903
|
|
|
8796
|
-
**requestOptions:** `
|
|
8904
|
+
**requestOptions:** `NotificationlogsClient.RequestOptions`
|
|
8797
8905
|
|
|
8798
8906
|
</dd>
|
|
8799
8907
|
</dl>
|
|
@@ -8858,7 +8966,7 @@ await client.notificationlogs.retryNotificationLog("550e8400-e29b-41d4-a716-4466
|
|
|
8858
8966
|
<dl>
|
|
8859
8967
|
<dd>
|
|
8860
8968
|
|
|
8861
|
-
**requestOptions:** `
|
|
8969
|
+
**requestOptions:** `NotificationlogsClient.RequestOptions`
|
|
8862
8970
|
|
|
8863
8971
|
</dd>
|
|
8864
8972
|
</dl>
|
|
@@ -8924,7 +9032,7 @@ await client.notificationlogs.bulkRetryNotificationLogs(["550e8400-e29b-41d4-a71
|
|
|
8924
9032
|
<dl>
|
|
8925
9033
|
<dd>
|
|
8926
9034
|
|
|
8927
|
-
**requestOptions:** `
|
|
9035
|
+
**requestOptions:** `NotificationlogsClient.RequestOptions`
|
|
8928
9036
|
|
|
8929
9037
|
</dd>
|
|
8930
9038
|
</dl>
|
|
@@ -8941,6 +9049,20 @@ await client.notificationlogs.bulkRetryNotificationLogs(["550e8400-e29b-41d4-a71
|
|
|
8941
9049
|
<dl>
|
|
8942
9050
|
<dd>
|
|
8943
9051
|
|
|
9052
|
+
#### 📝 Description
|
|
9053
|
+
|
|
9054
|
+
<dl>
|
|
9055
|
+
<dd>
|
|
9056
|
+
|
|
9057
|
+
<dl>
|
|
9058
|
+
<dd>
|
|
9059
|
+
|
|
9060
|
+
Use this endpoint to upload an image file for OCR processing. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more.
|
|
9061
|
+
</dd>
|
|
9062
|
+
</dl>
|
|
9063
|
+
</dd>
|
|
9064
|
+
</dl>
|
|
9065
|
+
|
|
8944
9066
|
#### 🔌 Usage
|
|
8945
9067
|
|
|
8946
9068
|
<dl>
|
|
@@ -8982,7 +9104,7 @@ await client.ocr.ocrDocumentForm("typeResult", {});
|
|
|
8982
9104
|
<dl>
|
|
8983
9105
|
<dd>
|
|
8984
9106
|
|
|
8985
|
-
**requestOptions:** `
|
|
9107
|
+
**requestOptions:** `OcrClient.RequestOptions`
|
|
8986
9108
|
|
|
8987
9109
|
</dd>
|
|
8988
9110
|
</dl>
|
|
@@ -8998,6 +9120,20 @@ await client.ocr.ocrDocumentForm("typeResult", {});
|
|
|
8998
9120
|
<dl>
|
|
8999
9121
|
<dd>
|
|
9000
9122
|
|
|
9123
|
+
#### 📝 Description
|
|
9124
|
+
|
|
9125
|
+
<dl>
|
|
9126
|
+
<dd>
|
|
9127
|
+
|
|
9128
|
+
<dl>
|
|
9129
|
+
<dd>
|
|
9130
|
+
|
|
9131
|
+
Use this endpoint to submit a Base64-encoded image file for OCR processing. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more.
|
|
9132
|
+
</dd>
|
|
9133
|
+
</dl>
|
|
9134
|
+
</dd>
|
|
9135
|
+
</dl>
|
|
9136
|
+
|
|
9001
9137
|
#### 🔌 Usage
|
|
9002
9138
|
|
|
9003
9139
|
<dl>
|
|
@@ -9039,7 +9175,7 @@ await client.ocr.ocrDocumentJson("typeResult", {});
|
|
|
9039
9175
|
<dl>
|
|
9040
9176
|
<dd>
|
|
9041
9177
|
|
|
9042
|
-
**requestOptions:** `
|
|
9178
|
+
**requestOptions:** `OcrClient.RequestOptions`
|
|
9043
9179
|
|
|
9044
9180
|
</dd>
|
|
9045
9181
|
</dl>
|
|
@@ -9141,7 +9277,7 @@ await client.organization.addOrganization({
|
|
|
9141
9277
|
<dl>
|
|
9142
9278
|
<dd>
|
|
9143
9279
|
|
|
9144
|
-
**requestOptions:** `
|
|
9280
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9145
9281
|
|
|
9146
9282
|
</dd>
|
|
9147
9283
|
</dl>
|
|
@@ -9204,7 +9340,7 @@ await client.organization.deleteOrganization(123);
|
|
|
9204
9340
|
<dl>
|
|
9205
9341
|
<dd>
|
|
9206
9342
|
|
|
9207
|
-
**requestOptions:** `
|
|
9343
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9208
9344
|
|
|
9209
9345
|
</dd>
|
|
9210
9346
|
</dl>
|
|
@@ -9293,7 +9429,7 @@ await client.organization.editOrganization(123, {
|
|
|
9293
9429
|
<dl>
|
|
9294
9430
|
<dd>
|
|
9295
9431
|
|
|
9296
|
-
**requestOptions:** `
|
|
9432
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9297
9433
|
|
|
9298
9434
|
</dd>
|
|
9299
9435
|
</dl>
|
|
@@ -9356,7 +9492,7 @@ await client.organization.getBasicOrganization("8cfec329267");
|
|
|
9356
9492
|
<dl>
|
|
9357
9493
|
<dd>
|
|
9358
9494
|
|
|
9359
|
-
**requestOptions:** `
|
|
9495
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9360
9496
|
|
|
9361
9497
|
</dd>
|
|
9362
9498
|
</dl>
|
|
@@ -9419,7 +9555,7 @@ await client.organization.getBasicOrganizationById(123);
|
|
|
9419
9555
|
<dl>
|
|
9420
9556
|
<dd>
|
|
9421
9557
|
|
|
9422
|
-
**requestOptions:** `
|
|
9558
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9423
9559
|
|
|
9424
9560
|
</dd>
|
|
9425
9561
|
</dl>
|
|
@@ -9482,7 +9618,7 @@ await client.organization.getOrganization(123);
|
|
|
9482
9618
|
<dl>
|
|
9483
9619
|
<dd>
|
|
9484
9620
|
|
|
9485
|
-
**requestOptions:** `
|
|
9621
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9486
9622
|
|
|
9487
9623
|
</dd>
|
|
9488
9624
|
</dl>
|
|
@@ -9545,7 +9681,7 @@ await client.organization.getSettingsOrganization(123);
|
|
|
9545
9681
|
<dl>
|
|
9546
9682
|
<dd>
|
|
9547
9683
|
|
|
9548
|
-
**requestOptions:** `
|
|
9684
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9549
9685
|
|
|
9550
9686
|
</dd>
|
|
9551
9687
|
</dl>
|
|
@@ -9668,7 +9804,7 @@ await client.paymentLink.addPayLinkFromInvoice(23548884, {
|
|
|
9668
9804
|
name: "fullName",
|
|
9669
9805
|
order: 0,
|
|
9670
9806
|
required: true,
|
|
9671
|
-
validation: "
|
|
9807
|
+
validation: "alpha",
|
|
9672
9808
|
value: "",
|
|
9673
9809
|
width: 0
|
|
9674
9810
|
}],
|
|
@@ -9726,7 +9862,7 @@ await client.paymentLink.addPayLinkFromInvoice(23548884, {
|
|
|
9726
9862
|
<dl>
|
|
9727
9863
|
<dd>
|
|
9728
9864
|
|
|
9729
|
-
**requestOptions:** `
|
|
9865
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
9730
9866
|
|
|
9731
9867
|
</dd>
|
|
9732
9868
|
</dl>
|
|
@@ -9827,7 +9963,7 @@ await client.paymentLink.addPayLinkFromBill(23548884, {
|
|
|
9827
9963
|
name: "fullName",
|
|
9828
9964
|
order: 0,
|
|
9829
9965
|
required: true,
|
|
9830
|
-
validation: "
|
|
9966
|
+
validation: "alpha",
|
|
9831
9967
|
value: "",
|
|
9832
9968
|
width: 0
|
|
9833
9969
|
}],
|
|
@@ -9876,7 +10012,7 @@ await client.paymentLink.addPayLinkFromBill(23548884, {
|
|
|
9876
10012
|
<dl>
|
|
9877
10013
|
<dd>
|
|
9878
10014
|
|
|
9879
|
-
**requestOptions:** `
|
|
10015
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
9880
10016
|
|
|
9881
10017
|
</dd>
|
|
9882
10018
|
</dl>
|
|
@@ -9939,7 +10075,7 @@ await client.paymentLink.deletePayLinkFromId("payLinkId");
|
|
|
9939
10075
|
<dl>
|
|
9940
10076
|
<dd>
|
|
9941
10077
|
|
|
9942
|
-
**requestOptions:** `
|
|
10078
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
9943
10079
|
|
|
9944
10080
|
</dd>
|
|
9945
10081
|
</dl>
|
|
@@ -10002,7 +10138,7 @@ await client.paymentLink.getPayLinkFromId("paylinkId");
|
|
|
10002
10138
|
<dl>
|
|
10003
10139
|
<dd>
|
|
10004
10140
|
|
|
10005
|
-
**requestOptions:** `
|
|
10141
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10006
10142
|
|
|
10007
10143
|
</dd>
|
|
10008
10144
|
</dl>
|
|
@@ -10075,7 +10211,7 @@ await client.paymentLink.pushPayLinkFromId("payLinkId", {
|
|
|
10075
10211
|
<dl>
|
|
10076
10212
|
<dd>
|
|
10077
10213
|
|
|
10078
|
-
**requestOptions:** `
|
|
10214
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10079
10215
|
|
|
10080
10216
|
</dd>
|
|
10081
10217
|
</dl>
|
|
@@ -10146,7 +10282,7 @@ await client.paymentLink.refreshPayLinkFromId("payLinkId");
|
|
|
10146
10282
|
<dl>
|
|
10147
10283
|
<dd>
|
|
10148
10284
|
|
|
10149
|
-
**requestOptions:** `
|
|
10285
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10150
10286
|
|
|
10151
10287
|
</dd>
|
|
10152
10288
|
</dl>
|
|
@@ -10219,7 +10355,7 @@ await client.paymentLink.sendPayLinkFromId("payLinkId", {
|
|
|
10219
10355
|
<dl>
|
|
10220
10356
|
<dd>
|
|
10221
10357
|
|
|
10222
|
-
**requestOptions:** `
|
|
10358
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10223
10359
|
|
|
10224
10360
|
</dd>
|
|
10225
10361
|
</dl>
|
|
@@ -10303,7 +10439,7 @@ await client.paymentLink.updatePayLinkFromId("332-c277b704-1301", {
|
|
|
10303
10439
|
<dl>
|
|
10304
10440
|
<dd>
|
|
10305
10441
|
|
|
10306
|
-
**requestOptions:** `
|
|
10442
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10307
10443
|
|
|
10308
10444
|
</dd>
|
|
10309
10445
|
</dl>
|
|
@@ -10407,7 +10543,7 @@ await client.paymentLink.addPayLinkFromBillLotNumber("LOT-2024-001", {
|
|
|
10407
10543
|
name: "fullName",
|
|
10408
10544
|
order: 0,
|
|
10409
10545
|
required: true,
|
|
10410
|
-
validation: "
|
|
10546
|
+
validation: "alpha",
|
|
10411
10547
|
value: "",
|
|
10412
10548
|
width: 0
|
|
10413
10549
|
}],
|
|
@@ -10456,7 +10592,7 @@ await client.paymentLink.addPayLinkFromBillLotNumber("LOT-2024-001", {
|
|
|
10456
10592
|
<dl>
|
|
10457
10593
|
<dd>
|
|
10458
10594
|
|
|
10459
|
-
**requestOptions:** `
|
|
10595
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10460
10596
|
|
|
10461
10597
|
</dd>
|
|
10462
10598
|
</dl>
|
|
@@ -10530,7 +10666,7 @@ await client.paymentMethodDomain.addPaymentMethodDomain({
|
|
|
10530
10666
|
<dl>
|
|
10531
10667
|
<dd>
|
|
10532
10668
|
|
|
10533
|
-
**requestOptions:** `
|
|
10669
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10534
10670
|
|
|
10535
10671
|
</dd>
|
|
10536
10672
|
</dl>
|
|
@@ -10593,7 +10729,7 @@ await client.paymentMethodDomain.cascadePaymentMethodDomain("pmd_b8237fa45c964d8
|
|
|
10593
10729
|
<dl>
|
|
10594
10730
|
<dd>
|
|
10595
10731
|
|
|
10596
|
-
**requestOptions:** `
|
|
10732
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10597
10733
|
|
|
10598
10734
|
</dd>
|
|
10599
10735
|
</dl>
|
|
@@ -10656,7 +10792,7 @@ await client.paymentMethodDomain.deletePaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
10656
10792
|
<dl>
|
|
10657
10793
|
<dd>
|
|
10658
10794
|
|
|
10659
|
-
**requestOptions:** `
|
|
10795
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10660
10796
|
|
|
10661
10797
|
</dd>
|
|
10662
10798
|
</dl>
|
|
@@ -10719,7 +10855,7 @@ await client.paymentMethodDomain.getPaymentMethodDomain("pmd_b8237fa45c964d8a9ef
|
|
|
10719
10855
|
<dl>
|
|
10720
10856
|
<dd>
|
|
10721
10857
|
|
|
10722
|
-
**requestOptions:** `
|
|
10858
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10723
10859
|
|
|
10724
10860
|
</dd>
|
|
10725
10861
|
</dl>
|
|
@@ -10785,7 +10921,7 @@ await client.paymentMethodDomain.listPaymentMethodDomains({
|
|
|
10785
10921
|
<dl>
|
|
10786
10922
|
<dd>
|
|
10787
10923
|
|
|
10788
|
-
**requestOptions:** `
|
|
10924
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10789
10925
|
|
|
10790
10926
|
</dd>
|
|
10791
10927
|
</dl>
|
|
@@ -10863,7 +10999,7 @@ await client.paymentMethodDomain.updatePaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
10863
10999
|
<dl>
|
|
10864
11000
|
<dd>
|
|
10865
11001
|
|
|
10866
|
-
**requestOptions:** `
|
|
11002
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10867
11003
|
|
|
10868
11004
|
</dd>
|
|
10869
11005
|
</dl>
|
|
@@ -10926,7 +11062,7 @@ await client.paymentMethodDomain.verifyPaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
10926
11062
|
<dl>
|
|
10927
11063
|
<dd>
|
|
10928
11064
|
|
|
10929
|
-
**requestOptions:** `
|
|
11065
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10930
11066
|
|
|
10931
11067
|
</dd>
|
|
10932
11068
|
</dl>
|
|
@@ -10990,7 +11126,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
10990
11126
|
<dl>
|
|
10991
11127
|
<dd>
|
|
10992
11128
|
|
|
10993
|
-
**requestOptions:** `
|
|
11129
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
10994
11130
|
|
|
10995
11131
|
</dd>
|
|
10996
11132
|
</dl>
|
|
@@ -11002,7 +11138,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11002
11138
|
</dl>
|
|
11003
11139
|
</details>
|
|
11004
11140
|
|
|
11005
|
-
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getBasicEntryById</a>(
|
|
11141
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getBasicEntryById</a>(IdPaypoint) -> Payabli.GetBasicEntryByIdResponse</code></summary>
|
|
11006
11142
|
<dl>
|
|
11007
11143
|
<dd>
|
|
11008
11144
|
|
|
@@ -11045,7 +11181,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
11045
11181
|
<dl>
|
|
11046
11182
|
<dd>
|
|
11047
11183
|
|
|
11048
|
-
**
|
|
11184
|
+
**IdPaypoint:** `string` — Paypoint ID. You can find this value by querying `/api/Query/paypoints/{orgId}`
|
|
11049
11185
|
|
|
11050
11186
|
</dd>
|
|
11051
11187
|
</dl>
|
|
@@ -11053,7 +11189,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
11053
11189
|
<dl>
|
|
11054
11190
|
<dd>
|
|
11055
11191
|
|
|
11056
|
-
**requestOptions:** `
|
|
11192
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11057
11193
|
|
|
11058
11194
|
</dd>
|
|
11059
11195
|
</dl>
|
|
@@ -11124,7 +11260,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
11124
11260
|
<dl>
|
|
11125
11261
|
<dd>
|
|
11126
11262
|
|
|
11127
|
-
**requestOptions:** `
|
|
11263
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11128
11264
|
|
|
11129
11265
|
</dd>
|
|
11130
11266
|
</dl>
|
|
@@ -11195,7 +11331,7 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
11195
11331
|
<dl>
|
|
11196
11332
|
<dd>
|
|
11197
11333
|
|
|
11198
|
-
**requestOptions:** `
|
|
11334
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11199
11335
|
|
|
11200
11336
|
</dd>
|
|
11201
11337
|
</dl>
|
|
@@ -11266,7 +11402,7 @@ await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
|
11266
11402
|
<dl>
|
|
11267
11403
|
<dd>
|
|
11268
11404
|
|
|
11269
|
-
**requestOptions:** `
|
|
11405
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11270
11406
|
|
|
11271
11407
|
</dd>
|
|
11272
11408
|
</dl>
|
|
@@ -11337,7 +11473,7 @@ await client.paypoint.saveLogo("8cfec329267", {});
|
|
|
11337
11473
|
<dl>
|
|
11338
11474
|
<dd>
|
|
11339
11475
|
|
|
11340
|
-
**requestOptions:** `
|
|
11476
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11341
11477
|
|
|
11342
11478
|
</dd>
|
|
11343
11479
|
</dl>
|
|
@@ -11400,7 +11536,7 @@ await client.paypoint.settingsPage("8cfec329267");
|
|
|
11400
11536
|
<dl>
|
|
11401
11537
|
<dd>
|
|
11402
11538
|
|
|
11403
|
-
**requestOptions:** `
|
|
11539
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11404
11540
|
|
|
11405
11541
|
</dd>
|
|
11406
11542
|
</dl>
|
|
@@ -11473,7 +11609,7 @@ await client.paypoint.migrate({
|
|
|
11473
11609
|
<dl>
|
|
11474
11610
|
<dd>
|
|
11475
11611
|
|
|
11476
|
-
**requestOptions:** `
|
|
11612
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11477
11613
|
|
|
11478
11614
|
</dd>
|
|
11479
11615
|
</dl>
|
|
@@ -11550,7 +11686,7 @@ await client.query.listBatchDetails("8cfec329267", {
|
|
|
11550
11686
|
<dl>
|
|
11551
11687
|
<dd>
|
|
11552
11688
|
|
|
11553
|
-
**requestOptions:** `
|
|
11689
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11554
11690
|
|
|
11555
11691
|
</dd>
|
|
11556
11692
|
</dl>
|
|
@@ -11625,7 +11761,7 @@ await client.query.listBatchDetailsOrg(123, {
|
|
|
11625
11761
|
<dl>
|
|
11626
11762
|
<dd>
|
|
11627
11763
|
|
|
11628
|
-
**requestOptions:** `
|
|
11764
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11629
11765
|
|
|
11630
11766
|
</dd>
|
|
11631
11767
|
</dl>
|
|
@@ -11700,7 +11836,7 @@ await client.query.listBatches("8cfec329267", {
|
|
|
11700
11836
|
<dl>
|
|
11701
11837
|
<dd>
|
|
11702
11838
|
|
|
11703
|
-
**requestOptions:** `
|
|
11839
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11704
11840
|
|
|
11705
11841
|
</dd>
|
|
11706
11842
|
</dl>
|
|
@@ -11775,7 +11911,7 @@ await client.query.listBatchesOrg(123, {
|
|
|
11775
11911
|
<dl>
|
|
11776
11912
|
<dd>
|
|
11777
11913
|
|
|
11778
|
-
**requestOptions:** `
|
|
11914
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11779
11915
|
|
|
11780
11916
|
</dd>
|
|
11781
11917
|
</dl>
|
|
@@ -11850,7 +11986,7 @@ await client.query.listBatchesOut("8cfec329267", {
|
|
|
11850
11986
|
<dl>
|
|
11851
11987
|
<dd>
|
|
11852
11988
|
|
|
11853
|
-
**requestOptions:** `
|
|
11989
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11854
11990
|
|
|
11855
11991
|
</dd>
|
|
11856
11992
|
</dl>
|
|
@@ -11925,7 +12061,7 @@ await client.query.listBatchesOutOrg(123, {
|
|
|
11925
12061
|
<dl>
|
|
11926
12062
|
<dd>
|
|
11927
12063
|
|
|
11928
|
-
**requestOptions:** `
|
|
12064
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11929
12065
|
|
|
11930
12066
|
</dd>
|
|
11931
12067
|
</dl>
|
|
@@ -12000,7 +12136,7 @@ await client.query.listChargebacks("8cfec329267", {
|
|
|
12000
12136
|
<dl>
|
|
12001
12137
|
<dd>
|
|
12002
12138
|
|
|
12003
|
-
**requestOptions:** `
|
|
12139
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12004
12140
|
|
|
12005
12141
|
</dd>
|
|
12006
12142
|
</dl>
|
|
@@ -12075,7 +12211,7 @@ await client.query.listChargebacksOrg(123, {
|
|
|
12075
12211
|
<dl>
|
|
12076
12212
|
<dd>
|
|
12077
12213
|
|
|
12078
|
-
**requestOptions:** `
|
|
12214
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12079
12215
|
|
|
12080
12216
|
</dd>
|
|
12081
12217
|
</dl>
|
|
@@ -12150,7 +12286,7 @@ await client.query.listCustomers("8cfec329267", {
|
|
|
12150
12286
|
<dl>
|
|
12151
12287
|
<dd>
|
|
12152
12288
|
|
|
12153
|
-
**requestOptions:** `
|
|
12289
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12154
12290
|
|
|
12155
12291
|
</dd>
|
|
12156
12292
|
</dl>
|
|
@@ -12225,7 +12361,7 @@ await client.query.listCustomersOrg(123, {
|
|
|
12225
12361
|
<dl>
|
|
12226
12362
|
<dd>
|
|
12227
12363
|
|
|
12228
|
-
**requestOptions:** `
|
|
12364
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12229
12365
|
|
|
12230
12366
|
</dd>
|
|
12231
12367
|
</dl>
|
|
@@ -12300,7 +12436,7 @@ await client.query.listNotificationReports("8cfec329267", {
|
|
|
12300
12436
|
<dl>
|
|
12301
12437
|
<dd>
|
|
12302
12438
|
|
|
12303
|
-
**requestOptions:** `
|
|
12439
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12304
12440
|
|
|
12305
12441
|
</dd>
|
|
12306
12442
|
</dl>
|
|
@@ -12375,7 +12511,7 @@ await client.query.listNotificationReportsOrg(123, {
|
|
|
12375
12511
|
<dl>
|
|
12376
12512
|
<dd>
|
|
12377
12513
|
|
|
12378
|
-
**requestOptions:** `
|
|
12514
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12379
12515
|
|
|
12380
12516
|
</dd>
|
|
12381
12517
|
</dl>
|
|
@@ -12450,7 +12586,7 @@ await client.query.listNotifications("8cfec329267", {
|
|
|
12450
12586
|
<dl>
|
|
12451
12587
|
<dd>
|
|
12452
12588
|
|
|
12453
|
-
**requestOptions:** `
|
|
12589
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12454
12590
|
|
|
12455
12591
|
</dd>
|
|
12456
12592
|
</dl>
|
|
@@ -12525,7 +12661,7 @@ await client.query.listNotificationsOrg(123, {
|
|
|
12525
12661
|
<dl>
|
|
12526
12662
|
<dd>
|
|
12527
12663
|
|
|
12528
|
-
**requestOptions:** `
|
|
12664
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12529
12665
|
|
|
12530
12666
|
</dd>
|
|
12531
12667
|
</dl>
|
|
@@ -12600,7 +12736,7 @@ await client.query.listOrganizations(123, {
|
|
|
12600
12736
|
<dl>
|
|
12601
12737
|
<dd>
|
|
12602
12738
|
|
|
12603
|
-
**requestOptions:** `
|
|
12739
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12604
12740
|
|
|
12605
12741
|
</dd>
|
|
12606
12742
|
</dl>
|
|
@@ -12675,7 +12811,7 @@ await client.query.listPayout("8cfec329267", {
|
|
|
12675
12811
|
<dl>
|
|
12676
12812
|
<dd>
|
|
12677
12813
|
|
|
12678
|
-
**requestOptions:** `
|
|
12814
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12679
12815
|
|
|
12680
12816
|
</dd>
|
|
12681
12817
|
</dl>
|
|
@@ -12750,7 +12886,7 @@ await client.query.listPayoutOrg(123, {
|
|
|
12750
12886
|
<dl>
|
|
12751
12887
|
<dd>
|
|
12752
12888
|
|
|
12753
|
-
**requestOptions:** `
|
|
12889
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12754
12890
|
|
|
12755
12891
|
</dd>
|
|
12756
12892
|
</dl>
|
|
@@ -12825,7 +12961,7 @@ await client.query.listPaypoints(123, {
|
|
|
12825
12961
|
<dl>
|
|
12826
12962
|
<dd>
|
|
12827
12963
|
|
|
12828
|
-
**requestOptions:** `
|
|
12964
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12829
12965
|
|
|
12830
12966
|
</dd>
|
|
12831
12967
|
</dl>
|
|
@@ -12900,7 +13036,7 @@ await client.query.listSettlements("8cfec329267", {
|
|
|
12900
13036
|
<dl>
|
|
12901
13037
|
<dd>
|
|
12902
13038
|
|
|
12903
|
-
**requestOptions:** `
|
|
13039
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12904
13040
|
|
|
12905
13041
|
</dd>
|
|
12906
13042
|
</dl>
|
|
@@ -12975,7 +13111,7 @@ await client.query.listSettlementsOrg(123, {
|
|
|
12975
13111
|
<dl>
|
|
12976
13112
|
<dd>
|
|
12977
13113
|
|
|
12978
|
-
**requestOptions:** `
|
|
13114
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12979
13115
|
|
|
12980
13116
|
</dd>
|
|
12981
13117
|
</dl>
|
|
@@ -13050,7 +13186,7 @@ await client.query.listSubscriptions("8cfec329267", {
|
|
|
13050
13186
|
<dl>
|
|
13051
13187
|
<dd>
|
|
13052
13188
|
|
|
13053
|
-
**requestOptions:** `
|
|
13189
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13054
13190
|
|
|
13055
13191
|
</dd>
|
|
13056
13192
|
</dl>
|
|
@@ -13125,7 +13261,7 @@ await client.query.listSubscriptionsOrg(123, {
|
|
|
13125
13261
|
<dl>
|
|
13126
13262
|
<dd>
|
|
13127
13263
|
|
|
13128
|
-
**requestOptions:** `
|
|
13264
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13129
13265
|
|
|
13130
13266
|
</dd>
|
|
13131
13267
|
</dl>
|
|
@@ -13207,7 +13343,7 @@ await client.query.listTransactions("8cfec329267", {
|
|
|
13207
13343
|
<dl>
|
|
13208
13344
|
<dd>
|
|
13209
13345
|
|
|
13210
|
-
**requestOptions:** `
|
|
13346
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13211
13347
|
|
|
13212
13348
|
</dd>
|
|
13213
13349
|
</dl>
|
|
@@ -13296,7 +13432,7 @@ await client.query.listTransactionsOrg(123, {
|
|
|
13296
13432
|
<dl>
|
|
13297
13433
|
<dd>
|
|
13298
13434
|
|
|
13299
|
-
**requestOptions:** `
|
|
13435
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13300
13436
|
|
|
13301
13437
|
</dd>
|
|
13302
13438
|
</dl>
|
|
@@ -13375,7 +13511,7 @@ await client.query.listTransferDetails("47862acd", 123456);
|
|
|
13375
13511
|
<dl>
|
|
13376
13512
|
<dd>
|
|
13377
13513
|
|
|
13378
|
-
**requestOptions:** `
|
|
13514
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13379
13515
|
|
|
13380
13516
|
</dd>
|
|
13381
13517
|
</dl>
|
|
@@ -13449,7 +13585,7 @@ await client.query.listTransfers("47862acd", {
|
|
|
13449
13585
|
<dl>
|
|
13450
13586
|
<dd>
|
|
13451
13587
|
|
|
13452
|
-
**requestOptions:** `
|
|
13588
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13453
13589
|
|
|
13454
13590
|
</dd>
|
|
13455
13591
|
</dl>
|
|
@@ -13516,7 +13652,7 @@ await client.query.listTransfersOrg({
|
|
|
13516
13652
|
<dl>
|
|
13517
13653
|
<dd>
|
|
13518
13654
|
|
|
13519
|
-
**requestOptions:** `
|
|
13655
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13520
13656
|
|
|
13521
13657
|
</dd>
|
|
13522
13658
|
</dl>
|
|
@@ -13591,7 +13727,7 @@ await client.query.listUsersOrg(123, {
|
|
|
13591
13727
|
<dl>
|
|
13592
13728
|
<dd>
|
|
13593
13729
|
|
|
13594
|
-
**requestOptions:** `
|
|
13730
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13595
13731
|
|
|
13596
13732
|
</dd>
|
|
13597
13733
|
</dl>
|
|
@@ -13666,7 +13802,7 @@ await client.query.listUsersPaypoint("8cfec329267", {
|
|
|
13666
13802
|
<dl>
|
|
13667
13803
|
<dd>
|
|
13668
13804
|
|
|
13669
|
-
**requestOptions:** `
|
|
13805
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13670
13806
|
|
|
13671
13807
|
</dd>
|
|
13672
13808
|
</dl>
|
|
@@ -13741,7 +13877,7 @@ await client.query.listVendors("8cfec329267", {
|
|
|
13741
13877
|
<dl>
|
|
13742
13878
|
<dd>
|
|
13743
13879
|
|
|
13744
|
-
**requestOptions:** `
|
|
13880
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13745
13881
|
|
|
13746
13882
|
</dd>
|
|
13747
13883
|
</dl>
|
|
@@ -13816,7 +13952,7 @@ await client.query.listVendorsOrg(123, {
|
|
|
13816
13952
|
<dl>
|
|
13817
13953
|
<dd>
|
|
13818
13954
|
|
|
13819
|
-
**requestOptions:** `
|
|
13955
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13820
13956
|
|
|
13821
13957
|
</dd>
|
|
13822
13958
|
</dl>
|
|
@@ -13891,7 +14027,7 @@ await client.query.listVcards("8cfec329267", {
|
|
|
13891
14027
|
<dl>
|
|
13892
14028
|
<dd>
|
|
13893
14029
|
|
|
13894
|
-
**requestOptions:** `
|
|
14030
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13895
14031
|
|
|
13896
14032
|
</dd>
|
|
13897
14033
|
</dl>
|
|
@@ -13966,7 +14102,7 @@ await client.query.listVcardsOrg(123, {
|
|
|
13966
14102
|
<dl>
|
|
13967
14103
|
<dd>
|
|
13968
14104
|
|
|
13969
|
-
**requestOptions:** `
|
|
14105
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13970
14106
|
|
|
13971
14107
|
</dd>
|
|
13972
14108
|
</dl>
|
|
@@ -13979,7 +14115,7 @@ await client.query.listVcardsOrg(123, {
|
|
|
13979
14115
|
</details>
|
|
13980
14116
|
|
|
13981
14117
|
## Statistic
|
|
13982
|
-
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">basicStats</a>(
|
|
14118
|
+
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">basicStats</a>(mode, freq, level, entryId, { ...params }) -> Payabli.StatBasicExtendedQueryRecord[]</code></summary>
|
|
13983
14119
|
<dl>
|
|
13984
14120
|
<dd>
|
|
13985
14121
|
|
|
@@ -14006,9 +14142,9 @@ Retrieves the basic statistics for an organization or a paypoint, for a given ti
|
|
|
14006
14142
|
<dd>
|
|
14007
14143
|
|
|
14008
14144
|
```typescript
|
|
14009
|
-
await client.statistic.basicStats(
|
|
14010
|
-
endDate: "
|
|
14011
|
-
startDate: "
|
|
14145
|
+
await client.statistic.basicStats("ytd", "m", 1, 1000000, {
|
|
14146
|
+
endDate: "2025-11-01",
|
|
14147
|
+
startDate: "2025-11-30"
|
|
14012
14148
|
});
|
|
14013
14149
|
|
|
14014
14150
|
```
|
|
@@ -14025,7 +14161,23 @@ await client.statistic.basicStats(1000000, "m", 1, "ytd", {
|
|
|
14025
14161
|
<dl>
|
|
14026
14162
|
<dd>
|
|
14027
14163
|
|
|
14028
|
-
**
|
|
14164
|
+
**mode:** `string`
|
|
14165
|
+
|
|
14166
|
+
Mode for the request. Allowed values:
|
|
14167
|
+
|
|
14168
|
+
- `custom` - Allows you to set a custom date range
|
|
14169
|
+
- `ytd` - Year To Date
|
|
14170
|
+
- `mtd` - Month To Date
|
|
14171
|
+
- `wtd` - Week To Date
|
|
14172
|
+
- `today` - All current day
|
|
14173
|
+
- `m12` - Last 12 months
|
|
14174
|
+
- `d30` - Last 30 days
|
|
14175
|
+
- `h24` - Last 24 hours
|
|
14176
|
+
- `lasty` - Last Year
|
|
14177
|
+
- `lastm` - Last Month
|
|
14178
|
+
- `lastw` - Last Week
|
|
14179
|
+
- `yesterday` - Last Day
|
|
14180
|
+
|
|
14029
14181
|
|
|
14030
14182
|
</dd>
|
|
14031
14183
|
</dl>
|
|
@@ -14062,23 +14214,7 @@ The entry level for the request:
|
|
|
14062
14214
|
<dl>
|
|
14063
14215
|
<dd>
|
|
14064
14216
|
|
|
14065
|
-
**
|
|
14066
|
-
|
|
14067
|
-
Mode for the request. Allowed values:
|
|
14068
|
-
|
|
14069
|
-
- `custom` - Allows you to set a custom date range
|
|
14070
|
-
- `ytd` - Year To Date
|
|
14071
|
-
- `mtd` - Month To Date
|
|
14072
|
-
- `wtd` - Week To Date
|
|
14073
|
-
- `today` - All current day
|
|
14074
|
-
- `m12` - Last 12 months
|
|
14075
|
-
- `d30` - Last 30 days
|
|
14076
|
-
- `h24` - Last 24 hours
|
|
14077
|
-
- `lasty` - Last Year
|
|
14078
|
-
- `lastm` - Last Month
|
|
14079
|
-
- `lastw` - Last Week
|
|
14080
|
-
- `yesterday` - Last Day
|
|
14081
|
-
|
|
14217
|
+
**entryId:** `number` — Identifier in Payabli for the entity.
|
|
14082
14218
|
|
|
14083
14219
|
</dd>
|
|
14084
14220
|
</dl>
|
|
@@ -14094,7 +14230,7 @@ Mode for the request. Allowed values:
|
|
|
14094
14230
|
<dl>
|
|
14095
14231
|
<dd>
|
|
14096
14232
|
|
|
14097
|
-
**requestOptions:** `
|
|
14233
|
+
**requestOptions:** `StatisticClient.RequestOptions`
|
|
14098
14234
|
|
|
14099
14235
|
</dd>
|
|
14100
14236
|
</dl>
|
|
@@ -14106,7 +14242,7 @@ Mode for the request. Allowed values:
|
|
|
14106
14242
|
</dl>
|
|
14107
14243
|
</details>
|
|
14108
14244
|
|
|
14109
|
-
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">customerBasicStats</a>(
|
|
14245
|
+
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">customerBasicStats</a>(mode, freq, customerId, { ...params }) -> Payabli.SubscriptionStatsQueryRecord[]</code></summary>
|
|
14110
14246
|
<dl>
|
|
14111
14247
|
<dd>
|
|
14112
14248
|
|
|
@@ -14133,7 +14269,7 @@ Retrieves the basic statistics for a customer for a specific time period, groupe
|
|
|
14133
14269
|
<dd>
|
|
14134
14270
|
|
|
14135
14271
|
```typescript
|
|
14136
|
-
await client.statistic.customerBasicStats(
|
|
14272
|
+
await client.statistic.customerBasicStats("ytd", "m", 998);
|
|
14137
14273
|
|
|
14138
14274
|
```
|
|
14139
14275
|
</dd>
|
|
@@ -14149,7 +14285,21 @@ await client.statistic.customerBasicStats(998, "m", "ytd");
|
|
|
14149
14285
|
<dl>
|
|
14150
14286
|
<dd>
|
|
14151
14287
|
|
|
14152
|
-
**
|
|
14288
|
+
**mode:** `string`
|
|
14289
|
+
|
|
14290
|
+
Mode for request. Allowed values:
|
|
14291
|
+
|
|
14292
|
+
- `ytd` - Year To Date
|
|
14293
|
+
- `mtd` - Month To Date
|
|
14294
|
+
- `wtd` - Week To Date
|
|
14295
|
+
- `today` - All current day
|
|
14296
|
+
- `m12` - Last 12 months
|
|
14297
|
+
- `d30` - Last 30 days
|
|
14298
|
+
- `h24` - Last 24 hours
|
|
14299
|
+
- `lasty` - Last Year
|
|
14300
|
+
- `lastm` - Last Month
|
|
14301
|
+
- `lastw` - Last Week
|
|
14302
|
+
- `yesterday` - Last Day
|
|
14153
14303
|
|
|
14154
14304
|
</dd>
|
|
14155
14305
|
</dl>
|
|
@@ -14174,21 +14324,7 @@ For example, `w` groups the results by week.
|
|
|
14174
14324
|
<dl>
|
|
14175
14325
|
<dd>
|
|
14176
14326
|
|
|
14177
|
-
**
|
|
14178
|
-
|
|
14179
|
-
Mode for request. Allowed values:
|
|
14180
|
-
|
|
14181
|
-
- `ytd` - Year To Date
|
|
14182
|
-
- `mtd` - Month To Date
|
|
14183
|
-
- `wtd` - Week To Date
|
|
14184
|
-
- `today` - All current day
|
|
14185
|
-
- `m12` - Last 12 months
|
|
14186
|
-
- `d30` - Last 30 days
|
|
14187
|
-
- `h24` - Last 24 hours
|
|
14188
|
-
- `lasty` - Last Year
|
|
14189
|
-
- `lastm` - Last Month
|
|
14190
|
-
- `lastw` - Last Week
|
|
14191
|
-
- `yesterday` - Last Day
|
|
14327
|
+
**customerId:** `number` — Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
|
|
14192
14328
|
|
|
14193
14329
|
</dd>
|
|
14194
14330
|
</dl>
|
|
@@ -14204,7 +14340,7 @@ Mode for request. Allowed values:
|
|
|
14204
14340
|
<dl>
|
|
14205
14341
|
<dd>
|
|
14206
14342
|
|
|
14207
|
-
**requestOptions:** `
|
|
14343
|
+
**requestOptions:** `StatisticClient.RequestOptions`
|
|
14208
14344
|
|
|
14209
14345
|
</dd>
|
|
14210
14346
|
</dl>
|
|
@@ -14216,7 +14352,7 @@ Mode for request. Allowed values:
|
|
|
14216
14352
|
</dl>
|
|
14217
14353
|
</details>
|
|
14218
14354
|
|
|
14219
|
-
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">subStats</a>(
|
|
14355
|
+
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">subStats</a>(interval, level, entryId, { ...params }) -> Payabli.StatBasicQueryRecord[]</code></summary>
|
|
14220
14356
|
<dl>
|
|
14221
14357
|
<dd>
|
|
14222
14358
|
|
|
@@ -14243,7 +14379,7 @@ Retrieves the subscription statistics for a given interval for a paypoint or org
|
|
|
14243
14379
|
<dd>
|
|
14244
14380
|
|
|
14245
14381
|
```typescript
|
|
14246
|
-
await client.statistic.subStats(
|
|
14382
|
+
await client.statistic.subStats("30", 1, 1000000);
|
|
14247
14383
|
|
|
14248
14384
|
```
|
|
14249
14385
|
</dd>
|
|
@@ -14259,14 +14395,6 @@ await client.statistic.subStats(1000000, "30", 1);
|
|
|
14259
14395
|
<dl>
|
|
14260
14396
|
<dd>
|
|
14261
14397
|
|
|
14262
|
-
**entryId:** `number` — Identifier in Payabli for the entity.
|
|
14263
|
-
|
|
14264
|
-
</dd>
|
|
14265
|
-
</dl>
|
|
14266
|
-
|
|
14267
|
-
<dl>
|
|
14268
|
-
<dd>
|
|
14269
|
-
|
|
14270
14398
|
**interval:** `string`
|
|
14271
14399
|
|
|
14272
14400
|
Interval to get the data. Allowed values:
|
|
@@ -14295,6 +14423,14 @@ The entry level for the request:
|
|
|
14295
14423
|
<dl>
|
|
14296
14424
|
<dd>
|
|
14297
14425
|
|
|
14426
|
+
**entryId:** `number` — Identifier in Payabli for the entity.
|
|
14427
|
+
|
|
14428
|
+
</dd>
|
|
14429
|
+
</dl>
|
|
14430
|
+
|
|
14431
|
+
<dl>
|
|
14432
|
+
<dd>
|
|
14433
|
+
|
|
14298
14434
|
**request:** `Payabli.SubStatsRequest`
|
|
14299
14435
|
|
|
14300
14436
|
</dd>
|
|
@@ -14303,7 +14439,7 @@ The entry level for the request:
|
|
|
14303
14439
|
<dl>
|
|
14304
14440
|
<dd>
|
|
14305
14441
|
|
|
14306
|
-
**requestOptions:** `
|
|
14442
|
+
**requestOptions:** `StatisticClient.RequestOptions`
|
|
14307
14443
|
|
|
14308
14444
|
</dd>
|
|
14309
14445
|
</dl>
|
|
@@ -14315,7 +14451,7 @@ The entry level for the request:
|
|
|
14315
14451
|
</dl>
|
|
14316
14452
|
</details>
|
|
14317
14453
|
|
|
14318
|
-
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">vendorBasicStats</a>(freq, idVendor,
|
|
14454
|
+
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">vendorBasicStats</a>(mode, freq, idVendor, { ...params }) -> Payabli.StatisticsVendorQueryRecord[]</code></summary>
|
|
14319
14455
|
<dl>
|
|
14320
14456
|
<dd>
|
|
14321
14457
|
|
|
@@ -14342,7 +14478,7 @@ Retrieve the basic statistics about a vendor for a given time period, grouped by
|
|
|
14342
14478
|
<dd>
|
|
14343
14479
|
|
|
14344
14480
|
```typescript
|
|
14345
|
-
await client.statistic.vendorBasicStats("m", 1
|
|
14481
|
+
await client.statistic.vendorBasicStats("ytd", "m", 1);
|
|
14346
14482
|
|
|
14347
14483
|
```
|
|
14348
14484
|
</dd>
|
|
@@ -14358,6 +14494,28 @@ await client.statistic.vendorBasicStats("m", 1, "ytd");
|
|
|
14358
14494
|
<dl>
|
|
14359
14495
|
<dd>
|
|
14360
14496
|
|
|
14497
|
+
**mode:** `string`
|
|
14498
|
+
|
|
14499
|
+
Mode for request. Allowed values:
|
|
14500
|
+
|
|
14501
|
+
- `ytd` - Year To Date
|
|
14502
|
+
- `mtd` - Month To Date
|
|
14503
|
+
- `wtd` - Week To Date
|
|
14504
|
+
- `today` - All current day
|
|
14505
|
+
- `m12` - Last 12 months
|
|
14506
|
+
- `d30` - Last 30 days
|
|
14507
|
+
- `h24` - Last 24 hours
|
|
14508
|
+
- `lasty` - Last Year
|
|
14509
|
+
- `lastm` - Last Month
|
|
14510
|
+
- `lastw` - Last Week
|
|
14511
|
+
- `yesterday` - Last Day
|
|
14512
|
+
|
|
14513
|
+
</dd>
|
|
14514
|
+
</dl>
|
|
14515
|
+
|
|
14516
|
+
<dl>
|
|
14517
|
+
<dd>
|
|
14518
|
+
|
|
14361
14519
|
**freq:** `string`
|
|
14362
14520
|
|
|
14363
14521
|
Frequency to group series. Allowed values:
|
|
@@ -14383,28 +14541,6 @@ For example, `w` groups the results by week.
|
|
|
14383
14541
|
<dl>
|
|
14384
14542
|
<dd>
|
|
14385
14543
|
|
|
14386
|
-
**mode:** `string`
|
|
14387
|
-
|
|
14388
|
-
Mode for request. Allowed values:
|
|
14389
|
-
|
|
14390
|
-
- `ytd` - Year To Date
|
|
14391
|
-
- `mtd` - Month To Date
|
|
14392
|
-
- `wtd` - Week To Date
|
|
14393
|
-
- `today` - All current day
|
|
14394
|
-
- `m12` - Last 12 months
|
|
14395
|
-
- `d30` - Last 30 days
|
|
14396
|
-
- `h24` - Last 24 hours
|
|
14397
|
-
- `lasty` - Last Year
|
|
14398
|
-
- `lastm` - Last Month
|
|
14399
|
-
- `lastw` - Last Week
|
|
14400
|
-
- `yesterday` - Last Day
|
|
14401
|
-
|
|
14402
|
-
</dd>
|
|
14403
|
-
</dl>
|
|
14404
|
-
|
|
14405
|
-
<dl>
|
|
14406
|
-
<dd>
|
|
14407
|
-
|
|
14408
14544
|
**request:** `Payabli.VendorBasicStatsRequest`
|
|
14409
14545
|
|
|
14410
14546
|
</dd>
|
|
@@ -14413,7 +14549,7 @@ Mode for request. Allowed values:
|
|
|
14413
14549
|
<dl>
|
|
14414
14550
|
<dd>
|
|
14415
14551
|
|
|
14416
|
-
**requestOptions:** `
|
|
14552
|
+
**requestOptions:** `StatisticClient.RequestOptions`
|
|
14417
14553
|
|
|
14418
14554
|
</dd>
|
|
14419
14555
|
</dl>
|
|
@@ -14477,7 +14613,7 @@ await client.subscription.getSubscription(263);
|
|
|
14477
14613
|
<dl>
|
|
14478
14614
|
<dd>
|
|
14479
14615
|
|
|
14480
|
-
**requestOptions:** `
|
|
14616
|
+
**requestOptions:** `SubscriptionClient.RequestOptions`
|
|
14481
14617
|
|
|
14482
14618
|
</dd>
|
|
14483
14619
|
</dl>
|
|
@@ -14566,7 +14702,7 @@ await client.subscription.newSubscription({
|
|
|
14566
14702
|
<dl>
|
|
14567
14703
|
<dd>
|
|
14568
14704
|
|
|
14569
|
-
**requestOptions:** `
|
|
14705
|
+
**requestOptions:** `SubscriptionClient.RequestOptions`
|
|
14570
14706
|
|
|
14571
14707
|
</dd>
|
|
14572
14708
|
</dl>
|
|
@@ -14629,7 +14765,7 @@ await client.subscription.removeSubscription(396);
|
|
|
14629
14765
|
<dl>
|
|
14630
14766
|
<dd>
|
|
14631
14767
|
|
|
14632
|
-
**requestOptions:** `
|
|
14768
|
+
**requestOptions:** `SubscriptionClient.RequestOptions`
|
|
14633
14769
|
|
|
14634
14770
|
</dd>
|
|
14635
14771
|
</dl>
|
|
@@ -14702,7 +14838,7 @@ await client.subscription.updateSubscription(231, {
|
|
|
14702
14838
|
<dl>
|
|
14703
14839
|
<dd>
|
|
14704
14840
|
|
|
14705
|
-
**requestOptions:** `
|
|
14841
|
+
**requestOptions:** `SubscriptionClient.RequestOptions`
|
|
14706
14842
|
|
|
14707
14843
|
</dd>
|
|
14708
14844
|
</dl>
|
|
@@ -14766,7 +14902,7 @@ await client.templates.deleteTemplate(80);
|
|
|
14766
14902
|
<dl>
|
|
14767
14903
|
<dd>
|
|
14768
14904
|
|
|
14769
|
-
**requestOptions:** `
|
|
14905
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
14770
14906
|
|
|
14771
14907
|
</dd>
|
|
14772
14908
|
</dl>
|
|
@@ -14778,7 +14914,7 @@ await client.templates.deleteTemplate(80);
|
|
|
14778
14914
|
</dl>
|
|
14779
14915
|
</details>
|
|
14780
14916
|
|
|
14781
|
-
<details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">getlinkTemplate</a>(
|
|
14917
|
+
<details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">getlinkTemplate</a>(templateId, ignoreEmpty) -> Payabli.BoardingLinkApiResponse</code></summary>
|
|
14782
14918
|
<dl>
|
|
14783
14919
|
<dd>
|
|
14784
14920
|
|
|
@@ -14805,7 +14941,7 @@ Generates a boarding link from a boarding template.
|
|
|
14805
14941
|
<dd>
|
|
14806
14942
|
|
|
14807
14943
|
```typescript
|
|
14808
|
-
await client.templates.getlinkTemplate(
|
|
14944
|
+
await client.templates.getlinkTemplate(80, true);
|
|
14809
14945
|
|
|
14810
14946
|
```
|
|
14811
14947
|
</dd>
|
|
@@ -14821,7 +14957,7 @@ await client.templates.getlinkTemplate(true, 80);
|
|
|
14821
14957
|
<dl>
|
|
14822
14958
|
<dd>
|
|
14823
14959
|
|
|
14824
|
-
**
|
|
14960
|
+
**templateId:** `number` — The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
|
|
14825
14961
|
|
|
14826
14962
|
</dd>
|
|
14827
14963
|
</dl>
|
|
@@ -14829,7 +14965,7 @@ await client.templates.getlinkTemplate(true, 80);
|
|
|
14829
14965
|
<dl>
|
|
14830
14966
|
<dd>
|
|
14831
14967
|
|
|
14832
|
-
**
|
|
14968
|
+
**ignoreEmpty:** `boolean` — Ignore read-only and empty fields Default is `false`. If `ignoreEmpty` = `false` and any field is empty, then the request returns a failure response. If `ignoreEmpty` = `true`, the request returns the boarding link name regardless of whether fields are empty.
|
|
14833
14969
|
|
|
14834
14970
|
</dd>
|
|
14835
14971
|
</dl>
|
|
@@ -14837,7 +14973,7 @@ await client.templates.getlinkTemplate(true, 80);
|
|
|
14837
14973
|
<dl>
|
|
14838
14974
|
<dd>
|
|
14839
14975
|
|
|
14840
|
-
**requestOptions:** `
|
|
14976
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
14841
14977
|
|
|
14842
14978
|
</dd>
|
|
14843
14979
|
</dl>
|
|
@@ -14900,7 +15036,7 @@ await client.templates.getTemplate(80);
|
|
|
14900
15036
|
<dl>
|
|
14901
15037
|
<dd>
|
|
14902
15038
|
|
|
14903
|
-
**requestOptions:** `
|
|
15039
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
14904
15040
|
|
|
14905
15041
|
</dd>
|
|
14906
15042
|
</dl>
|
|
@@ -14975,7 +15111,7 @@ await client.templates.listTemplates(123, {
|
|
|
14975
15111
|
<dl>
|
|
14976
15112
|
<dd>
|
|
14977
15113
|
|
|
14978
|
-
**requestOptions:** `
|
|
15114
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
14979
15115
|
|
|
14980
15116
|
</dd>
|
|
14981
15117
|
</dl>
|
|
@@ -15055,7 +15191,7 @@ await client.tokenStorage.addMethod({
|
|
|
15055
15191
|
<dl>
|
|
15056
15192
|
<dd>
|
|
15057
15193
|
|
|
15058
|
-
**requestOptions:** `
|
|
15194
|
+
**requestOptions:** `TokenStorageClient.RequestOptions`
|
|
15059
15195
|
|
|
15060
15196
|
</dd>
|
|
15061
15197
|
</dl>
|
|
@@ -15129,7 +15265,7 @@ await client.tokenStorage.getMethod("32-8877drt00045632-678", {
|
|
|
15129
15265
|
<dl>
|
|
15130
15266
|
<dd>
|
|
15131
15267
|
|
|
15132
|
-
**requestOptions:** `
|
|
15268
|
+
**requestOptions:** `TokenStorageClient.RequestOptions`
|
|
15133
15269
|
|
|
15134
15270
|
</dd>
|
|
15135
15271
|
</dl>
|
|
@@ -15192,7 +15328,7 @@ await client.tokenStorage.removeMethod("32-8877drt00045632-678");
|
|
|
15192
15328
|
<dl>
|
|
15193
15329
|
<dd>
|
|
15194
15330
|
|
|
15195
|
-
**requestOptions:** `
|
|
15331
|
+
**requestOptions:** `TokenStorageClient.RequestOptions`
|
|
15196
15332
|
|
|
15197
15333
|
</dd>
|
|
15198
15334
|
</dl>
|
|
@@ -15279,7 +15415,7 @@ await client.tokenStorage.updateMethod("32-8877drt00045632-678", {
|
|
|
15279
15415
|
<dl>
|
|
15280
15416
|
<dd>
|
|
15281
15417
|
|
|
15282
|
-
**requestOptions:** `
|
|
15418
|
+
**requestOptions:** `TokenStorageClient.RequestOptions`
|
|
15283
15419
|
|
|
15284
15420
|
</dd>
|
|
15285
15421
|
</dl>
|
|
@@ -15296,6 +15432,20 @@ await client.tokenStorage.updateMethod("32-8877drt00045632-678", {
|
|
|
15296
15432
|
<dl>
|
|
15297
15433
|
<dd>
|
|
15298
15434
|
|
|
15435
|
+
#### 📝 Description
|
|
15436
|
+
|
|
15437
|
+
<dl>
|
|
15438
|
+
<dd>
|
|
15439
|
+
|
|
15440
|
+
<dl>
|
|
15441
|
+
<dd>
|
|
15442
|
+
|
|
15443
|
+
Use this endpoint to add a new user to an organization.
|
|
15444
|
+
</dd>
|
|
15445
|
+
</dl>
|
|
15446
|
+
</dd>
|
|
15447
|
+
</dl>
|
|
15448
|
+
|
|
15299
15449
|
#### 🔌 Usage
|
|
15300
15450
|
|
|
15301
15451
|
<dl>
|
|
@@ -15329,7 +15479,7 @@ await client.user.addUser({});
|
|
|
15329
15479
|
<dl>
|
|
15330
15480
|
<dd>
|
|
15331
15481
|
|
|
15332
|
-
**requestOptions:** `
|
|
15482
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15333
15483
|
|
|
15334
15484
|
</dd>
|
|
15335
15485
|
</dl>
|
|
@@ -15345,6 +15495,20 @@ await client.user.addUser({});
|
|
|
15345
15495
|
<dl>
|
|
15346
15496
|
<dd>
|
|
15347
15497
|
|
|
15498
|
+
#### 📝 Description
|
|
15499
|
+
|
|
15500
|
+
<dl>
|
|
15501
|
+
<dd>
|
|
15502
|
+
|
|
15503
|
+
<dl>
|
|
15504
|
+
<dd>
|
|
15505
|
+
|
|
15506
|
+
Use this endpoint to refresh the authentication token for a user within an organization.
|
|
15507
|
+
</dd>
|
|
15508
|
+
</dl>
|
|
15509
|
+
</dd>
|
|
15510
|
+
</dl>
|
|
15511
|
+
|
|
15348
15512
|
#### 🔌 Usage
|
|
15349
15513
|
|
|
15350
15514
|
<dl>
|
|
@@ -15370,7 +15534,7 @@ await client.user.authRefreshUser();
|
|
|
15370
15534
|
<dl>
|
|
15371
15535
|
<dd>
|
|
15372
15536
|
|
|
15373
|
-
**requestOptions:** `
|
|
15537
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15374
15538
|
|
|
15375
15539
|
</dd>
|
|
15376
15540
|
</dl>
|
|
@@ -15386,6 +15550,20 @@ await client.user.authRefreshUser();
|
|
|
15386
15550
|
<dl>
|
|
15387
15551
|
<dd>
|
|
15388
15552
|
|
|
15553
|
+
#### 📝 Description
|
|
15554
|
+
|
|
15555
|
+
<dl>
|
|
15556
|
+
<dd>
|
|
15557
|
+
|
|
15558
|
+
<dl>
|
|
15559
|
+
<dd>
|
|
15560
|
+
|
|
15561
|
+
Use this endpoint to initiate a password reset for a user within an organization.
|
|
15562
|
+
</dd>
|
|
15563
|
+
</dl>
|
|
15564
|
+
</dd>
|
|
15565
|
+
</dl>
|
|
15566
|
+
|
|
15389
15567
|
#### 🔌 Usage
|
|
15390
15568
|
|
|
15391
15569
|
<dl>
|
|
@@ -15419,7 +15597,7 @@ await client.user.authResetUser();
|
|
|
15419
15597
|
<dl>
|
|
15420
15598
|
<dd>
|
|
15421
15599
|
|
|
15422
|
-
**requestOptions:** `
|
|
15600
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15423
15601
|
|
|
15424
15602
|
</dd>
|
|
15425
15603
|
</dl>
|
|
@@ -15490,7 +15668,7 @@ await client.user.authUser("provider");
|
|
|
15490
15668
|
<dl>
|
|
15491
15669
|
<dd>
|
|
15492
15670
|
|
|
15493
|
-
**requestOptions:** `
|
|
15671
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15494
15672
|
|
|
15495
15673
|
</dd>
|
|
15496
15674
|
</dl>
|
|
@@ -15506,6 +15684,20 @@ await client.user.authUser("provider");
|
|
|
15506
15684
|
<dl>
|
|
15507
15685
|
<dd>
|
|
15508
15686
|
|
|
15687
|
+
#### 📝 Description
|
|
15688
|
+
|
|
15689
|
+
<dl>
|
|
15690
|
+
<dd>
|
|
15691
|
+
|
|
15692
|
+
<dl>
|
|
15693
|
+
<dd>
|
|
15694
|
+
|
|
15695
|
+
Use this endpoint to change the password for a user within an organization.
|
|
15696
|
+
</dd>
|
|
15697
|
+
</dl>
|
|
15698
|
+
</dd>
|
|
15699
|
+
</dl>
|
|
15700
|
+
|
|
15509
15701
|
#### 🔌 Usage
|
|
15510
15702
|
|
|
15511
15703
|
<dl>
|
|
@@ -15539,7 +15731,7 @@ await client.user.changePswUser();
|
|
|
15539
15731
|
<dl>
|
|
15540
15732
|
<dd>
|
|
15541
15733
|
|
|
15542
|
-
**requestOptions:** `
|
|
15734
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15543
15735
|
|
|
15544
15736
|
</dd>
|
|
15545
15737
|
</dl>
|
|
@@ -15555,6 +15747,20 @@ await client.user.changePswUser();
|
|
|
15555
15747
|
<dl>
|
|
15556
15748
|
<dd>
|
|
15557
15749
|
|
|
15750
|
+
#### 📝 Description
|
|
15751
|
+
|
|
15752
|
+
<dl>
|
|
15753
|
+
<dd>
|
|
15754
|
+
|
|
15755
|
+
<dl>
|
|
15756
|
+
<dd>
|
|
15757
|
+
|
|
15758
|
+
Use this endpoint to delete a specific user within an organization.
|
|
15759
|
+
</dd>
|
|
15760
|
+
</dl>
|
|
15761
|
+
</dd>
|
|
15762
|
+
</dl>
|
|
15763
|
+
|
|
15558
15764
|
#### 🔌 Usage
|
|
15559
15765
|
|
|
15560
15766
|
<dl>
|
|
@@ -15588,7 +15794,7 @@ await client.user.deleteUser(1000000);
|
|
|
15588
15794
|
<dl>
|
|
15589
15795
|
<dd>
|
|
15590
15796
|
|
|
15591
|
-
**requestOptions:** `
|
|
15797
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15592
15798
|
|
|
15593
15799
|
</dd>
|
|
15594
15800
|
</dl>
|
|
@@ -15604,6 +15810,20 @@ await client.user.deleteUser(1000000);
|
|
|
15604
15810
|
<dl>
|
|
15605
15811
|
<dd>
|
|
15606
15812
|
|
|
15813
|
+
#### 📝 Description
|
|
15814
|
+
|
|
15815
|
+
<dl>
|
|
15816
|
+
<dd>
|
|
15817
|
+
|
|
15818
|
+
<dl>
|
|
15819
|
+
<dd>
|
|
15820
|
+
|
|
15821
|
+
Use this endpoint to enable or disable multi-factor authentication (MFA) for a user within an organization.
|
|
15822
|
+
</dd>
|
|
15823
|
+
</dl>
|
|
15824
|
+
</dd>
|
|
15825
|
+
</dl>
|
|
15826
|
+
|
|
15607
15827
|
#### 🔌 Usage
|
|
15608
15828
|
|
|
15609
15829
|
<dl>
|
|
@@ -15645,7 +15865,7 @@ await client.user.editMfaUser(1000000, {});
|
|
|
15645
15865
|
<dl>
|
|
15646
15866
|
<dd>
|
|
15647
15867
|
|
|
15648
|
-
**requestOptions:** `
|
|
15868
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15649
15869
|
|
|
15650
15870
|
</dd>
|
|
15651
15871
|
</dl>
|
|
@@ -15661,6 +15881,20 @@ await client.user.editMfaUser(1000000, {});
|
|
|
15661
15881
|
<dl>
|
|
15662
15882
|
<dd>
|
|
15663
15883
|
|
|
15884
|
+
#### 📝 Description
|
|
15885
|
+
|
|
15886
|
+
<dl>
|
|
15887
|
+
<dd>
|
|
15888
|
+
|
|
15889
|
+
<dl>
|
|
15890
|
+
<dd>
|
|
15891
|
+
|
|
15892
|
+
Use this endpoint to modify the details of a specific user within an organization.
|
|
15893
|
+
</dd>
|
|
15894
|
+
</dl>
|
|
15895
|
+
</dd>
|
|
15896
|
+
</dl>
|
|
15897
|
+
|
|
15664
15898
|
#### 🔌 Usage
|
|
15665
15899
|
|
|
15666
15900
|
<dl>
|
|
@@ -15702,7 +15936,7 @@ await client.user.editUser(1000000, {});
|
|
|
15702
15936
|
<dl>
|
|
15703
15937
|
<dd>
|
|
15704
15938
|
|
|
15705
|
-
**requestOptions:** `
|
|
15939
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15706
15940
|
|
|
15707
15941
|
</dd>
|
|
15708
15942
|
</dl>
|
|
@@ -15718,6 +15952,20 @@ await client.user.editUser(1000000, {});
|
|
|
15718
15952
|
<dl>
|
|
15719
15953
|
<dd>
|
|
15720
15954
|
|
|
15955
|
+
#### 📝 Description
|
|
15956
|
+
|
|
15957
|
+
<dl>
|
|
15958
|
+
<dd>
|
|
15959
|
+
|
|
15960
|
+
<dl>
|
|
15961
|
+
<dd>
|
|
15962
|
+
|
|
15963
|
+
Use this endpoint to retrieve information about a specific user within an organization.
|
|
15964
|
+
</dd>
|
|
15965
|
+
</dl>
|
|
15966
|
+
</dd>
|
|
15967
|
+
</dl>
|
|
15968
|
+
|
|
15721
15969
|
#### 🔌 Usage
|
|
15722
15970
|
|
|
15723
15971
|
<dl>
|
|
@@ -15761,7 +16009,7 @@ await client.user.getUser(1000000, {
|
|
|
15761
16009
|
<dl>
|
|
15762
16010
|
<dd>
|
|
15763
16011
|
|
|
15764
|
-
**requestOptions:** `
|
|
16012
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15765
16013
|
|
|
15766
16014
|
</dd>
|
|
15767
16015
|
</dl>
|
|
@@ -15777,6 +16025,20 @@ await client.user.getUser(1000000, {
|
|
|
15777
16025
|
<dl>
|
|
15778
16026
|
<dd>
|
|
15779
16027
|
|
|
16028
|
+
#### 📝 Description
|
|
16029
|
+
|
|
16030
|
+
<dl>
|
|
16031
|
+
<dd>
|
|
16032
|
+
|
|
16033
|
+
<dl>
|
|
16034
|
+
<dd>
|
|
16035
|
+
|
|
16036
|
+
Use this endpoint to log a user out from the system.
|
|
16037
|
+
</dd>
|
|
16038
|
+
</dl>
|
|
16039
|
+
</dd>
|
|
16040
|
+
</dl>
|
|
16041
|
+
|
|
15780
16042
|
#### 🔌 Usage
|
|
15781
16043
|
|
|
15782
16044
|
<dl>
|
|
@@ -15802,7 +16064,7 @@ await client.user.logoutUser();
|
|
|
15802
16064
|
<dl>
|
|
15803
16065
|
<dd>
|
|
15804
16066
|
|
|
15805
|
-
**requestOptions:** `
|
|
16067
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15806
16068
|
|
|
15807
16069
|
</dd>
|
|
15808
16070
|
</dl>
|
|
@@ -15814,10 +16076,24 @@ await client.user.logoutUser();
|
|
|
15814
16076
|
</dl>
|
|
15815
16077
|
</details>
|
|
15816
16078
|
|
|
15817
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">resendMfaCode</a>(
|
|
16079
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">resendMfaCode</a>(usrname, Entry, EntryType) -> Payabli.PayabliApiResponseMfaBasic</code></summary>
|
|
15818
16080
|
<dl>
|
|
15819
16081
|
<dd>
|
|
15820
16082
|
|
|
16083
|
+
#### 📝 Description
|
|
16084
|
+
|
|
16085
|
+
<dl>
|
|
16086
|
+
<dd>
|
|
16087
|
+
|
|
16088
|
+
<dl>
|
|
16089
|
+
<dd>
|
|
16090
|
+
|
|
16091
|
+
Resends the MFA code to the user via the selected MFA mode (email or SMS).
|
|
16092
|
+
</dd>
|
|
16093
|
+
</dl>
|
|
16094
|
+
</dd>
|
|
16095
|
+
</dl>
|
|
16096
|
+
|
|
15821
16097
|
#### 🔌 Usage
|
|
15822
16098
|
|
|
15823
16099
|
<dl>
|
|
@@ -15827,7 +16103,7 @@ await client.user.logoutUser();
|
|
|
15827
16103
|
<dd>
|
|
15828
16104
|
|
|
15829
16105
|
```typescript
|
|
15830
|
-
await client.user.resendMfaCode("Entry", 1
|
|
16106
|
+
await client.user.resendMfaCode("usrname", "Entry", 1);
|
|
15831
16107
|
|
|
15832
16108
|
```
|
|
15833
16109
|
</dd>
|
|
@@ -15843,7 +16119,7 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15843
16119
|
<dl>
|
|
15844
16120
|
<dd>
|
|
15845
16121
|
|
|
15846
|
-
**
|
|
16122
|
+
**usrname:** `string` —
|
|
15847
16123
|
|
|
15848
16124
|
</dd>
|
|
15849
16125
|
</dl>
|
|
@@ -15851,7 +16127,7 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15851
16127
|
<dl>
|
|
15852
16128
|
<dd>
|
|
15853
16129
|
|
|
15854
|
-
**
|
|
16130
|
+
**Entry:** `string` —
|
|
15855
16131
|
|
|
15856
16132
|
</dd>
|
|
15857
16133
|
</dl>
|
|
@@ -15859,7 +16135,7 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15859
16135
|
<dl>
|
|
15860
16136
|
<dd>
|
|
15861
16137
|
|
|
15862
|
-
**
|
|
16138
|
+
**EntryType:** `number` —
|
|
15863
16139
|
|
|
15864
16140
|
</dd>
|
|
15865
16141
|
</dl>
|
|
@@ -15867,7 +16143,7 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15867
16143
|
<dl>
|
|
15868
16144
|
<dd>
|
|
15869
16145
|
|
|
15870
|
-
**requestOptions:** `
|
|
16146
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15871
16147
|
|
|
15872
16148
|
</dd>
|
|
15873
16149
|
</dl>
|
|
@@ -15883,6 +16159,20 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15883
16159
|
<dl>
|
|
15884
16160
|
<dd>
|
|
15885
16161
|
|
|
16162
|
+
#### 📝 Description
|
|
16163
|
+
|
|
16164
|
+
<dl>
|
|
16165
|
+
<dd>
|
|
16166
|
+
|
|
16167
|
+
<dl>
|
|
16168
|
+
<dd>
|
|
16169
|
+
|
|
16170
|
+
Use this endpoint to validate the multi-factor authentication (MFA) code for a user within an organization.
|
|
16171
|
+
</dd>
|
|
16172
|
+
</dl>
|
|
16173
|
+
</dd>
|
|
16174
|
+
</dl>
|
|
16175
|
+
|
|
15886
16176
|
#### 🔌 Usage
|
|
15887
16177
|
|
|
15888
16178
|
<dl>
|
|
@@ -15916,7 +16206,7 @@ await client.user.validateMfaUser();
|
|
|
15916
16206
|
<dl>
|
|
15917
16207
|
<dd>
|
|
15918
16208
|
|
|
15919
|
-
**requestOptions:** `
|
|
16209
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15920
16210
|
|
|
15921
16211
|
</dd>
|
|
15922
16212
|
</dl>
|
|
@@ -16031,7 +16321,7 @@ await client.vendor.addVendor("8cfec329267", {
|
|
|
16031
16321
|
<dl>
|
|
16032
16322
|
<dd>
|
|
16033
16323
|
|
|
16034
|
-
**requestOptions:** `
|
|
16324
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
16035
16325
|
|
|
16036
16326
|
</dd>
|
|
16037
16327
|
</dl>
|
|
@@ -16094,7 +16384,7 @@ await client.vendor.deleteVendor(1);
|
|
|
16094
16384
|
<dl>
|
|
16095
16385
|
<dd>
|
|
16096
16386
|
|
|
16097
|
-
**requestOptions:** `
|
|
16387
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
16098
16388
|
|
|
16099
16389
|
</dd>
|
|
16100
16390
|
</dl>
|
|
@@ -16167,7 +16457,7 @@ await client.vendor.editVendor(1, {
|
|
|
16167
16457
|
<dl>
|
|
16168
16458
|
<dd>
|
|
16169
16459
|
|
|
16170
|
-
**requestOptions:** `
|
|
16460
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
16171
16461
|
|
|
16172
16462
|
</dd>
|
|
16173
16463
|
</dl>
|
|
@@ -16230,7 +16520,7 @@ await client.vendor.getVendor(1);
|
|
|
16230
16520
|
<dl>
|
|
16231
16521
|
<dd>
|
|
16232
16522
|
|
|
16233
|
-
**requestOptions:** `
|
|
16523
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
16234
16524
|
|
|
16235
16525
|
</dd>
|
|
16236
16526
|
</dl>
|
|
@@ -16298,7 +16588,7 @@ await client.wallet.configureApplePayOrganization({
|
|
|
16298
16588
|
<dl>
|
|
16299
16589
|
<dd>
|
|
16300
16590
|
|
|
16301
|
-
**requestOptions:** `
|
|
16591
|
+
**requestOptions:** `WalletClient.RequestOptions`
|
|
16302
16592
|
|
|
16303
16593
|
</dd>
|
|
16304
16594
|
</dl>
|
|
@@ -16364,7 +16654,7 @@ await client.wallet.configureApplePayPaypoint({
|
|
|
16364
16654
|
<dl>
|
|
16365
16655
|
<dd>
|
|
16366
16656
|
|
|
16367
|
-
**requestOptions:** `
|
|
16657
|
+
**requestOptions:** `WalletClient.RequestOptions`
|
|
16368
16658
|
|
|
16369
16659
|
</dd>
|
|
16370
16660
|
</dl>
|
|
@@ -16431,7 +16721,7 @@ await client.wallet.configureGooglePayOrganization({
|
|
|
16431
16721
|
<dl>
|
|
16432
16722
|
<dd>
|
|
16433
16723
|
|
|
16434
|
-
**requestOptions:** `
|
|
16724
|
+
**requestOptions:** `WalletClient.RequestOptions`
|
|
16435
16725
|
|
|
16436
16726
|
</dd>
|
|
16437
16727
|
</dl>
|
|
@@ -16497,7 +16787,7 @@ await client.wallet.configureGooglePayPaypoint({
|
|
|
16497
16787
|
<dl>
|
|
16498
16788
|
<dd>
|
|
16499
16789
|
|
|
16500
|
-
**requestOptions:** `
|
|
16790
|
+
**requestOptions:** `WalletClient.RequestOptions`
|
|
16501
16791
|
|
|
16502
16792
|
</dd>
|
|
16503
16793
|
</dl>
|