@payabli/sdk-node 0.0.128 → 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/LICENSE.md +8 -0
- 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/MaxTicket.d.ts +1 -1
- package/dist/cjs/api/types/MinTicket.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/TransactionQueryRecordsCustomer.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/MaxTicket.d.mts +1 -1
- package/dist/esm/api/types/MinTicket.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/TransactionQueryRecordsCustomer.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
|
@@ -67,7 +67,7 @@ class MoneyInClient {
|
|
|
67
67
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
|
-
* 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).
|
|
70
|
+
* 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).
|
|
71
71
|
* Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
|
|
72
72
|
* <Tip>
|
|
73
73
|
* 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.
|
|
@@ -158,11 +158,11 @@ class MoneyInClient {
|
|
|
158
158
|
}
|
|
159
159
|
/**
|
|
160
160
|
* <Warning>
|
|
161
|
-
* This endpoint is deprecated and will be sunset on November 24, 2025. Migrate to [POST `/capture/{transId}`](/api-reference/moneyin/capture-an-authorized-transaction)`.
|
|
161
|
+
* 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)`.
|
|
162
162
|
* </Warning>
|
|
163
163
|
*
|
|
164
164
|
* Capture an [authorized
|
|
165
|
-
* transaction](/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
165
|
+
* transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
166
166
|
*
|
|
167
167
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
168
168
|
* @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.
|
|
@@ -220,7 +220,7 @@ class MoneyInClient {
|
|
|
220
220
|
});
|
|
221
221
|
}
|
|
222
222
|
/**
|
|
223
|
-
* Capture an [authorized transaction](/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
223
|
+
* Capture an [authorized transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
224
224
|
*
|
|
225
225
|
* 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.
|
|
226
226
|
*
|
|
@@ -1198,7 +1198,7 @@ class MoneyInClient {
|
|
|
1198
1198
|
});
|
|
1199
1199
|
}
|
|
1200
1200
|
/**
|
|
1201
|
-
* 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](/
|
|
1201
|
+
* 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.
|
|
1202
1202
|
*
|
|
1203
1203
|
* @param {Payabli.RequestPaymentV2} request
|
|
1204
1204
|
* @param {MoneyInClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -1355,7 +1355,7 @@ class MoneyInClient {
|
|
|
1355
1355
|
});
|
|
1356
1356
|
}
|
|
1357
1357
|
/**
|
|
1358
|
-
* 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](/
|
|
1358
|
+
* 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.
|
|
1359
1359
|
*
|
|
1360
1360
|
* **Note**: Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
|
|
1361
1361
|
*
|
|
@@ -1443,7 +1443,7 @@ class MoneyInClient {
|
|
|
1443
1443
|
});
|
|
1444
1444
|
}
|
|
1445
1445
|
/**
|
|
1446
|
-
* 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](/
|
|
1446
|
+
* 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.
|
|
1447
1447
|
*
|
|
1448
1448
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
1449
1449
|
* @param {Payabli.CaptureRequest} request
|
|
@@ -1519,7 +1519,7 @@ class MoneyInClient {
|
|
|
1519
1519
|
/**
|
|
1520
1520
|
* 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).
|
|
1521
1521
|
*
|
|
1522
|
-
* This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/
|
|
1522
|
+
* 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.
|
|
1523
1523
|
*
|
|
1524
1524
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
1525
1525
|
* @param {MoneyInClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -1578,7 +1578,7 @@ class MoneyInClient {
|
|
|
1578
1578
|
/**
|
|
1579
1579
|
* 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.
|
|
1580
1580
|
*
|
|
1581
|
-
* This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/
|
|
1581
|
+
* 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.
|
|
1582
1582
|
*
|
|
1583
1583
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
1584
1584
|
* @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.
|
|
@@ -1639,7 +1639,7 @@ class MoneyInClient {
|
|
|
1639
1639
|
});
|
|
1640
1640
|
}
|
|
1641
1641
|
/**
|
|
1642
|
-
* 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](/
|
|
1642
|
+
* 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.
|
|
1643
1643
|
*
|
|
1644
1644
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
1645
1645
|
* @param {MoneyInClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -3,9 +3,9 @@ import type * as Payabli from "../../../index.js";
|
|
|
3
3
|
* Response data from payment processor
|
|
4
4
|
*/
|
|
5
5
|
export interface TransactionDetailResponseData {
|
|
6
|
-
/** Unified result code for the transaction. See [Pay In unified response codes](/
|
|
6
|
+
/** Unified result code for the transaction. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information. */
|
|
7
7
|
resultCode?: string;
|
|
8
|
-
/** Description of the result code. See [Pay In unified response codes](/
|
|
8
|
+
/** Description of the result code. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information. */
|
|
9
9
|
resultCodeText?: string;
|
|
10
10
|
response: string | null;
|
|
11
11
|
responsetext: Payabli.Resulttext;
|
|
@@ -303,4 +303,35 @@ export declare class MoneyOutClient {
|
|
|
303
303
|
*/
|
|
304
304
|
getCheckImage(assetName: string, requestOptions?: MoneyOutClient.RequestOptions): core.HttpResponsePromise<string>;
|
|
305
305
|
private __getCheckImage;
|
|
306
|
+
/**
|
|
307
|
+
* Updates the status of a processed check payment transaction. This endpoint handles the status transition, updates related bills, creates audit events, and triggers notifications.
|
|
308
|
+
*
|
|
309
|
+
* The transaction must meet all of the following criteria:
|
|
310
|
+
* - **Status**: Must be in Processing or Processed status.
|
|
311
|
+
* - **Payment method**: Must be a check payment method.
|
|
312
|
+
*
|
|
313
|
+
* ### Allowed status values
|
|
314
|
+
*
|
|
315
|
+
* | Value | Status | Description |
|
|
316
|
+
* |-------|--------|-------------|
|
|
317
|
+
* | `0` | Cancelled/Voided | Cancels the check transaction. Reverts associated bills to their previous state (Approved or Active), creates "Cancelled" events, and sends a `payout_transaction_voidedcancelled` notification if the notification is enabled. |
|
|
318
|
+
* | `5` | Paid | Marks the check transaction as paid. Updates associated bills to "Paid" status, creates "Paid" events, and sends a `payout_transaction_paid` notification if the notification is enabled. |
|
|
319
|
+
*
|
|
320
|
+
* @param {string} transId - The Payabli transaction ID for the check payment.
|
|
321
|
+
* @param {Payabli.AllowedCheckPaymentStatus} checkPaymentStatus - The new status to apply to the check transaction. To mark a check as `Paid`, send 5. To mark a check as `Cancelled`, send 0.
|
|
322
|
+
* @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
323
|
+
*
|
|
324
|
+
* @throws {@link Payabli.BadRequestError}
|
|
325
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
326
|
+
* @throws {@link Payabli.InternalServerError}
|
|
327
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
328
|
+
*
|
|
329
|
+
* @example
|
|
330
|
+
* await client.moneyOut.updateCheckPaymentStatus("TRANS123456", "5")
|
|
331
|
+
*
|
|
332
|
+
* @example
|
|
333
|
+
* await client.moneyOut.updateCheckPaymentStatus("TRANS123456", "0")
|
|
334
|
+
*/
|
|
335
|
+
updateCheckPaymentStatus(transId: string, checkPaymentStatus: Payabli.AllowedCheckPaymentStatus, requestOptions?: MoneyOutClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
|
|
336
|
+
private __updateCheckPaymentStatus;
|
|
306
337
|
}
|
|
@@ -783,5 +783,80 @@ class MoneyOutClient {
|
|
|
783
783
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/MoneyOut/checkimage/{assetName}");
|
|
784
784
|
});
|
|
785
785
|
}
|
|
786
|
+
/**
|
|
787
|
+
* Updates the status of a processed check payment transaction. This endpoint handles the status transition, updates related bills, creates audit events, and triggers notifications.
|
|
788
|
+
*
|
|
789
|
+
* The transaction must meet all of the following criteria:
|
|
790
|
+
* - **Status**: Must be in Processing or Processed status.
|
|
791
|
+
* - **Payment method**: Must be a check payment method.
|
|
792
|
+
*
|
|
793
|
+
* ### Allowed status values
|
|
794
|
+
*
|
|
795
|
+
* | Value | Status | Description |
|
|
796
|
+
* |-------|--------|-------------|
|
|
797
|
+
* | `0` | Cancelled/Voided | Cancels the check transaction. Reverts associated bills to their previous state (Approved or Active), creates "Cancelled" events, and sends a `payout_transaction_voidedcancelled` notification if the notification is enabled. |
|
|
798
|
+
* | `5` | Paid | Marks the check transaction as paid. Updates associated bills to "Paid" status, creates "Paid" events, and sends a `payout_transaction_paid` notification if the notification is enabled. |
|
|
799
|
+
*
|
|
800
|
+
* @param {string} transId - The Payabli transaction ID for the check payment.
|
|
801
|
+
* @param {Payabli.AllowedCheckPaymentStatus} checkPaymentStatus - The new status to apply to the check transaction. To mark a check as `Paid`, send 5. To mark a check as `Cancelled`, send 0.
|
|
802
|
+
* @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
803
|
+
*
|
|
804
|
+
* @throws {@link Payabli.BadRequestError}
|
|
805
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
806
|
+
* @throws {@link Payabli.InternalServerError}
|
|
807
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
808
|
+
*
|
|
809
|
+
* @example
|
|
810
|
+
* await client.moneyOut.updateCheckPaymentStatus("TRANS123456", "5")
|
|
811
|
+
*
|
|
812
|
+
* @example
|
|
813
|
+
* await client.moneyOut.updateCheckPaymentStatus("TRANS123456", "0")
|
|
814
|
+
*/
|
|
815
|
+
updateCheckPaymentStatus(transId, checkPaymentStatus, requestOptions) {
|
|
816
|
+
return core.HttpResponsePromise.fromPromise(this.__updateCheckPaymentStatus(transId, checkPaymentStatus, requestOptions));
|
|
817
|
+
}
|
|
818
|
+
__updateCheckPaymentStatus(transId, checkPaymentStatus, requestOptions) {
|
|
819
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
820
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
821
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
822
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
823
|
+
const _response = yield core.fetcher({
|
|
824
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `MoneyOut/status/${core.url.encodePathParam(transId)}/${core.url.encodePathParam(checkPaymentStatus)}`),
|
|
825
|
+
method: "PATCH",
|
|
826
|
+
headers: _headers,
|
|
827
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
828
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
829
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
830
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
831
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
832
|
+
logging: this._options.logging,
|
|
833
|
+
});
|
|
834
|
+
if (_response.ok) {
|
|
835
|
+
return {
|
|
836
|
+
data: _response.body,
|
|
837
|
+
rawResponse: _response.rawResponse,
|
|
838
|
+
};
|
|
839
|
+
}
|
|
840
|
+
if (_response.error.reason === "status-code") {
|
|
841
|
+
switch (_response.error.statusCode) {
|
|
842
|
+
case 400:
|
|
843
|
+
throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
|
|
844
|
+
case 401:
|
|
845
|
+
throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
846
|
+
case 500:
|
|
847
|
+
throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
|
|
848
|
+
case 503:
|
|
849
|
+
throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
850
|
+
default:
|
|
851
|
+
throw new errors.PayabliError({
|
|
852
|
+
statusCode: _response.error.statusCode,
|
|
853
|
+
body: _response.error.body,
|
|
854
|
+
rawResponse: _response.rawResponse,
|
|
855
|
+
});
|
|
856
|
+
}
|
|
857
|
+
}
|
|
858
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/MoneyOut/status/{transId}/{checkPaymentStatus}");
|
|
859
|
+
});
|
|
860
|
+
}
|
|
786
861
|
}
|
|
787
862
|
exports.MoneyOutClient = MoneyOutClient;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The new status to apply to a check payment transaction.
|
|
3
|
+
* - `0`: Cancelled/Voided — Cancels the check transaction.
|
|
4
|
+
* - `5`: Paid — Marks the check transaction as paid.
|
|
5
|
+
*/
|
|
6
|
+
export declare const AllowedCheckPaymentStatus: {
|
|
7
|
+
readonly Cancelled: "0";
|
|
8
|
+
readonly Paid: "5";
|
|
9
|
+
};
|
|
10
|
+
export type AllowedCheckPaymentStatus = (typeof AllowedCheckPaymentStatus)[keyof typeof AllowedCheckPaymentStatus];
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.AllowedCheckPaymentStatus = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* The new status to apply to a check payment transaction.
|
|
7
|
+
* - `0`: Cancelled/Voided — Cancels the check transaction.
|
|
8
|
+
* - `5`: Paid — Marks the check transaction as paid.
|
|
9
|
+
*/
|
|
10
|
+
exports.AllowedCheckPaymentStatus = {
|
|
11
|
+
Cancelled: "0",
|
|
12
|
+
Paid: "5",
|
|
13
|
+
};
|
|
@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./AllowedCheckPaymentStatus.js"), exports);
|
|
17
18
|
__exportStar(require("./AuthCapturePayoutResponse.js"), exports);
|
|
18
19
|
__exportStar(require("./AuthorizePaymentMethod.js"), exports);
|
|
19
20
|
__exportStar(require("./AuthorizePayoutBody.js"), exports);
|
|
@@ -118,7 +118,7 @@ export declare class OrganizationClient {
|
|
|
118
118
|
/**
|
|
119
119
|
* Gets an organization's basic information by entry name (entrypoint identifier).
|
|
120
120
|
*
|
|
121
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
121
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
122
122
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
123
123
|
*
|
|
124
124
|
* @throws {@link Payabli.BadRequestError}
|
|
@@ -304,7 +304,7 @@ class OrganizationClient {
|
|
|
304
304
|
/**
|
|
305
305
|
* Gets an organization's basic information by entry name (entrypoint identifier).
|
|
306
306
|
*
|
|
307
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
307
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
308
308
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
309
309
|
*
|
|
310
310
|
* @throws {@link Payabli.BadRequestError}
|
|
@@ -13,7 +13,7 @@ export declare class PaypointClient {
|
|
|
13
13
|
/**
|
|
14
14
|
* Gets the basic details for a paypoint.
|
|
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 {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
18
18
|
*
|
|
19
19
|
* @throws {@link Payabli.BadRequestError}
|
|
@@ -45,7 +45,7 @@ export declare class PaypointClient {
|
|
|
45
45
|
/**
|
|
46
46
|
* Gets the details for a single paypoint.
|
|
47
47
|
*
|
|
48
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
48
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
49
49
|
* @param {Payabli.GetEntryConfigRequest} request
|
|
50
50
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
51
51
|
*
|
|
@@ -62,7 +62,7 @@ export declare class PaypointClient {
|
|
|
62
62
|
/**
|
|
63
63
|
* Gets the details for single payment page for a paypoint.
|
|
64
64
|
*
|
|
65
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
65
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
66
66
|
* @param {string} subdomain - Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
67
67
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
68
68
|
*
|
|
@@ -79,7 +79,7 @@ export declare class PaypointClient {
|
|
|
79
79
|
/**
|
|
80
80
|
* Deletes a payment page in a paypoint.
|
|
81
81
|
*
|
|
82
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
82
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
83
83
|
* @param {string} subdomain - Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
84
84
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
85
85
|
*
|
|
@@ -96,7 +96,7 @@ export declare class PaypointClient {
|
|
|
96
96
|
/**
|
|
97
97
|
* Updates a paypoint logo.
|
|
98
98
|
*
|
|
99
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
99
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
100
100
|
* @param {Payabli.FileContent} request
|
|
101
101
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
102
102
|
*
|
|
@@ -113,7 +113,7 @@ export declare class PaypointClient {
|
|
|
113
113
|
/**
|
|
114
114
|
* Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.
|
|
115
115
|
*
|
|
116
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
116
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
117
117
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
118
118
|
*
|
|
119
119
|
* @throws {@link Payabli.BadRequestError}
|
|
@@ -58,7 +58,7 @@ class PaypointClient {
|
|
|
58
58
|
/**
|
|
59
59
|
* Gets the basic details for a paypoint.
|
|
60
60
|
*
|
|
61
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
61
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
62
62
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link Payabli.BadRequestError}
|
|
@@ -172,7 +172,7 @@ class PaypointClient {
|
|
|
172
172
|
/**
|
|
173
173
|
* Gets the details for a single paypoint.
|
|
174
174
|
*
|
|
175
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
175
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
176
176
|
* @param {Payabli.GetEntryConfigRequest} request
|
|
177
177
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
178
178
|
*
|
|
@@ -235,7 +235,7 @@ class PaypointClient {
|
|
|
235
235
|
/**
|
|
236
236
|
* Gets the details for single payment page for a paypoint.
|
|
237
237
|
*
|
|
238
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
238
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
239
239
|
* @param {string} subdomain - Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
240
240
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
241
241
|
*
|
|
@@ -293,7 +293,7 @@ class PaypointClient {
|
|
|
293
293
|
/**
|
|
294
294
|
* Deletes a payment page in a paypoint.
|
|
295
295
|
*
|
|
296
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
296
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
297
297
|
* @param {string} subdomain - Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
298
298
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
299
299
|
*
|
|
@@ -354,7 +354,7 @@ class PaypointClient {
|
|
|
354
354
|
/**
|
|
355
355
|
* Updates a paypoint logo.
|
|
356
356
|
*
|
|
357
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
357
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
358
358
|
* @param {Payabli.FileContent} request
|
|
359
359
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
360
360
|
*
|
|
@@ -418,7 +418,7 @@ class PaypointClient {
|
|
|
418
418
|
/**
|
|
419
419
|
* Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.
|
|
420
420
|
*
|
|
421
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
421
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
422
422
|
* @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
423
423
|
*
|
|
424
424
|
* @throws {@link Payabli.BadRequestError}
|
|
@@ -594,6 +594,67 @@ export declare class QueryClient {
|
|
|
594
594
|
*/
|
|
595
595
|
listTransfersOrg(request: Payabli.ListTransfersRequestOrg, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.TransferQueryResponse>;
|
|
596
596
|
private __listTransfersOrg;
|
|
597
|
+
/**
|
|
598
|
+
* Retrieve a list of outbound transfers for an organization. Use filters to limit results.
|
|
599
|
+
*
|
|
600
|
+
* @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
|
|
601
|
+
* @param {Payabli.ListTransfersOutOrgRequest} request
|
|
602
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
603
|
+
*
|
|
604
|
+
* @throws {@link Payabli.BadRequestError}
|
|
605
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
606
|
+
* @throws {@link Payabli.InternalServerError}
|
|
607
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
608
|
+
*
|
|
609
|
+
* @example
|
|
610
|
+
* await client.query.listTransfersOutOrg(77, {
|
|
611
|
+
* fromRecord: 0,
|
|
612
|
+
* limitRecord: 20
|
|
613
|
+
* })
|
|
614
|
+
*/
|
|
615
|
+
listTransfersOutOrg(orgId: number, request?: Payabli.ListTransfersOutOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.TransferOutQueryResponse>;
|
|
616
|
+
private __listTransfersOutOrg;
|
|
617
|
+
/**
|
|
618
|
+
* Retrieve a list of outbound transfers for a paypoint. Use filters to limit results.
|
|
619
|
+
*
|
|
620
|
+
* @param {Payabli.Entry} entry
|
|
621
|
+
* @param {Payabli.ListTransfersOutPaypointRequest} request
|
|
622
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
623
|
+
*
|
|
624
|
+
* @throws {@link Payabli.BadRequestError}
|
|
625
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
626
|
+
* @throws {@link Payabli.InternalServerError}
|
|
627
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
628
|
+
*
|
|
629
|
+
* @example
|
|
630
|
+
* await client.query.listTransfersOutPaypoint("47cade237", {
|
|
631
|
+
* fromRecord: 0,
|
|
632
|
+
* limitRecord: 20
|
|
633
|
+
* })
|
|
634
|
+
*/
|
|
635
|
+
listTransfersOutPaypoint(entry: Payabli.Entry, request?: Payabli.ListTransfersOutPaypointRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.TransferOutQueryResponse>;
|
|
636
|
+
private __listTransfersOutPaypoint;
|
|
637
|
+
/**
|
|
638
|
+
* Retrieve details for a specific outbound transfer. Use filters to limit results.
|
|
639
|
+
*
|
|
640
|
+
* @param {Payabli.Entry} entry
|
|
641
|
+
* @param {number} transferId - The numeric identifier for the transfer, assigned by Payabli.
|
|
642
|
+
* @param {Payabli.ListTransferDetailsOutRequest} request
|
|
643
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
644
|
+
*
|
|
645
|
+
* @throws {@link Payabli.BadRequestError}
|
|
646
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
647
|
+
* @throws {@link Payabli.InternalServerError}
|
|
648
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
649
|
+
*
|
|
650
|
+
* @example
|
|
651
|
+
* await client.query.listTransferDetailsOut("47ace2b25", 4521, {
|
|
652
|
+
* fromRecord: 0,
|
|
653
|
+
* limitRecord: 20
|
|
654
|
+
* })
|
|
655
|
+
*/
|
|
656
|
+
listTransferDetailsOut(entry: Payabli.Entry, transferId: number, request?: Payabli.ListTransferDetailsOutRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.TransferOutDetailQueryResponse>;
|
|
657
|
+
private __listTransferDetailsOut;
|
|
597
658
|
/**
|
|
598
659
|
* Get list of users for an org. Use filters to limit results.
|
|
599
660
|
*
|
|
@@ -618,7 +679,7 @@ export declare class QueryClient {
|
|
|
618
679
|
/**
|
|
619
680
|
* Get list of users for a paypoint. Use filters to limit results.
|
|
620
681
|
*
|
|
621
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
682
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
622
683
|
* @param {Payabli.ListUsersPaypointRequest} request
|
|
623
684
|
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
624
685
|
*
|
|
@@ -639,7 +700,7 @@ export declare class QueryClient {
|
|
|
639
700
|
/**
|
|
640
701
|
* Retrieve a list of vendors 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.
|
|
641
702
|
*
|
|
642
|
-
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
703
|
+
* @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
643
704
|
* @param {Payabli.ListVendorsRequest} request
|
|
644
705
|
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
645
706
|
*
|