@payabli/sdk-node 0.0.129 → 0.0.130
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/bill/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/bill/client/Client.js +2 -2
- package/dist/cjs/api/resources/cloud/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/cloud/client/Client.js +4 -4
- package/dist/cjs/api/resources/export/client/Client.d.ts +14 -14
- package/dist/cjs/api/resources/export/client/Client.js +14 -14
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.js +3 -3
- package/dist/cjs/api/resources/invoice/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/invoice/client/Client.js +3 -3
- package/dist/cjs/api/resources/lineItem/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/lineItem/client/Client.js +2 -2
- package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +10 -10
- package/dist/cjs/api/resources/moneyIn/client/Client.js +10 -10
- package/dist/cjs/api/resources/moneyIn/types/TransactionDetailResponseData.d.ts +2 -2
- package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +31 -0
- package/dist/cjs/api/resources/moneyOut/client/Client.js +75 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.d.ts +10 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.js +13 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/index.js +1 -0
- package/dist/cjs/api/resources/organization/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/organization/client/Client.js +1 -1
- package/dist/cjs/api/resources/paypoint/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/paypoint/client/Client.js +6 -6
- package/dist/cjs/api/resources/query/client/Client.d.ts +63 -2
- package/dist/cjs/api/resources/query/client/Client.js +228 -2
- package/dist/cjs/api/resources/query/client/requests/ListTransactionsOrgRequest.d.ts +0 -1
- package/dist/cjs/api/resources/query/client/requests/ListTransferDetailsOutRequest.d.ts +45 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransferDetailsOutRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersOutOrgRequest.d.ts +46 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersOutOrgRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersOutPaypointRequest.d.ts +46 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersOutPaypointRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersPaypointRequest.d.ts +0 -1
- package/dist/cjs/api/resources/query/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/queryTypes/types/QueryBatchesResponse.d.ts +3 -3
- package/dist/cjs/api/resources/queryTypes/types/TransferOutBankAccount.d.ts +11 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutBankAccount.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBill.d.ts +36 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBill.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBillAttachment.d.ts +15 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBillAttachment.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailCheckData.d.ts +9 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailCheckData.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailEvent.d.ts +11 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailEvent.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailPaymentData.d.ts +41 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailPaymentData.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailQueryResponse.d.ts +10 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailQueryResponse.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailRecord.d.ts +132 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailRecord.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendor.d.ts +96 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendor.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.d.ts +35 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutEventData.d.ts +15 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutEventData.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutMessage.d.ts +22 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutMessage.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutMessageProperties.d.ts +9 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutMessageProperties.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutQueryResponse.d.ts +10 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutQueryResponse.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutRecord.d.ts +74 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutRecord.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutSummary.d.ts +11 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutSummary.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/index.d.ts +16 -0
- package/dist/cjs/api/resources/queryTypes/types/index.js +16 -0
- package/dist/cjs/api/resources/v2MoneyInTypes/types/V2BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/v2MoneyInTypes/types/V2ResponseCode.d.ts +1 -1
- package/dist/cjs/api/types/Entry.d.ts +1 -1
- package/dist/cjs/api/types/PendingFeeAmount.d.ts +1 -1
- package/dist/cjs/api/types/QueryTransactionEvents.d.ts +1 -1
- package/dist/cjs/api/types/Responsecode.d.ts +1 -1
- package/dist/cjs/api/types/ResultCodeText.d.ts +1 -1
- package/dist/cjs/api/types/ResultCodev2.d.ts +1 -1
- package/dist/cjs/api/types/SettingElement.d.ts +1 -1
- package/dist/cjs/api/types/Transfer.d.ts +2 -1
- package/dist/cjs/api/types/TransferBankAccount.d.ts +1 -0
- package/dist/cjs/api/types/TransferQueryResponse.d.ts +2 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/bill/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/bill/client/Client.mjs +2 -2
- package/dist/esm/api/resources/cloud/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/cloud/client/Client.mjs +4 -4
- package/dist/esm/api/resources/export/client/Client.d.mts +14 -14
- package/dist/esm/api/resources/export/client/Client.mjs +14 -14
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.mjs +3 -3
- package/dist/esm/api/resources/invoice/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/invoice/client/Client.mjs +3 -3
- package/dist/esm/api/resources/lineItem/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/lineItem/client/Client.mjs +2 -2
- package/dist/esm/api/resources/moneyIn/client/Client.d.mts +10 -10
- package/dist/esm/api/resources/moneyIn/client/Client.mjs +10 -10
- package/dist/esm/api/resources/moneyIn/types/TransactionDetailResponseData.d.mts +2 -2
- package/dist/esm/api/resources/moneyOut/client/Client.d.mts +31 -0
- package/dist/esm/api/resources/moneyOut/client/Client.mjs +75 -0
- package/dist/esm/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.d.mts +10 -0
- package/dist/esm/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.mjs +10 -0
- package/dist/esm/api/resources/moneyOutTypes/types/index.d.mts +1 -0
- package/dist/esm/api/resources/moneyOutTypes/types/index.mjs +1 -0
- package/dist/esm/api/resources/organization/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/organization/client/Client.mjs +1 -1
- package/dist/esm/api/resources/paypoint/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/paypoint/client/Client.mjs +6 -6
- package/dist/esm/api/resources/query/client/Client.d.mts +63 -2
- package/dist/esm/api/resources/query/client/Client.mjs +228 -2
- package/dist/esm/api/resources/query/client/requests/ListTransactionsOrgRequest.d.mts +0 -1
- package/dist/esm/api/resources/query/client/requests/ListTransferDetailsOutRequest.d.mts +45 -0
- package/dist/esm/api/resources/query/client/requests/ListTransferDetailsOutRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersOutOrgRequest.d.mts +46 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersOutOrgRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersOutPaypointRequest.d.mts +46 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersOutPaypointRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersPaypointRequest.d.mts +0 -1
- package/dist/esm/api/resources/query/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/queryTypes/types/QueryBatchesResponse.d.mts +3 -3
- package/dist/esm/api/resources/queryTypes/types/TransferOutBankAccount.d.mts +11 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutBankAccount.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBill.d.mts +36 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBill.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBillAttachment.d.mts +15 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBillAttachment.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailCheckData.d.mts +9 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailCheckData.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailEvent.d.mts +11 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailEvent.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailPaymentData.d.mts +41 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailPaymentData.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailQueryResponse.d.mts +10 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailQueryResponse.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailRecord.d.mts +132 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailRecord.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendor.d.mts +96 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendor.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.d.mts +35 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutEventData.d.mts +15 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutEventData.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutMessage.d.mts +22 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutMessage.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutMessageProperties.d.mts +9 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutMessageProperties.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutQueryResponse.d.mts +10 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutQueryResponse.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutRecord.d.mts +74 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutRecord.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutSummary.d.mts +11 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutSummary.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/index.d.mts +16 -0
- package/dist/esm/api/resources/queryTypes/types/index.mjs +16 -0
- package/dist/esm/api/resources/v2MoneyInTypes/types/V2BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/v2MoneyInTypes/types/V2ResponseCode.d.mts +1 -1
- package/dist/esm/api/types/Entry.d.mts +1 -1
- package/dist/esm/api/types/PendingFeeAmount.d.mts +1 -1
- package/dist/esm/api/types/QueryTransactionEvents.d.mts +1 -1
- package/dist/esm/api/types/Responsecode.d.mts +1 -1
- package/dist/esm/api/types/ResultCodeText.d.mts +1 -1
- package/dist/esm/api/types/ResultCodev2.d.mts +1 -1
- package/dist/esm/api/types/SettingElement.d.mts +1 -1
- package/dist/esm/api/types/Transfer.d.mts +2 -1
- package/dist/esm/api/types/TransferBankAccount.d.mts +1 -0
- package/dist/esm/api/types/TransferQueryResponse.d.mts +2 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +360 -48
|
@@ -13,7 +13,7 @@ export declare class BillClient {
|
|
|
13
13
|
/**
|
|
14
14
|
* Creates a bill in an entrypoint.
|
|
15
15
|
*
|
|
16
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
16
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
17
17
|
* @param {Payabli.AddBillRequest} request
|
|
18
18
|
* @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
19
|
*
|
|
@@ -181,7 +181,7 @@ export declare class BillClient {
|
|
|
181
181
|
/**
|
|
182
182
|
* Retrieve a list of bills for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
183
183
|
*
|
|
184
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
184
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
185
185
|
* @param {Payabli.ListBillsRequest} request
|
|
186
186
|
* @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
187
187
|
*
|
|
@@ -23,7 +23,7 @@ export class BillClient {
|
|
|
23
23
|
/**
|
|
24
24
|
* Creates a bill in an entrypoint.
|
|
25
25
|
*
|
|
26
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
26
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
27
27
|
* @param {Payabli.AddBillRequest} request
|
|
28
28
|
* @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
29
29
|
*
|
|
@@ -454,7 +454,7 @@ export class BillClient {
|
|
|
454
454
|
/**
|
|
455
455
|
* Retrieve a list of bills for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
456
456
|
*
|
|
457
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
457
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
458
458
|
* @param {Payabli.ListBillsRequest} request
|
|
459
459
|
* @param {BillClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
460
460
|
*
|
|
@@ -13,7 +13,7 @@ export declare class CloudClient {
|
|
|
13
13
|
/**
|
|
14
14
|
* Register a cloud device to an entrypoint. See [Devices Quickstart](/developers/developer-guides/devices-quickstart#devices-quickstart) for a complete guide.
|
|
15
15
|
*
|
|
16
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
16
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
17
17
|
* @param {Payabli.DeviceEntry} request
|
|
18
18
|
* @param {CloudClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
19
|
*
|
|
@@ -33,7 +33,7 @@ export declare class CloudClient {
|
|
|
33
33
|
/**
|
|
34
34
|
* Retrieve the registration history for a device.
|
|
35
35
|
*
|
|
36
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
36
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
37
37
|
* @param {string} deviceId - ID of the cloud device.
|
|
38
38
|
* @param {CloudClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
39
39
|
*
|
|
@@ -50,7 +50,7 @@ export declare class CloudClient {
|
|
|
50
50
|
/**
|
|
51
51
|
* Get a list of cloud devices registered to an entrypoint.
|
|
52
52
|
*
|
|
53
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
53
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
54
54
|
* @param {Payabli.ListDeviceRequest} request
|
|
55
55
|
* @param {CloudClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
56
56
|
*
|
|
@@ -67,7 +67,7 @@ export declare class CloudClient {
|
|
|
67
67
|
/**
|
|
68
68
|
* Remove a cloud device from an entrypoint.
|
|
69
69
|
*
|
|
70
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
70
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
71
71
|
* @param {string} deviceId - ID of the cloud device.
|
|
72
72
|
* @param {CloudClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
73
73
|
*
|
|
@@ -33,7 +33,7 @@ export class CloudClient {
|
|
|
33
33
|
/**
|
|
34
34
|
* Register a cloud device to an entrypoint. See [Devices Quickstart](/developers/developer-guides/devices-quickstart#devices-quickstart) for a complete guide.
|
|
35
35
|
*
|
|
36
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
36
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
37
37
|
* @param {Payabli.DeviceEntry} request
|
|
38
38
|
* @param {CloudClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
39
39
|
*
|
|
@@ -98,7 +98,7 @@ export class CloudClient {
|
|
|
98
98
|
/**
|
|
99
99
|
* Retrieve the registration history for a device.
|
|
100
100
|
*
|
|
101
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
101
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
102
102
|
* @param {string} deviceId - ID of the cloud device.
|
|
103
103
|
* @param {CloudClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
104
104
|
*
|
|
@@ -156,7 +156,7 @@ export class CloudClient {
|
|
|
156
156
|
/**
|
|
157
157
|
* Get a list of cloud devices registered to an entrypoint.
|
|
158
158
|
*
|
|
159
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
159
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
160
160
|
* @param {Payabli.ListDeviceRequest} request
|
|
161
161
|
* @param {CloudClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
162
162
|
*
|
|
@@ -219,7 +219,7 @@ export class CloudClient {
|
|
|
219
219
|
/**
|
|
220
220
|
* Remove a cloud device from an entrypoint.
|
|
221
221
|
*
|
|
222
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
222
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
223
223
|
* @param {string} deviceId - ID of the cloud device.
|
|
224
224
|
* @param {CloudClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
225
225
|
*
|
|
@@ -36,7 +36,7 @@ export declare class ExportClient {
|
|
|
36
36
|
* This endpoint is deprecated. Export batch details for a paypoint. Use filters to limit results.
|
|
37
37
|
*
|
|
38
38
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
39
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
39
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
40
40
|
* @param {Payabli.ExportBatchDetailsRequest} request
|
|
41
41
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
42
42
|
*
|
|
@@ -80,7 +80,7 @@ export declare class ExportClient {
|
|
|
80
80
|
* Export a list of batches for an entrypoint. Use filters to limit results.
|
|
81
81
|
*
|
|
82
82
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
83
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
83
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
84
84
|
* @param {Payabli.ExportBatchesRequest} request
|
|
85
85
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
86
86
|
*
|
|
@@ -124,7 +124,7 @@ export declare class ExportClient {
|
|
|
124
124
|
* Export a list of money out batches for a paypoint. Use filters to limit results.
|
|
125
125
|
*
|
|
126
126
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
127
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
127
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
128
128
|
* @param {Payabli.ExportBatchesOutRequest} request
|
|
129
129
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
130
130
|
*
|
|
@@ -168,7 +168,7 @@ export declare class ExportClient {
|
|
|
168
168
|
* Export a list of bills for an entrypoint. Use filters to limit results.
|
|
169
169
|
*
|
|
170
170
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
171
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
171
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
172
172
|
* @param {Payabli.ExportBillsRequest} request
|
|
173
173
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
174
174
|
*
|
|
@@ -212,7 +212,7 @@ export declare class ExportClient {
|
|
|
212
212
|
* Export a list of chargebacks and ACH returns for an entrypoint. Use filters to limit results.
|
|
213
213
|
*
|
|
214
214
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
215
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
215
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
216
216
|
* @param {Payabli.ExportChargebacksRequest} request
|
|
217
217
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
218
218
|
*
|
|
@@ -256,7 +256,7 @@ export declare class ExportClient {
|
|
|
256
256
|
* Export a list of customers for an entrypoint. Use filters to limit results.
|
|
257
257
|
*
|
|
258
258
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
259
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
259
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
260
260
|
* @param {Payabli.ExportCustomersRequest} request
|
|
261
261
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
262
262
|
*
|
|
@@ -300,7 +300,7 @@ export declare class ExportClient {
|
|
|
300
300
|
* Export list of invoices for an entrypoint. Use filters to limit results.
|
|
301
301
|
*
|
|
302
302
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
303
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
303
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
304
304
|
* @param {Payabli.ExportInvoicesRequest} request
|
|
305
305
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
306
306
|
*
|
|
@@ -366,7 +366,7 @@ export declare class ExportClient {
|
|
|
366
366
|
* Export a list of payouts and their statuses for an entrypoint. Use filters to limit results.
|
|
367
367
|
*
|
|
368
368
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
369
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
369
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
370
370
|
* @param {Payabli.ExportPayoutRequest} request
|
|
371
371
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
372
372
|
*
|
|
@@ -432,7 +432,7 @@ export declare class ExportClient {
|
|
|
432
432
|
* Export a list of settled transactions for an entrypoint. Use filters to limit results.
|
|
433
433
|
*
|
|
434
434
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
435
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
435
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
436
436
|
* @param {Payabli.ExportSettlementsRequest} request
|
|
437
437
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
438
438
|
*
|
|
@@ -476,7 +476,7 @@ export declare class ExportClient {
|
|
|
476
476
|
* Export a list of subscriptions for an entrypoint. Use filters to limit results.
|
|
477
477
|
*
|
|
478
478
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
479
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
479
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
480
480
|
* @param {Payabli.ExportSubscriptionsRequest} request
|
|
481
481
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
482
482
|
*
|
|
@@ -520,7 +520,7 @@ export declare class ExportClient {
|
|
|
520
520
|
* Export a list of transactions for an entrypoint in a file in XLXS or CSV format. Use filters to limit results. If you don't specify a date range in the request, the last two months of data are returned.
|
|
521
521
|
*
|
|
522
522
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
523
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
523
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
524
524
|
* @param {Payabli.ExportTransactionsRequest} request
|
|
525
525
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
526
526
|
*
|
|
@@ -564,7 +564,7 @@ export declare class ExportClient {
|
|
|
564
564
|
* Export a list of transfer details for an entrypoint. Use filters to limit results.
|
|
565
565
|
*
|
|
566
566
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
567
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
567
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
568
568
|
* @param {number} transferId - Transfer identifier.
|
|
569
569
|
* @param {Payabli.ExportTransferDetailsRequest} request
|
|
570
570
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -587,7 +587,7 @@ export declare class ExportClient {
|
|
|
587
587
|
/**
|
|
588
588
|
* Get a list of transfers for an entrypoint. Use filters to limit results.
|
|
589
589
|
*
|
|
590
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
590
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
591
591
|
* @param {Payabli.ExportTransfersRequest} request
|
|
592
592
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
593
593
|
*
|
|
@@ -610,7 +610,7 @@ export declare class ExportClient {
|
|
|
610
610
|
* Export a list of vendors for an entrypoint. Use filters to limit results.
|
|
611
611
|
*
|
|
612
612
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
613
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
613
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
614
614
|
* @param {Payabli.ExportVendorsRequest} request
|
|
615
615
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
616
616
|
*
|
|
@@ -101,7 +101,7 @@ export class ExportClient {
|
|
|
101
101
|
* This endpoint is deprecated. Export batch details for a paypoint. Use filters to limit results.
|
|
102
102
|
*
|
|
103
103
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
104
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
104
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
105
105
|
* @param {Payabli.ExportBatchDetailsRequest} request
|
|
106
106
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
107
107
|
*
|
|
@@ -255,7 +255,7 @@ export class ExportClient {
|
|
|
255
255
|
* Export a list of batches for an entrypoint. Use filters to limit results.
|
|
256
256
|
*
|
|
257
257
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
258
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
258
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
259
259
|
* @param {Payabli.ExportBatchesRequest} request
|
|
260
260
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
261
261
|
*
|
|
@@ -409,7 +409,7 @@ export class ExportClient {
|
|
|
409
409
|
* Export a list of money out batches for a paypoint. Use filters to limit results.
|
|
410
410
|
*
|
|
411
411
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
412
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
412
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
413
413
|
* @param {Payabli.ExportBatchesOutRequest} request
|
|
414
414
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
415
415
|
*
|
|
@@ -563,7 +563,7 @@ export class ExportClient {
|
|
|
563
563
|
* Export a list of bills for an entrypoint. Use filters to limit results.
|
|
564
564
|
*
|
|
565
565
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
566
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
566
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
567
567
|
* @param {Payabli.ExportBillsRequest} request
|
|
568
568
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
569
569
|
*
|
|
@@ -717,7 +717,7 @@ export class ExportClient {
|
|
|
717
717
|
* Export a list of chargebacks and ACH returns for an entrypoint. Use filters to limit results.
|
|
718
718
|
*
|
|
719
719
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
720
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
720
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
721
721
|
* @param {Payabli.ExportChargebacksRequest} request
|
|
722
722
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
723
723
|
*
|
|
@@ -871,7 +871,7 @@ export class ExportClient {
|
|
|
871
871
|
* Export a list of customers for an entrypoint. Use filters to limit results.
|
|
872
872
|
*
|
|
873
873
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
874
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
874
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
875
875
|
* @param {Payabli.ExportCustomersRequest} request
|
|
876
876
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
877
877
|
*
|
|
@@ -1025,7 +1025,7 @@ export class ExportClient {
|
|
|
1025
1025
|
* Export list of invoices for an entrypoint. Use filters to limit results.
|
|
1026
1026
|
*
|
|
1027
1027
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
1028
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
1028
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
1029
1029
|
* @param {Payabli.ExportInvoicesRequest} request
|
|
1030
1030
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1031
1031
|
*
|
|
@@ -1256,7 +1256,7 @@ export class ExportClient {
|
|
|
1256
1256
|
* Export a list of payouts and their statuses for an entrypoint. Use filters to limit results.
|
|
1257
1257
|
*
|
|
1258
1258
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
1259
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
1259
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
1260
1260
|
* @param {Payabli.ExportPayoutRequest} request
|
|
1261
1261
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1262
1262
|
*
|
|
@@ -1487,7 +1487,7 @@ export class ExportClient {
|
|
|
1487
1487
|
* Export a list of settled transactions for an entrypoint. Use filters to limit results.
|
|
1488
1488
|
*
|
|
1489
1489
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
1490
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
1490
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
1491
1491
|
* @param {Payabli.ExportSettlementsRequest} request
|
|
1492
1492
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1493
1493
|
*
|
|
@@ -1641,7 +1641,7 @@ export class ExportClient {
|
|
|
1641
1641
|
* Export a list of subscriptions for an entrypoint. Use filters to limit results.
|
|
1642
1642
|
*
|
|
1643
1643
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
1644
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
1644
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
1645
1645
|
* @param {Payabli.ExportSubscriptionsRequest} request
|
|
1646
1646
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1647
1647
|
*
|
|
@@ -1795,7 +1795,7 @@ export class ExportClient {
|
|
|
1795
1795
|
* Export a list of transactions for an entrypoint in a file in XLXS or CSV format. Use filters to limit results. If you don't specify a date range in the request, the last two months of data are returned.
|
|
1796
1796
|
*
|
|
1797
1797
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
1798
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
1798
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
1799
1799
|
* @param {Payabli.ExportTransactionsRequest} request
|
|
1800
1800
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1801
1801
|
*
|
|
@@ -1949,7 +1949,7 @@ export class ExportClient {
|
|
|
1949
1949
|
* Export a list of transfer details for an entrypoint. Use filters to limit results.
|
|
1950
1950
|
*
|
|
1951
1951
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
1952
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
1952
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
1953
1953
|
* @param {number} transferId - Transfer identifier.
|
|
1954
1954
|
* @param {Payabli.ExportTransferDetailsRequest} request
|
|
1955
1955
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -2030,7 +2030,7 @@ export class ExportClient {
|
|
|
2030
2030
|
/**
|
|
2031
2031
|
* Get a list of transfers for an entrypoint. Use filters to limit results.
|
|
2032
2032
|
*
|
|
2033
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2033
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
2034
2034
|
* @param {Payabli.ExportTransfersRequest} request
|
|
2035
2035
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
2036
2036
|
*
|
|
@@ -2111,7 +2111,7 @@ export class ExportClient {
|
|
|
2111
2111
|
* Export a list of vendors for an entrypoint. Use filters to limit results.
|
|
2112
2112
|
*
|
|
2113
2113
|
* @param {Payabli.ExportFormat1} format - Format for the export, either XLSX or CSV.
|
|
2114
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2114
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
2115
2115
|
* @param {Payabli.ExportVendorsRequest} request
|
|
2116
2116
|
* @param {ExportClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
2117
2117
|
*
|
|
@@ -13,7 +13,7 @@ export declare class HostedPaymentPagesClient {
|
|
|
13
13
|
/**
|
|
14
14
|
* Loads all of a payment page's details including `pageIdentifier` and `validationCode`. This endpoint requires an `application` API token.
|
|
15
15
|
*
|
|
16
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
16
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
17
17
|
* @param {string} subdomain - Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
18
18
|
* @param {HostedPaymentPagesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
19
|
*
|
|
@@ -32,7 +32,7 @@ export declare class HostedPaymentPagesClient {
|
|
|
32
32
|
* Creates a new payment page for a paypoint.
|
|
33
33
|
* Note: this operation doesn't create a new paypoint, just a payment page for an existing paypoint. Paypoints are created by the Payabli team when a boarding application is approved.
|
|
34
34
|
*
|
|
35
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
35
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
36
36
|
* @param {Payabli.NewPageRequest} request
|
|
37
37
|
* @param {HostedPaymentPagesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
38
38
|
*
|
|
@@ -52,7 +52,7 @@ export declare class HostedPaymentPagesClient {
|
|
|
52
52
|
/**
|
|
53
53
|
* Updates a payment page in a paypoint.
|
|
54
54
|
*
|
|
55
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
55
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
56
56
|
* @param {string} subdomain - Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
57
57
|
* @param {Payabli.PayabliPages} request
|
|
58
58
|
* @param {HostedPaymentPagesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -22,7 +22,7 @@ export class HostedPaymentPagesClient {
|
|
|
22
22
|
/**
|
|
23
23
|
* Loads all of a payment page's details including `pageIdentifier` and `validationCode`. This endpoint requires an `application` API token.
|
|
24
24
|
*
|
|
25
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
25
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
26
26
|
* @param {string} subdomain - Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
27
27
|
* @param {HostedPaymentPagesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
28
28
|
*
|
|
@@ -82,7 +82,7 @@ export class HostedPaymentPagesClient {
|
|
|
82
82
|
* Creates a new payment page for a paypoint.
|
|
83
83
|
* Note: this operation doesn't create a new paypoint, just a payment page for an existing paypoint. Paypoints are created by the Payabli team when a boarding application is approved.
|
|
84
84
|
*
|
|
85
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
85
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
86
86
|
* @param {Payabli.NewPageRequest} request
|
|
87
87
|
* @param {HostedPaymentPagesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
88
88
|
*
|
|
@@ -150,7 +150,7 @@ export class HostedPaymentPagesClient {
|
|
|
150
150
|
/**
|
|
151
151
|
* Updates a payment page in a paypoint.
|
|
152
152
|
*
|
|
153
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
153
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
154
154
|
* @param {string} subdomain - Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
155
155
|
* @param {Payabli.PayabliPages} request
|
|
156
156
|
* @param {HostedPaymentPagesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -13,7 +13,7 @@ export declare class InvoiceClient {
|
|
|
13
13
|
/**
|
|
14
14
|
* Creates an invoice in an entrypoint.
|
|
15
15
|
*
|
|
16
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
16
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
17
17
|
* @param {Payabli.AddInvoiceRequest} request
|
|
18
18
|
* @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
19
|
*
|
|
@@ -181,7 +181,7 @@ export declare class InvoiceClient {
|
|
|
181
181
|
/**
|
|
182
182
|
* Retrieves the next available invoice number for a paypoint.
|
|
183
183
|
*
|
|
184
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
184
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
185
185
|
* @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
186
186
|
*
|
|
187
187
|
* @throws {@link Payabli.BadRequestError}
|
|
@@ -197,7 +197,7 @@ export declare class InvoiceClient {
|
|
|
197
197
|
/**
|
|
198
198
|
* Returns a list of invoices for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
199
199
|
*
|
|
200
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
200
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
201
201
|
* @param {Payabli.ListInvoicesRequest} request
|
|
202
202
|
* @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
203
203
|
*
|
|
@@ -23,7 +23,7 @@ export class InvoiceClient {
|
|
|
23
23
|
/**
|
|
24
24
|
* Creates an invoice in an entrypoint.
|
|
25
25
|
*
|
|
26
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
26
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
27
27
|
* @param {Payabli.AddInvoiceRequest} request
|
|
28
28
|
* @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
29
29
|
*
|
|
@@ -458,7 +458,7 @@ export class InvoiceClient {
|
|
|
458
458
|
/**
|
|
459
459
|
* Retrieves the next available invoice number for a paypoint.
|
|
460
460
|
*
|
|
461
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
461
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
462
462
|
* @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
463
463
|
*
|
|
464
464
|
* @throws {@link Payabli.BadRequestError}
|
|
@@ -515,7 +515,7 @@ export class InvoiceClient {
|
|
|
515
515
|
/**
|
|
516
516
|
* Returns a list of invoices for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
517
517
|
*
|
|
518
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
518
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
519
519
|
* @param {Payabli.ListInvoicesRequest} request
|
|
520
520
|
* @param {InvoiceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
521
521
|
*
|
|
@@ -13,7 +13,7 @@ export declare class LineItemClient {
|
|
|
13
13
|
/**
|
|
14
14
|
* Adds products and services to an entrypoint's catalog. These are used as line items for invoicing and transactions. In the response, "responseData" displays the item's code.
|
|
15
15
|
*
|
|
16
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
16
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
17
17
|
* @param {Payabli.AddItemRequest} request
|
|
18
18
|
* @param {LineItemClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
19
|
*
|
|
@@ -73,7 +73,7 @@ export declare class LineItemClient {
|
|
|
73
73
|
/**
|
|
74
74
|
* Retrieves a list of line items and their details from an entrypoint. Line items are also known as items, products, and services. Use filters to limit results.
|
|
75
75
|
*
|
|
76
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
76
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
77
77
|
* @param {Payabli.ListLineItemsRequest} request
|
|
78
78
|
* @param {LineItemClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
79
79
|
*
|
|
@@ -23,7 +23,7 @@ export class LineItemClient {
|
|
|
23
23
|
/**
|
|
24
24
|
* Adds products and services to an entrypoint's catalog. These are used as line items for invoicing and transactions. In the response, "responseData" displays the item's code.
|
|
25
25
|
*
|
|
26
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
26
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
27
27
|
* @param {Payabli.AddItemRequest} request
|
|
28
28
|
* @param {LineItemClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
29
29
|
*
|
|
@@ -210,7 +210,7 @@ export class LineItemClient {
|
|
|
210
210
|
/**
|
|
211
211
|
* Retrieves a list of line items and their details from an entrypoint. Line items are also known as items, products, and services. Use filters to limit results.
|
|
212
212
|
*
|
|
213
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
213
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
214
214
|
* @param {Payabli.ListLineItemsRequest} request
|
|
215
215
|
* @param {LineItemClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
216
216
|
*
|
|
@@ -11,7 +11,7 @@ export declare class MoneyInClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<MoneyInClient.Options>;
|
|
12
12
|
constructor(options?: MoneyInClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until [captured](/api-reference/moneyin/capture-an-authorized-transaction).
|
|
14
|
+
* Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until [captured](/developers/api-reference/moneyin/capture-an-authorized-transaction).
|
|
15
15
|
* Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
|
|
16
16
|
* <Tip>
|
|
17
17
|
* Consider migrating to the [v2 Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction) to take advantage of unified response codes and improved response consistency.
|
|
@@ -53,11 +53,11 @@ export declare class MoneyInClient {
|
|
|
53
53
|
private __authorize;
|
|
54
54
|
/**
|
|
55
55
|
* <Warning>
|
|
56
|
-
* This endpoint is deprecated and will be sunset on November 24, 2025. Migrate to [POST `/capture/{transId}`](/api-reference/moneyin/capture-an-authorized-transaction)`.
|
|
56
|
+
* This endpoint is deprecated and will be sunset on November 24, 2025. Migrate to [POST `/capture/{transId}`](/developers/api-reference/moneyin/capture-an-authorized-transaction)`.
|
|
57
57
|
* </Warning>
|
|
58
58
|
*
|
|
59
59
|
* Capture an [authorized
|
|
60
|
-
* transaction](/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
60
|
+
* transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
61
61
|
*
|
|
62
62
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
63
63
|
* @param {number} amount - 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.
|
|
@@ -74,7 +74,7 @@ export declare class MoneyInClient {
|
|
|
74
74
|
capture(transId: string, amount: number, requestOptions?: MoneyInClient.RequestOptions): core.HttpResponsePromise<Payabli.CaptureResponse>;
|
|
75
75
|
private __capture;
|
|
76
76
|
/**
|
|
77
|
-
* Capture an [authorized transaction](/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
77
|
+
* Capture an [authorized transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
78
78
|
*
|
|
79
79
|
* You can use this endpoint to capture both full and partial amounts of the original authorized transaction. See [Capture an authorized transaction](/developers/developer-guides/pay-in-auth-and-capture) for more information about this endpoint.
|
|
80
80
|
*
|
|
@@ -554,7 +554,7 @@ export declare class MoneyInClient {
|
|
|
554
554
|
void(transId: string, requestOptions?: MoneyInClient.RequestOptions): core.HttpResponsePromise<Payabli.VoidResponse>;
|
|
555
555
|
private __void;
|
|
556
556
|
/**
|
|
557
|
-
* Make a single transaction. This method authorizes and captures a payment in one step. This is the v2 version of the `api/MoneyIn/getpaid` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/
|
|
557
|
+
* Make a single transaction. This method authorizes and captures a payment in one step. This is the v2 version of the `api/MoneyIn/getpaid` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
558
558
|
*
|
|
559
559
|
* @param {Payabli.RequestPaymentV2} request
|
|
560
560
|
* @param {MoneyInClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -656,7 +656,7 @@ export declare class MoneyInClient {
|
|
|
656
656
|
getpaidv2(request: Payabli.RequestPaymentV2, requestOptions?: MoneyInClient.RequestOptions): core.HttpResponsePromise<Payabli.V2TransactionResponseWrapper>;
|
|
657
657
|
private __getpaidv2;
|
|
658
658
|
/**
|
|
659
|
-
* Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until captured. This is the v2 version of the `api/MoneyIn/authorize` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/
|
|
659
|
+
* Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until captured. This is the v2 version of the `api/MoneyIn/authorize` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
660
660
|
*
|
|
661
661
|
* **Note**: Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
|
|
662
662
|
*
|
|
@@ -695,7 +695,7 @@ export declare class MoneyInClient {
|
|
|
695
695
|
authorizev2(request: Payabli.RequestPaymentAuthorizeV2, requestOptions?: MoneyInClient.RequestOptions): core.HttpResponsePromise<Payabli.V2TransactionResponseWrapper>;
|
|
696
696
|
private __authorizev2;
|
|
697
697
|
/**
|
|
698
|
-
* Capture an authorized transaction to complete the transaction and move funds from the customer to merchant account. This is the v2 version of the `api/MoneyIn/capture/{transId}` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/
|
|
698
|
+
* Capture an authorized transaction to complete the transaction and move funds from the customer to merchant account. This is the v2 version of the `api/MoneyIn/capture/{transId}` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
699
699
|
*
|
|
700
700
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
701
701
|
* @param {Payabli.CaptureRequest} request
|
|
@@ -727,7 +727,7 @@ export declare class MoneyInClient {
|
|
|
727
727
|
/**
|
|
728
728
|
* Give a full refund for a transaction that has settled and send money back to the account holder. To perform a partial refund, see [Partially refund a transaction](developers/api-reference/moneyinV2/partial-refund-a-settled-transaction).
|
|
729
729
|
*
|
|
730
|
-
* This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/
|
|
730
|
+
* This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
731
731
|
*
|
|
732
732
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
733
733
|
* @param {MoneyInClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -745,7 +745,7 @@ export declare class MoneyInClient {
|
|
|
745
745
|
/**
|
|
746
746
|
* Refund a transaction that has settled and send money back to the account holder. If `amount` is omitted or set to 0, performs a full refund. When a non-zero `amount` is provided, this endpoint performs a partial refund.
|
|
747
747
|
*
|
|
748
|
-
* This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/
|
|
748
|
+
* This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
749
749
|
*
|
|
750
750
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
751
751
|
* @param {number} amount - Amount to refund from original transaction, minus any service fees charged on the original transaction. If omitted or set to 0, performs a full refund.
|
|
@@ -765,7 +765,7 @@ export declare class MoneyInClient {
|
|
|
765
765
|
refundv2Amount(transId: string, amount: number, requestOptions?: MoneyInClient.RequestOptions): core.HttpResponsePromise<Payabli.V2TransactionResponseWrapper>;
|
|
766
766
|
private __refundv2Amount;
|
|
767
767
|
/**
|
|
768
|
-
* Cancel a transaction that hasn't been settled yet. Voiding non-captured authorizations prevents future captures. This is the v2 version of the `api/MoneyIn/void/{transId}` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/
|
|
768
|
+
* Cancel a transaction that hasn't been settled yet. Voiding non-captured authorizations prevents future captures. This is the v2 version of the `api/MoneyIn/void/{transId}` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
769
769
|
*
|
|
770
770
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
771
771
|
* @param {MoneyInClient.RequestOptions} requestOptions - Request-specific configuration.
|