@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.
Files changed (174) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/bill/client/Client.d.ts +2 -2
  3. package/dist/cjs/api/resources/bill/client/Client.js +2 -2
  4. package/dist/cjs/api/resources/cloud/client/Client.d.ts +4 -4
  5. package/dist/cjs/api/resources/cloud/client/Client.js +4 -4
  6. package/dist/cjs/api/resources/export/client/Client.d.ts +14 -14
  7. package/dist/cjs/api/resources/export/client/Client.js +14 -14
  8. package/dist/cjs/api/resources/hostedPaymentPages/client/Client.d.ts +3 -3
  9. package/dist/cjs/api/resources/hostedPaymentPages/client/Client.js +3 -3
  10. package/dist/cjs/api/resources/invoice/client/Client.d.ts +3 -3
  11. package/dist/cjs/api/resources/invoice/client/Client.js +3 -3
  12. package/dist/cjs/api/resources/lineItem/client/Client.d.ts +2 -2
  13. package/dist/cjs/api/resources/lineItem/client/Client.js +2 -2
  14. package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +10 -10
  15. package/dist/cjs/api/resources/moneyIn/client/Client.js +10 -10
  16. package/dist/cjs/api/resources/moneyIn/types/TransactionDetailResponseData.d.ts +2 -2
  17. package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +31 -0
  18. package/dist/cjs/api/resources/moneyOut/client/Client.js +75 -0
  19. package/dist/cjs/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.d.ts +10 -0
  20. package/dist/cjs/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.js +13 -0
  21. package/dist/cjs/api/resources/moneyOutTypes/types/index.d.ts +1 -0
  22. package/dist/cjs/api/resources/moneyOutTypes/types/index.js +1 -0
  23. package/dist/cjs/api/resources/organization/client/Client.d.ts +1 -1
  24. package/dist/cjs/api/resources/organization/client/Client.js +1 -1
  25. package/dist/cjs/api/resources/paypoint/client/Client.d.ts +6 -6
  26. package/dist/cjs/api/resources/paypoint/client/Client.js +6 -6
  27. package/dist/cjs/api/resources/query/client/Client.d.ts +63 -2
  28. package/dist/cjs/api/resources/query/client/Client.js +228 -2
  29. package/dist/cjs/api/resources/query/client/requests/ListTransactionsOrgRequest.d.ts +0 -1
  30. package/dist/cjs/api/resources/query/client/requests/ListTransferDetailsOutRequest.d.ts +45 -0
  31. package/dist/cjs/api/resources/query/client/requests/ListTransferDetailsOutRequest.js +3 -0
  32. package/dist/cjs/api/resources/query/client/requests/ListTransfersOutOrgRequest.d.ts +46 -0
  33. package/dist/cjs/api/resources/query/client/requests/ListTransfersOutOrgRequest.js +3 -0
  34. package/dist/cjs/api/resources/query/client/requests/ListTransfersOutPaypointRequest.d.ts +46 -0
  35. package/dist/cjs/api/resources/query/client/requests/ListTransfersOutPaypointRequest.js +3 -0
  36. package/dist/cjs/api/resources/query/client/requests/ListTransfersPaypointRequest.d.ts +0 -1
  37. package/dist/cjs/api/resources/query/client/requests/index.d.ts +3 -0
  38. package/dist/cjs/api/resources/queryTypes/types/QueryBatchesResponse.d.ts +3 -3
  39. package/dist/cjs/api/resources/queryTypes/types/TransferOutBankAccount.d.ts +11 -0
  40. package/dist/cjs/api/resources/queryTypes/types/TransferOutBankAccount.js +3 -0
  41. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBill.d.ts +36 -0
  42. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBill.js +3 -0
  43. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBillAttachment.d.ts +15 -0
  44. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBillAttachment.js +3 -0
  45. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailCheckData.d.ts +9 -0
  46. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailCheckData.js +3 -0
  47. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailEvent.d.ts +11 -0
  48. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailEvent.js +3 -0
  49. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailPaymentData.d.ts +41 -0
  50. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailPaymentData.js +3 -0
  51. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailQueryResponse.d.ts +10 -0
  52. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailQueryResponse.js +3 -0
  53. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailRecord.d.ts +132 -0
  54. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailRecord.js +3 -0
  55. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendor.d.ts +96 -0
  56. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendor.js +3 -0
  57. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.d.ts +35 -0
  58. package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.js +3 -0
  59. package/dist/cjs/api/resources/queryTypes/types/TransferOutEventData.d.ts +15 -0
  60. package/dist/cjs/api/resources/queryTypes/types/TransferOutEventData.js +3 -0
  61. package/dist/cjs/api/resources/queryTypes/types/TransferOutMessage.d.ts +22 -0
  62. package/dist/cjs/api/resources/queryTypes/types/TransferOutMessage.js +3 -0
  63. package/dist/cjs/api/resources/queryTypes/types/TransferOutMessageProperties.d.ts +9 -0
  64. package/dist/cjs/api/resources/queryTypes/types/TransferOutMessageProperties.js +3 -0
  65. package/dist/cjs/api/resources/queryTypes/types/TransferOutQueryResponse.d.ts +10 -0
  66. package/dist/cjs/api/resources/queryTypes/types/TransferOutQueryResponse.js +3 -0
  67. package/dist/cjs/api/resources/queryTypes/types/TransferOutRecord.d.ts +74 -0
  68. package/dist/cjs/api/resources/queryTypes/types/TransferOutRecord.js +3 -0
  69. package/dist/cjs/api/resources/queryTypes/types/TransferOutSummary.d.ts +11 -0
  70. package/dist/cjs/api/resources/queryTypes/types/TransferOutSummary.js +3 -0
  71. package/dist/cjs/api/resources/queryTypes/types/index.d.ts +16 -0
  72. package/dist/cjs/api/resources/queryTypes/types/index.js +16 -0
  73. package/dist/cjs/api/resources/v2MoneyInTypes/types/V2BadRequestError.d.ts +1 -1
  74. package/dist/cjs/api/resources/v2MoneyInTypes/types/V2ResponseCode.d.ts +1 -1
  75. package/dist/cjs/api/types/Entry.d.ts +1 -1
  76. package/dist/cjs/api/types/PendingFeeAmount.d.ts +1 -1
  77. package/dist/cjs/api/types/QueryTransactionEvents.d.ts +1 -1
  78. package/dist/cjs/api/types/Responsecode.d.ts +1 -1
  79. package/dist/cjs/api/types/ResultCodeText.d.ts +1 -1
  80. package/dist/cjs/api/types/ResultCodev2.d.ts +1 -1
  81. package/dist/cjs/api/types/SettingElement.d.ts +1 -1
  82. package/dist/cjs/api/types/Transfer.d.ts +2 -1
  83. package/dist/cjs/api/types/TransferBankAccount.d.ts +1 -0
  84. package/dist/cjs/api/types/TransferQueryResponse.d.ts +2 -1
  85. package/dist/cjs/version.d.ts +1 -1
  86. package/dist/cjs/version.js +1 -1
  87. package/dist/esm/BaseClient.mjs +2 -2
  88. package/dist/esm/api/resources/bill/client/Client.d.mts +2 -2
  89. package/dist/esm/api/resources/bill/client/Client.mjs +2 -2
  90. package/dist/esm/api/resources/cloud/client/Client.d.mts +4 -4
  91. package/dist/esm/api/resources/cloud/client/Client.mjs +4 -4
  92. package/dist/esm/api/resources/export/client/Client.d.mts +14 -14
  93. package/dist/esm/api/resources/export/client/Client.mjs +14 -14
  94. package/dist/esm/api/resources/hostedPaymentPages/client/Client.d.mts +3 -3
  95. package/dist/esm/api/resources/hostedPaymentPages/client/Client.mjs +3 -3
  96. package/dist/esm/api/resources/invoice/client/Client.d.mts +3 -3
  97. package/dist/esm/api/resources/invoice/client/Client.mjs +3 -3
  98. package/dist/esm/api/resources/lineItem/client/Client.d.mts +2 -2
  99. package/dist/esm/api/resources/lineItem/client/Client.mjs +2 -2
  100. package/dist/esm/api/resources/moneyIn/client/Client.d.mts +10 -10
  101. package/dist/esm/api/resources/moneyIn/client/Client.mjs +10 -10
  102. package/dist/esm/api/resources/moneyIn/types/TransactionDetailResponseData.d.mts +2 -2
  103. package/dist/esm/api/resources/moneyOut/client/Client.d.mts +31 -0
  104. package/dist/esm/api/resources/moneyOut/client/Client.mjs +75 -0
  105. package/dist/esm/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.d.mts +10 -0
  106. package/dist/esm/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.mjs +10 -0
  107. package/dist/esm/api/resources/moneyOutTypes/types/index.d.mts +1 -0
  108. package/dist/esm/api/resources/moneyOutTypes/types/index.mjs +1 -0
  109. package/dist/esm/api/resources/organization/client/Client.d.mts +1 -1
  110. package/dist/esm/api/resources/organization/client/Client.mjs +1 -1
  111. package/dist/esm/api/resources/paypoint/client/Client.d.mts +6 -6
  112. package/dist/esm/api/resources/paypoint/client/Client.mjs +6 -6
  113. package/dist/esm/api/resources/query/client/Client.d.mts +63 -2
  114. package/dist/esm/api/resources/query/client/Client.mjs +228 -2
  115. package/dist/esm/api/resources/query/client/requests/ListTransactionsOrgRequest.d.mts +0 -1
  116. package/dist/esm/api/resources/query/client/requests/ListTransferDetailsOutRequest.d.mts +45 -0
  117. package/dist/esm/api/resources/query/client/requests/ListTransferDetailsOutRequest.mjs +2 -0
  118. package/dist/esm/api/resources/query/client/requests/ListTransfersOutOrgRequest.d.mts +46 -0
  119. package/dist/esm/api/resources/query/client/requests/ListTransfersOutOrgRequest.mjs +2 -0
  120. package/dist/esm/api/resources/query/client/requests/ListTransfersOutPaypointRequest.d.mts +46 -0
  121. package/dist/esm/api/resources/query/client/requests/ListTransfersOutPaypointRequest.mjs +2 -0
  122. package/dist/esm/api/resources/query/client/requests/ListTransfersPaypointRequest.d.mts +0 -1
  123. package/dist/esm/api/resources/query/client/requests/index.d.mts +3 -0
  124. package/dist/esm/api/resources/queryTypes/types/QueryBatchesResponse.d.mts +3 -3
  125. package/dist/esm/api/resources/queryTypes/types/TransferOutBankAccount.d.mts +11 -0
  126. package/dist/esm/api/resources/queryTypes/types/TransferOutBankAccount.mjs +2 -0
  127. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBill.d.mts +36 -0
  128. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBill.mjs +2 -0
  129. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBillAttachment.d.mts +15 -0
  130. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBillAttachment.mjs +2 -0
  131. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailCheckData.d.mts +9 -0
  132. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailCheckData.mjs +2 -0
  133. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailEvent.d.mts +11 -0
  134. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailEvent.mjs +2 -0
  135. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailPaymentData.d.mts +41 -0
  136. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailPaymentData.mjs +2 -0
  137. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailQueryResponse.d.mts +10 -0
  138. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailQueryResponse.mjs +2 -0
  139. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailRecord.d.mts +132 -0
  140. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailRecord.mjs +2 -0
  141. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendor.d.mts +96 -0
  142. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendor.mjs +2 -0
  143. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.d.mts +35 -0
  144. package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.mjs +2 -0
  145. package/dist/esm/api/resources/queryTypes/types/TransferOutEventData.d.mts +15 -0
  146. package/dist/esm/api/resources/queryTypes/types/TransferOutEventData.mjs +2 -0
  147. package/dist/esm/api/resources/queryTypes/types/TransferOutMessage.d.mts +22 -0
  148. package/dist/esm/api/resources/queryTypes/types/TransferOutMessage.mjs +2 -0
  149. package/dist/esm/api/resources/queryTypes/types/TransferOutMessageProperties.d.mts +9 -0
  150. package/dist/esm/api/resources/queryTypes/types/TransferOutMessageProperties.mjs +2 -0
  151. package/dist/esm/api/resources/queryTypes/types/TransferOutQueryResponse.d.mts +10 -0
  152. package/dist/esm/api/resources/queryTypes/types/TransferOutQueryResponse.mjs +2 -0
  153. package/dist/esm/api/resources/queryTypes/types/TransferOutRecord.d.mts +74 -0
  154. package/dist/esm/api/resources/queryTypes/types/TransferOutRecord.mjs +2 -0
  155. package/dist/esm/api/resources/queryTypes/types/TransferOutSummary.d.mts +11 -0
  156. package/dist/esm/api/resources/queryTypes/types/TransferOutSummary.mjs +2 -0
  157. package/dist/esm/api/resources/queryTypes/types/index.d.mts +16 -0
  158. package/dist/esm/api/resources/queryTypes/types/index.mjs +16 -0
  159. package/dist/esm/api/resources/v2MoneyInTypes/types/V2BadRequestError.d.mts +1 -1
  160. package/dist/esm/api/resources/v2MoneyInTypes/types/V2ResponseCode.d.mts +1 -1
  161. package/dist/esm/api/types/Entry.d.mts +1 -1
  162. package/dist/esm/api/types/PendingFeeAmount.d.mts +1 -1
  163. package/dist/esm/api/types/QueryTransactionEvents.d.mts +1 -1
  164. package/dist/esm/api/types/Responsecode.d.mts +1 -1
  165. package/dist/esm/api/types/ResultCodeText.d.mts +1 -1
  166. package/dist/esm/api/types/ResultCodev2.d.mts +1 -1
  167. package/dist/esm/api/types/SettingElement.d.mts +1 -1
  168. package/dist/esm/api/types/Transfer.d.mts +2 -1
  169. package/dist/esm/api/types/TransferBankAccount.d.mts +1 -0
  170. package/dist/esm/api/types/TransferQueryResponse.d.mts +2 -1
  171. package/dist/esm/version.d.mts +1 -1
  172. package/dist/esm/version.mjs +1 -1
  173. package/package.json +1 -1
  174. package/reference.md +360 -48
@@ -31,7 +31,7 @@ export class MoneyInClient {
31
31
  this._options = normalizeClientOptionsWithAuth(options);
32
32
  }
33
33
  /**
34
- * 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).
34
+ * 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).
35
35
  * Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
36
36
  * <Tip>
37
37
  * 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.
@@ -122,11 +122,11 @@ export class MoneyInClient {
122
122
  }
123
123
  /**
124
124
  * <Warning>
125
- * This endpoint is deprecated and will be sunset on November 24, 2025. Migrate to [POST `/capture/{transId}`](/api-reference/moneyin/capture-an-authorized-transaction)`.
125
+ * 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)`.
126
126
  * </Warning>
127
127
  *
128
128
  * Capture an [authorized
129
- * transaction](/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
129
+ * transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
130
130
  *
131
131
  * @param {string} transId - ReferenceId for the transaction (PaymentId).
132
132
  * @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.
@@ -184,7 +184,7 @@ export class MoneyInClient {
184
184
  });
185
185
  }
186
186
  /**
187
- * Capture an [authorized transaction](/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
187
+ * Capture an [authorized transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
188
188
  *
189
189
  * 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.
190
190
  *
@@ -1162,7 +1162,7 @@ export class MoneyInClient {
1162
1162
  });
1163
1163
  }
1164
1164
  /**
1165
- * 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](/developers/references/pay-in-unified-response-codes) for more information.
1165
+ * 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.
1166
1166
  *
1167
1167
  * @param {Payabli.RequestPaymentV2} request
1168
1168
  * @param {MoneyInClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1319,7 +1319,7 @@ export class MoneyInClient {
1319
1319
  });
1320
1320
  }
1321
1321
  /**
1322
- * 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](/developers/references/pay-in-unified-response-codes) for more information.
1322
+ * 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.
1323
1323
  *
1324
1324
  * **Note**: Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
1325
1325
  *
@@ -1407,7 +1407,7 @@ export class MoneyInClient {
1407
1407
  });
1408
1408
  }
1409
1409
  /**
1410
- * 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](/developers/references/pay-in-unified-response-codes) for more information.
1410
+ * 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.
1411
1411
  *
1412
1412
  * @param {string} transId - ReferenceId for the transaction (PaymentId).
1413
1413
  * @param {Payabli.CaptureRequest} request
@@ -1483,7 +1483,7 @@ export class MoneyInClient {
1483
1483
  /**
1484
1484
  * 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).
1485
1485
  *
1486
- * This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/developers/references/pay-in-unified-response-codes) for more information.
1486
+ * 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.
1487
1487
  *
1488
1488
  * @param {string} transId - ReferenceId for the transaction (PaymentId).
1489
1489
  * @param {MoneyInClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1542,7 +1542,7 @@ export class MoneyInClient {
1542
1542
  /**
1543
1543
  * 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.
1544
1544
  *
1545
- * This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/developers/references/pay-in-unified-response-codes) for more information.
1545
+ * 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.
1546
1546
  *
1547
1547
  * @param {string} transId - ReferenceId for the transaction (PaymentId).
1548
1548
  * @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.
@@ -1603,7 +1603,7 @@ export class MoneyInClient {
1603
1603
  });
1604
1604
  }
1605
1605
  /**
1606
- * 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](/developers/references/pay-in-unified-response-codes) for more information.
1606
+ * 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.
1607
1607
  *
1608
1608
  * @param {string} transId - ReferenceId for the transaction (PaymentId).
1609
1609
  * @param {MoneyInClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -3,9 +3,9 @@ import type * as Payabli from "../../../index.mjs";
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](/developers/references/pay-in-unified-response-codes) for more information. */
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](/developers/references/pay-in-unified-response-codes) for more information. */
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
  }
@@ -747,4 +747,79 @@ export class MoneyOutClient {
747
747
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/MoneyOut/checkimage/{assetName}");
748
748
  });
749
749
  }
750
+ /**
751
+ * Updates the status of a processed check payment transaction. This endpoint handles the status transition, updates related bills, creates audit events, and triggers notifications.
752
+ *
753
+ * The transaction must meet all of the following criteria:
754
+ * - **Status**: Must be in Processing or Processed status.
755
+ * - **Payment method**: Must be a check payment method.
756
+ *
757
+ * ### Allowed status values
758
+ *
759
+ * | Value | Status | Description |
760
+ * |-------|--------|-------------|
761
+ * | `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. |
762
+ * | `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. |
763
+ *
764
+ * @param {string} transId - The Payabli transaction ID for the check payment.
765
+ * @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.
766
+ * @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
767
+ *
768
+ * @throws {@link Payabli.BadRequestError}
769
+ * @throws {@link Payabli.UnauthorizedError}
770
+ * @throws {@link Payabli.InternalServerError}
771
+ * @throws {@link Payabli.ServiceUnavailableError}
772
+ *
773
+ * @example
774
+ * await client.moneyOut.updateCheckPaymentStatus("TRANS123456", "5")
775
+ *
776
+ * @example
777
+ * await client.moneyOut.updateCheckPaymentStatus("TRANS123456", "0")
778
+ */
779
+ updateCheckPaymentStatus(transId, checkPaymentStatus, requestOptions) {
780
+ return core.HttpResponsePromise.fromPromise(this.__updateCheckPaymentStatus(transId, checkPaymentStatus, requestOptions));
781
+ }
782
+ __updateCheckPaymentStatus(transId, checkPaymentStatus, requestOptions) {
783
+ return __awaiter(this, void 0, void 0, function* () {
784
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
785
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
786
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
787
+ const _response = yield core.fetcher({
788
+ 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)}`),
789
+ method: "PATCH",
790
+ headers: _headers,
791
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
792
+ 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,
793
+ 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,
794
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
795
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
796
+ logging: this._options.logging,
797
+ });
798
+ if (_response.ok) {
799
+ return {
800
+ data: _response.body,
801
+ rawResponse: _response.rawResponse,
802
+ };
803
+ }
804
+ if (_response.error.reason === "status-code") {
805
+ switch (_response.error.statusCode) {
806
+ case 400:
807
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
808
+ case 401:
809
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
810
+ case 500:
811
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
812
+ case 503:
813
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
814
+ default:
815
+ throw new errors.PayabliError({
816
+ statusCode: _response.error.statusCode,
817
+ body: _response.error.body,
818
+ rawResponse: _response.rawResponse,
819
+ });
820
+ }
821
+ }
822
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/MoneyOut/status/{transId}/{checkPaymentStatus}");
823
+ });
824
+ }
750
825
  }
@@ -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,10 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ /**
3
+ * The new status to apply to a check payment transaction.
4
+ * - `0`: Cancelled/Voided — Cancels the check transaction.
5
+ * - `5`: Paid — Marks the check transaction as paid.
6
+ */
7
+ export const AllowedCheckPaymentStatus = {
8
+ Cancelled: "0",
9
+ Paid: "5",
10
+ };
@@ -1,3 +1,4 @@
1
+ export * from "./AllowedCheckPaymentStatus.mjs";
1
2
  export * from "./AuthCapturePayoutResponse.mjs";
2
3
  export * from "./AuthorizePaymentMethod.mjs";
3
4
  export * from "./AuthorizePayoutBody.mjs";
@@ -1,3 +1,4 @@
1
+ export * from "./AllowedCheckPaymentStatus.mjs";
1
2
  export * from "./AuthCapturePayoutResponse.mjs";
2
3
  export * from "./AuthorizePaymentMethod.mjs";
3
4
  export * from "./AuthorizePayoutBody.mjs";
@@ -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}
@@ -268,7 +268,7 @@ export class OrganizationClient {
268
268
  /**
269
269
  * Gets an organization's basic information by entry name (entrypoint identifier).
270
270
  *
271
- * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
271
+ * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
272
272
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
273
273
  *
274
274
  * @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}
@@ -22,7 +22,7 @@ export class PaypointClient {
22
22
  /**
23
23
  * Gets the basic details for a paypoint.
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 {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
27
27
  *
28
28
  * @throws {@link Payabli.BadRequestError}
@@ -136,7 +136,7 @@ export class PaypointClient {
136
136
  /**
137
137
  * Gets the details for a single paypoint.
138
138
  *
139
- * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
139
+ * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
140
140
  * @param {Payabli.GetEntryConfigRequest} request
141
141
  * @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
142
142
  *
@@ -199,7 +199,7 @@ export class PaypointClient {
199
199
  /**
200
200
  * Gets the details for single payment page for a paypoint.
201
201
  *
202
- * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
202
+ * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
203
203
  * @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`.
204
204
  * @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
205
205
  *
@@ -257,7 +257,7 @@ export class PaypointClient {
257
257
  /**
258
258
  * Deletes a payment page in a paypoint.
259
259
  *
260
- * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
260
+ * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
261
261
  * @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`.
262
262
  * @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
263
263
  *
@@ -318,7 +318,7 @@ export class PaypointClient {
318
318
  /**
319
319
  * Updates a paypoint logo.
320
320
  *
321
- * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
321
+ * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
322
322
  * @param {Payabli.FileContent} request
323
323
  * @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
324
324
  *
@@ -382,7 +382,7 @@ export class PaypointClient {
382
382
  /**
383
383
  * Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.
384
384
  *
385
- * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
385
+ * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
386
386
  * @param {PaypointClient.RequestOptions} requestOptions - Request-specific configuration.
387
387
  *
388
388
  * @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
  *