@payabli/sdk-node 0.0.142 → 0.0.144

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 (42) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/boarding/client/Client.d.ts +38 -0
  3. package/dist/cjs/api/resources/boarding/client/Client.js +129 -0
  4. package/dist/cjs/api/resources/boarding/types/CreateApplicationFromPaypointRequest.d.ts +15 -0
  5. package/dist/cjs/api/resources/boarding/types/CreateApplicationFromPaypointRequest.js +3 -0
  6. package/dist/cjs/api/resources/boarding/types/CreateApplicationFromPaypointResponse.d.ts +20 -0
  7. package/dist/cjs/api/resources/boarding/types/CreateApplicationFromPaypointResponse.js +3 -0
  8. package/dist/cjs/api/resources/boarding/types/index.d.ts +2 -0
  9. package/dist/cjs/api/resources/boarding/types/index.js +2 -0
  10. package/dist/cjs/api/resources/moneyIn/types/TransactionDetailCustomer.d.ts +16 -16
  11. package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +5 -1
  12. package/dist/cjs/api/resources/moneyOut/client/Client.js +5 -1
  13. package/dist/cjs/api/resources/v2MoneyInTypes/types/V2TransactionDetails.d.ts +2 -2
  14. package/dist/cjs/api/types/AutoCapture.d.ts +5 -1
  15. package/dist/cjs/api/types/CustomerQueryRecords.d.ts +8 -8
  16. package/dist/cjs/api/types/CustomerSummaryRecord.d.ts +4 -4
  17. package/dist/cjs/api/types/SubscriptionQueryRecords.d.ts +1 -1
  18. package/dist/cjs/api/types/TransactionQueryRecords.d.ts +1 -1
  19. package/dist/cjs/version.d.ts +1 -1
  20. package/dist/cjs/version.js +1 -1
  21. package/dist/esm/BaseClient.mjs +2 -2
  22. package/dist/esm/api/resources/boarding/client/Client.d.mts +38 -0
  23. package/dist/esm/api/resources/boarding/client/Client.mjs +129 -0
  24. package/dist/esm/api/resources/boarding/types/CreateApplicationFromPaypointRequest.d.mts +15 -0
  25. package/dist/esm/api/resources/boarding/types/CreateApplicationFromPaypointRequest.mjs +2 -0
  26. package/dist/esm/api/resources/boarding/types/CreateApplicationFromPaypointResponse.d.mts +20 -0
  27. package/dist/esm/api/resources/boarding/types/CreateApplicationFromPaypointResponse.mjs +2 -0
  28. package/dist/esm/api/resources/boarding/types/index.d.mts +2 -0
  29. package/dist/esm/api/resources/boarding/types/index.mjs +2 -0
  30. package/dist/esm/api/resources/moneyIn/types/TransactionDetailCustomer.d.mts +16 -16
  31. package/dist/esm/api/resources/moneyOut/client/Client.d.mts +5 -1
  32. package/dist/esm/api/resources/moneyOut/client/Client.mjs +5 -1
  33. package/dist/esm/api/resources/v2MoneyInTypes/types/V2TransactionDetails.d.mts +2 -2
  34. package/dist/esm/api/types/AutoCapture.d.mts +5 -1
  35. package/dist/esm/api/types/CustomerQueryRecords.d.mts +8 -8
  36. package/dist/esm/api/types/CustomerSummaryRecord.d.mts +4 -4
  37. package/dist/esm/api/types/SubscriptionQueryRecords.d.mts +1 -1
  38. package/dist/esm/api/types/TransactionQueryRecords.d.mts +1 -1
  39. package/dist/esm/version.d.mts +1 -1
  40. package/dist/esm/version.mjs +1 -1
  41. package/package.json +1 -1
  42. package/reference.md +137 -1
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@payabli/sdk-node",
46
- "X-Fern-SDK-Version": "0.0.142",
47
- "User-Agent": "@payabli/sdk-node/0.0.142",
46
+ "X-Fern-SDK-Version": "0.0.144",
47
+ "User-Agent": "@payabli/sdk-node/0.0.144",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -711,4 +711,42 @@ export declare class BoardingClient {
711
711
  */
712
712
  updateApplication(appId: number, request: Payabli.ApplicationData, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
713
713
  private __updateApplication;
714
+ /**
715
+ * Creates a new boarding application linked to an existing paypoint as part of the multi-product boarding flow. Use this endpoint to add new services to a paypoint without creating a duplicate record. The system copies eligible business, contact, banking, and address data from the paypoint to the new application based on 1:1 field matching. The merchant only needs to provide fields that are specific to the new service. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
716
+ *
717
+ * @param {Payabli.CreateApplicationFromPaypointRequest} request
718
+ * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
719
+ *
720
+ * @throws {@link Payabli.BadRequestError}
721
+ * @throws {@link Payabli.UnauthorizedError}
722
+ * @throws {@link Payabli.InternalServerError}
723
+ * @throws {@link Payabli.ServiceUnavailableError}
724
+ *
725
+ * @example
726
+ * await client.boarding.addServiceToPaypointFromApp({
727
+ * paypointId: 123,
728
+ * templateId: 456,
729
+ * recipientEmail: "merchant@example.com",
730
+ * returnBoardingAccessInfoInLine: true,
731
+ * onCreate: ["submitApplication"]
732
+ * })
733
+ */
734
+ addServiceToPaypointFromApp(request: Payabli.CreateApplicationFromPaypointRequest, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.CreateApplicationFromPaypointResponse>;
735
+ private __addServiceToPaypointFromApp;
736
+ /**
737
+ * Returns all boarding applications associated with a specific paypoint, including those created through the multi-product boarding flow. Use this endpoint to track underwriting progress across multiple service additions or to build reporting views. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
738
+ *
739
+ * @param {number} paypointId - ID of the paypoint to retrieve applications for.
740
+ * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
741
+ *
742
+ * @throws {@link Payabli.BadRequestError}
743
+ * @throws {@link Payabli.UnauthorizedError}
744
+ * @throws {@link Payabli.InternalServerError}
745
+ * @throws {@link Payabli.ServiceUnavailableError}
746
+ *
747
+ * @example
748
+ * await client.boarding.getApplicationsByPaypointId(12345)
749
+ */
750
+ getApplicationsByPaypointId(paypointId: number, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryBoardingAppsListResponse>;
751
+ private __getApplicationsByPaypointId;
714
752
  }
@@ -1248,5 +1248,134 @@ class BoardingClient {
1248
1248
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PUT", "/Boarding/app/{appId}");
1249
1249
  });
1250
1250
  }
1251
+ /**
1252
+ * Creates a new boarding application linked to an existing paypoint as part of the multi-product boarding flow. Use this endpoint to add new services to a paypoint without creating a duplicate record. The system copies eligible business, contact, banking, and address data from the paypoint to the new application based on 1:1 field matching. The merchant only needs to provide fields that are specific to the new service. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
1253
+ *
1254
+ * @param {Payabli.CreateApplicationFromPaypointRequest} request
1255
+ * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
1256
+ *
1257
+ * @throws {@link Payabli.BadRequestError}
1258
+ * @throws {@link Payabli.UnauthorizedError}
1259
+ * @throws {@link Payabli.InternalServerError}
1260
+ * @throws {@link Payabli.ServiceUnavailableError}
1261
+ *
1262
+ * @example
1263
+ * await client.boarding.addServiceToPaypointFromApp({
1264
+ * paypointId: 123,
1265
+ * templateId: 456,
1266
+ * recipientEmail: "merchant@example.com",
1267
+ * returnBoardingAccessInfoInLine: true,
1268
+ * onCreate: ["submitApplication"]
1269
+ * })
1270
+ */
1271
+ addServiceToPaypointFromApp(request, requestOptions) {
1272
+ return core.HttpResponsePromise.fromPromise(this.__addServiceToPaypointFromApp(request, requestOptions));
1273
+ }
1274
+ __addServiceToPaypointFromApp(request, requestOptions) {
1275
+ return __awaiter(this, void 0, void 0, function* () {
1276
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
1277
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1278
+ 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);
1279
+ const _response = yield core.fetcher({
1280
+ 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, "Boarding/applications"),
1281
+ method: "POST",
1282
+ headers: _headers,
1283
+ contentType: "application/json",
1284
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1285
+ requestType: "json",
1286
+ body: request,
1287
+ 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,
1288
+ 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,
1289
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1290
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
1291
+ logging: this._options.logging,
1292
+ });
1293
+ if (_response.ok) {
1294
+ return {
1295
+ data: _response.body,
1296
+ rawResponse: _response.rawResponse,
1297
+ };
1298
+ }
1299
+ if (_response.error.reason === "status-code") {
1300
+ switch (_response.error.statusCode) {
1301
+ case 400:
1302
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
1303
+ case 401:
1304
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
1305
+ case 500:
1306
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
1307
+ case 503:
1308
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1309
+ default:
1310
+ throw new errors.PayabliError({
1311
+ statusCode: _response.error.statusCode,
1312
+ body: _response.error.body,
1313
+ rawResponse: _response.rawResponse,
1314
+ });
1315
+ }
1316
+ }
1317
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/Boarding/applications");
1318
+ });
1319
+ }
1320
+ /**
1321
+ * Returns all boarding applications associated with a specific paypoint, including those created through the multi-product boarding flow. Use this endpoint to track underwriting progress across multiple service additions or to build reporting views. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
1322
+ *
1323
+ * @param {number} paypointId - ID of the paypoint to retrieve applications for.
1324
+ * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
1325
+ *
1326
+ * @throws {@link Payabli.BadRequestError}
1327
+ * @throws {@link Payabli.UnauthorizedError}
1328
+ * @throws {@link Payabli.InternalServerError}
1329
+ * @throws {@link Payabli.ServiceUnavailableError}
1330
+ *
1331
+ * @example
1332
+ * await client.boarding.getApplicationsByPaypointId(12345)
1333
+ */
1334
+ getApplicationsByPaypointId(paypointId, requestOptions) {
1335
+ return core.HttpResponsePromise.fromPromise(this.__getApplicationsByPaypointId(paypointId, requestOptions));
1336
+ }
1337
+ __getApplicationsByPaypointId(paypointId, requestOptions) {
1338
+ return __awaiter(this, void 0, void 0, function* () {
1339
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
1340
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1341
+ 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);
1342
+ const _response = yield core.fetcher({
1343
+ 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, `Boarding/applications/${core.url.encodePathParam(paypointId)}`),
1344
+ method: "GET",
1345
+ headers: _headers,
1346
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1347
+ 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,
1348
+ 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,
1349
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1350
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
1351
+ logging: this._options.logging,
1352
+ });
1353
+ if (_response.ok) {
1354
+ return {
1355
+ data: _response.body,
1356
+ rawResponse: _response.rawResponse,
1357
+ };
1358
+ }
1359
+ if (_response.error.reason === "status-code") {
1360
+ switch (_response.error.statusCode) {
1361
+ case 400:
1362
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
1363
+ case 401:
1364
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
1365
+ case 500:
1366
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
1367
+ case 503:
1368
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1369
+ default:
1370
+ throw new errors.PayabliError({
1371
+ statusCode: _response.error.statusCode,
1372
+ body: _response.error.body,
1373
+ rawResponse: _response.rawResponse,
1374
+ });
1375
+ }
1376
+ }
1377
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Boarding/applications/{paypointId}");
1378
+ });
1379
+ }
1251
1380
  }
1252
1381
  exports.BoardingClient = BoardingClient;
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Request to create a boarding application linked to an existing paypoint. Used for adding new services to a paypoint without creating a duplicate record.
3
+ */
4
+ export interface CreateApplicationFromPaypointRequest {
5
+ /** ID of the existing paypoint to link to this application. */
6
+ paypointId: number;
7
+ /** ID of the boarding template to use for the new application. */
8
+ templateId: number;
9
+ /** Email address where the boarding link is sent. Required. If you don't want to email the merchant, send to an internal address and use `returnBoardingAccessInfoInLine` to retrieve the link from the response instead. */
10
+ recipientEmail: string;
11
+ /** When `true`, returns the boarding access information directly in the response. */
12
+ returnBoardingAccessInfoInLine?: boolean | undefined;
13
+ /** Additional actions to trigger when the application is created. Currently only `submitApplication` is supported, which automatically submits the application on creation and skips the draft state. */
14
+ onCreate?: string[] | undefined;
15
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,20 @@
1
+ import type * as Payabli from "../../../index.js";
2
+ /**
3
+ * Response returned when creating a boarding application linked to an existing paypoint.
4
+ */
5
+ export interface CreateApplicationFromPaypointResponse {
6
+ responseCode?: Payabli.Responsecode | undefined;
7
+ pageIdentifier?: Payabli.PageIdentifier | undefined;
8
+ roomId?: Payabli.RoomIdNotInUse | undefined;
9
+ isSuccess?: Payabli.IsSuccess | undefined;
10
+ responseText: Payabli.ResponseText;
11
+ responseData?: CreateApplicationFromPaypointResponse.ResponseData | undefined;
12
+ }
13
+ export declare namespace CreateApplicationFromPaypointResponse {
14
+ interface ResponseData {
15
+ /** Unique identifier for the created application. */
16
+ appId?: number | undefined;
17
+ /** URL where the merchant can complete the boarding process. */
18
+ boardingLink?: string | undefined;
19
+ }
20
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1 +1,3 @@
1
1
  export * from "./AddApplicationRequest.js";
2
+ export * from "./CreateApplicationFromPaypointRequest.js";
3
+ export * from "./CreateApplicationFromPaypointResponse.js";
@@ -15,3 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./AddApplicationRequest.js"), exports);
18
+ __exportStar(require("./CreateApplicationFromPaypointRequest.js"), exports);
19
+ __exportStar(require("./CreateApplicationFromPaypointResponse.js"), exports);
@@ -6,22 +6,22 @@ export interface TransactionDetailCustomer {
6
6
  identifiers: Payabli.Identifierfields | null;
7
7
  firstName: string;
8
8
  lastName: string;
9
- companyName: string;
10
- billingAddress1: Payabli.BillingAddressNullable;
11
- billingAddress2: Payabli.BillingAddressAddtlNullable;
12
- billingCity: Payabli.BillingCityNullable;
13
- billingState: Payabli.BillingStateNullable;
14
- billingZip: Payabli.BillingZip;
15
- billingCountry: Payabli.BillingCountryNullable;
16
- billingPhone: Payabli.PhoneNumber;
17
- billingEmail: Payabli.Email;
18
- customerNumber: Payabli.CustomerNumberNullable;
19
- shippingAddress1: Payabli.Shippingaddress;
20
- shippingAddress2: Payabli.Shippingaddressadditional;
21
- shippingCity: Payabli.Shippingcity;
22
- shippingState: Payabli.Shippingstate;
23
- shippingZip: Payabli.Shippingzip;
24
- shippingCountry: Payabli.Shippingcountry;
9
+ companyName: string | null;
10
+ billingAddress1: Payabli.BillingAddressNullable | null;
11
+ billingAddress2: Payabli.BillingAddressAddtlNullable | null;
12
+ billingCity: Payabli.BillingCityNullable | null;
13
+ billingState: Payabli.BillingStateNullable | null;
14
+ billingZip: Payabli.BillingZip | null;
15
+ billingCountry: Payabli.BillingCountryNullable | null;
16
+ billingPhone: Payabli.PhoneNumber | null;
17
+ billingEmail: Payabli.Email | null;
18
+ customerNumber: Payabli.CustomerNumberNullable | null;
19
+ shippingAddress1: Payabli.Shippingaddress | null;
20
+ shippingAddress2: Payabli.Shippingaddressadditional | null;
21
+ shippingCity: Payabli.Shippingcity | null;
22
+ shippingState: Payabli.Shippingstate | null;
23
+ shippingZip: Payabli.Shippingzip | null;
24
+ shippingCountry: Payabli.Shippingcountry | null;
25
25
  customerId: Payabli.CustomerId;
26
26
  customerStatus: Payabli.CustomerStatus;
27
27
  additionalData: Payabli.AdditionalDataMap | null;
@@ -11,7 +11,11 @@ export declare class MoneyOutClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<MoneyOutClient.Options>;
12
12
  constructor(options?: MoneyOutClient.Options);
13
13
  /**
14
- * Authorizes transaction for payout. If you don't pass the `autoCapture` field with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use `referenceId` returned in the response to capture the transaction.
14
+ * Authorizes a transaction for payout.
15
+ *
16
+ * If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.
17
+ *
18
+ * When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
15
19
  *
16
20
  * @param {Payabli.MoneyOutTypesRequestOutAuthorize} request
17
21
  * @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,11 @@ class MoneyOutClient {
56
56
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
57
57
  }
58
58
  /**
59
- * Authorizes transaction for payout. If you don't pass the `autoCapture` field with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use `referenceId` returned in the response to capture the transaction.
59
+ * Authorizes a transaction for payout.
60
+ *
61
+ * If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.
62
+ *
63
+ * When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
60
64
  *
61
65
  * @param {Payabli.MoneyOutTypesRequestOutAuthorize} request
62
66
  * @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -976,7 +976,7 @@ export interface V2TransactionDetails {
976
976
  transAdditionalData: unknown | null;
977
977
  invoiceData: Payabli.TransactionDetailInvoiceData;
978
978
  entrypageId: Payabli.EntrypageId;
979
- externalPaypointID: Payabli.ExternalPaypointId;
979
+ externalPaypointID: Payabli.ExternalPaypointId | null;
980
980
  /** Indicates if ACH account was validated in real-time. */
981
981
  isValidatedACH: boolean;
982
982
  /** Timestamp when transaction was created. */
@@ -994,7 +994,7 @@ export interface V2TransactionDetails {
994
994
  riskActionCode?: Payabli.RiskActionCode | undefined;
995
995
  deviceId: Payabli.Device;
996
996
  achSecCode: Payabli.AchSecCode;
997
- achHolderType: Payabli.AchHolderType;
997
+ achHolderType: Payabli.AchHolderType | null;
998
998
  ipAddress: Payabli.IpAddress;
999
999
  /** Indicates if ACH transaction uses same-day processing. */
1000
1000
  isSameDayACH: boolean;
@@ -1,4 +1,8 @@
1
1
  /**
2
- * When `true`, the transaction is automatically captured after a successful authorization. When `false`, you must manually capture the transaction after a successful authorization. Defaults to `false`. See [Manage payouts with the API](/guides/pay-out-developer-payouts-manage) for more information.
2
+ * When `true`, Payabli captures the transaction asynchronously after a successful authorization. The authorization request returns once the transaction is authorized; capture happens later, and the response doesn't confirm capture. To confirm capture succeeded, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
3
+ *
4
+ * When `false`, you must manually capture the transaction after a successful authorization. Defaults to `false`.
5
+ *
6
+ * See [Manage payouts with the API](/guides/pay-out-developer-payouts-manage) for more information.
3
7
  */
4
8
  export type AutoCapture = boolean;
@@ -97,8 +97,8 @@ import type * as Payabli from "../index.js";
97
97
  * method: "card"
98
98
  * }],
99
99
  * customerSummary: {
100
- * numberofTransactions: 30,
101
- * recentTransactions: [{
100
+ * NumberofTransactions: 30,
101
+ * RecentTransactions: [{
102
102
  * EntrypageId: 0,
103
103
  * FeeAmount: 1,
104
104
  * PayorId: 1551,
@@ -107,8 +107,8 @@ import type * as Payabli from "../index.js";
107
107
  * TotalAmount: 30.22,
108
108
  * TransStatus: 1
109
109
  * }],
110
- * totalAmountTransactions: 1500,
111
- * totalNetAmountTransactions: 1500
110
+ * TotalAmountTransactions: 1500,
111
+ * TotalNetAmountTransactions: 1500
112
112
  * },
113
113
  * PaypointLegalname: "Sunshine Services, LLC",
114
114
  * PaypointDbaname: "Sunshine Gutters",
@@ -153,8 +153,8 @@ import type * as Payabli from "../index.js";
153
153
  * },
154
154
  * IdentifierFields: ["email"],
155
155
  * customerSummary: {
156
- * numberofTransactions: 30,
157
- * recentTransactions: [{
156
+ * NumberofTransactions: 30,
157
+ * RecentTransactions: [{
158
158
  * EntrypageId: 0,
159
159
  * FeeAmount: 1,
160
160
  * PayorId: 1551,
@@ -163,8 +163,8 @@ import type * as Payabli from "../index.js";
163
163
  * TotalAmount: 30.22,
164
164
  * TransStatus: 1
165
165
  * }],
166
- * totalAmountTransactions: 1500,
167
- * totalNetAmountTransactions: 1500
166
+ * TotalAmountTransactions: 1500,
167
+ * TotalNetAmountTransactions: 1500
168
168
  * },
169
169
  * PaypointLegalname: "Gruzya Adventure Outfitters, LLC",
170
170
  * PaypointDbaname: "Gruzya Adventure Outfitters",
@@ -1,11 +1,11 @@
1
1
  import type * as Payabli from "../index.js";
2
2
  export interface CustomerSummaryRecord {
3
3
  /** Number total of transactions or payments */
4
- numberofTransactions?: number | undefined;
4
+ NumberofTransactions?: number | undefined;
5
5
  /** List of more recent 5 transactions belonging to the customer */
6
- recentTransactions?: Payabli.TransactionQueryRecords[] | undefined;
6
+ RecentTransactions?: Payabli.TransactionQueryRecords[] | undefined;
7
7
  /** Total amount in transactions */
8
- totalAmountTransactions?: number | undefined;
8
+ TotalAmountTransactions?: number | undefined;
9
9
  /** Total net amount in transactions */
10
- totalNetAmountTransactions?: number | undefined;
10
+ TotalNetAmountTransactions?: number | undefined;
11
11
  }
@@ -13,7 +13,7 @@ export interface SubscriptionQueryRecords {
13
13
  Frequency?: string | undefined;
14
14
  /** The subscription's ID. */
15
15
  IdSub?: number | undefined;
16
- InvoiceData?: Payabli.BillData | undefined;
16
+ invoiceData?: Payabli.BillData | undefined;
17
17
  /** The last time the subscription was processed. */
18
18
  LastRun: string | null;
19
19
  /** The last date and time the subscription was updated. */
@@ -16,7 +16,7 @@ export interface TransactionQueryRecords {
16
16
  FeeAmount?: Payabli.FeeAmount | undefined;
17
17
  /** Internal identifier used for processing. */
18
18
  GatewayTransId?: string | undefined;
19
- InvoiceData?: Payabli.BillData | undefined;
19
+ invoiceData?: Payabli.BillData | undefined;
20
20
  /** Payment method used: card, ach, or wallet. */
21
21
  Method?: string | undefined;
22
22
  /** Net amount paid. */
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.0.142";
1
+ export declare const SDK_VERSION = "0.0.144";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.0.142";
4
+ exports.SDK_VERSION = "0.0.144";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@payabli/sdk-node",
9
- "X-Fern-SDK-Version": "0.0.142",
10
- "User-Agent": "@payabli/sdk-node/0.0.142",
9
+ "X-Fern-SDK-Version": "0.0.144",
10
+ "User-Agent": "@payabli/sdk-node/0.0.144",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -711,4 +711,42 @@ export declare class BoardingClient {
711
711
  */
712
712
  updateApplication(appId: number, request: Payabli.ApplicationData, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse00Responsedatanonobject>;
713
713
  private __updateApplication;
714
+ /**
715
+ * Creates a new boarding application linked to an existing paypoint as part of the multi-product boarding flow. Use this endpoint to add new services to a paypoint without creating a duplicate record. The system copies eligible business, contact, banking, and address data from the paypoint to the new application based on 1:1 field matching. The merchant only needs to provide fields that are specific to the new service. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
716
+ *
717
+ * @param {Payabli.CreateApplicationFromPaypointRequest} request
718
+ * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
719
+ *
720
+ * @throws {@link Payabli.BadRequestError}
721
+ * @throws {@link Payabli.UnauthorizedError}
722
+ * @throws {@link Payabli.InternalServerError}
723
+ * @throws {@link Payabli.ServiceUnavailableError}
724
+ *
725
+ * @example
726
+ * await client.boarding.addServiceToPaypointFromApp({
727
+ * paypointId: 123,
728
+ * templateId: 456,
729
+ * recipientEmail: "merchant@example.com",
730
+ * returnBoardingAccessInfoInLine: true,
731
+ * onCreate: ["submitApplication"]
732
+ * })
733
+ */
734
+ addServiceToPaypointFromApp(request: Payabli.CreateApplicationFromPaypointRequest, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.CreateApplicationFromPaypointResponse>;
735
+ private __addServiceToPaypointFromApp;
736
+ /**
737
+ * Returns all boarding applications associated with a specific paypoint, including those created through the multi-product boarding flow. Use this endpoint to track underwriting progress across multiple service additions or to build reporting views. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
738
+ *
739
+ * @param {number} paypointId - ID of the paypoint to retrieve applications for.
740
+ * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
741
+ *
742
+ * @throws {@link Payabli.BadRequestError}
743
+ * @throws {@link Payabli.UnauthorizedError}
744
+ * @throws {@link Payabli.InternalServerError}
745
+ * @throws {@link Payabli.ServiceUnavailableError}
746
+ *
747
+ * @example
748
+ * await client.boarding.getApplicationsByPaypointId(12345)
749
+ */
750
+ getApplicationsByPaypointId(paypointId: number, requestOptions?: BoardingClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryBoardingAppsListResponse>;
751
+ private __getApplicationsByPaypointId;
714
752
  }
@@ -1212,4 +1212,133 @@ export class BoardingClient {
1212
1212
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/Boarding/app/{appId}");
1213
1213
  });
1214
1214
  }
1215
+ /**
1216
+ * Creates a new boarding application linked to an existing paypoint as part of the multi-product boarding flow. Use this endpoint to add new services to a paypoint without creating a duplicate record. The system copies eligible business, contact, banking, and address data from the paypoint to the new application based on 1:1 field matching. The merchant only needs to provide fields that are specific to the new service. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
1217
+ *
1218
+ * @param {Payabli.CreateApplicationFromPaypointRequest} request
1219
+ * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
1220
+ *
1221
+ * @throws {@link Payabli.BadRequestError}
1222
+ * @throws {@link Payabli.UnauthorizedError}
1223
+ * @throws {@link Payabli.InternalServerError}
1224
+ * @throws {@link Payabli.ServiceUnavailableError}
1225
+ *
1226
+ * @example
1227
+ * await client.boarding.addServiceToPaypointFromApp({
1228
+ * paypointId: 123,
1229
+ * templateId: 456,
1230
+ * recipientEmail: "merchant@example.com",
1231
+ * returnBoardingAccessInfoInLine: true,
1232
+ * onCreate: ["submitApplication"]
1233
+ * })
1234
+ */
1235
+ addServiceToPaypointFromApp(request, requestOptions) {
1236
+ return core.HttpResponsePromise.fromPromise(this.__addServiceToPaypointFromApp(request, requestOptions));
1237
+ }
1238
+ __addServiceToPaypointFromApp(request, requestOptions) {
1239
+ return __awaiter(this, void 0, void 0, function* () {
1240
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
1241
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1242
+ 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);
1243
+ const _response = yield core.fetcher({
1244
+ 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, "Boarding/applications"),
1245
+ method: "POST",
1246
+ headers: _headers,
1247
+ contentType: "application/json",
1248
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1249
+ requestType: "json",
1250
+ body: request,
1251
+ 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,
1252
+ 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,
1253
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1254
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
1255
+ logging: this._options.logging,
1256
+ });
1257
+ if (_response.ok) {
1258
+ return {
1259
+ data: _response.body,
1260
+ rawResponse: _response.rawResponse,
1261
+ };
1262
+ }
1263
+ if (_response.error.reason === "status-code") {
1264
+ switch (_response.error.statusCode) {
1265
+ case 400:
1266
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
1267
+ case 401:
1268
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
1269
+ case 500:
1270
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
1271
+ case 503:
1272
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1273
+ default:
1274
+ throw new errors.PayabliError({
1275
+ statusCode: _response.error.statusCode,
1276
+ body: _response.error.body,
1277
+ rawResponse: _response.rawResponse,
1278
+ });
1279
+ }
1280
+ }
1281
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/Boarding/applications");
1282
+ });
1283
+ }
1284
+ /**
1285
+ * Returns all boarding applications associated with a specific paypoint, including those created through the multi-product boarding flow. Use this endpoint to track underwriting progress across multiple service additions or to build reporting views. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
1286
+ *
1287
+ * @param {number} paypointId - ID of the paypoint to retrieve applications for.
1288
+ * @param {BoardingClient.RequestOptions} requestOptions - Request-specific configuration.
1289
+ *
1290
+ * @throws {@link Payabli.BadRequestError}
1291
+ * @throws {@link Payabli.UnauthorizedError}
1292
+ * @throws {@link Payabli.InternalServerError}
1293
+ * @throws {@link Payabli.ServiceUnavailableError}
1294
+ *
1295
+ * @example
1296
+ * await client.boarding.getApplicationsByPaypointId(12345)
1297
+ */
1298
+ getApplicationsByPaypointId(paypointId, requestOptions) {
1299
+ return core.HttpResponsePromise.fromPromise(this.__getApplicationsByPaypointId(paypointId, requestOptions));
1300
+ }
1301
+ __getApplicationsByPaypointId(paypointId, requestOptions) {
1302
+ return __awaiter(this, void 0, void 0, function* () {
1303
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
1304
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1305
+ 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);
1306
+ const _response = yield core.fetcher({
1307
+ 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, `Boarding/applications/${core.url.encodePathParam(paypointId)}`),
1308
+ method: "GET",
1309
+ headers: _headers,
1310
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1311
+ 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,
1312
+ 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,
1313
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1314
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
1315
+ logging: this._options.logging,
1316
+ });
1317
+ if (_response.ok) {
1318
+ return {
1319
+ data: _response.body,
1320
+ rawResponse: _response.rawResponse,
1321
+ };
1322
+ }
1323
+ if (_response.error.reason === "status-code") {
1324
+ switch (_response.error.statusCode) {
1325
+ case 400:
1326
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
1327
+ case 401:
1328
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
1329
+ case 500:
1330
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
1331
+ case 503:
1332
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1333
+ default:
1334
+ throw new errors.PayabliError({
1335
+ statusCode: _response.error.statusCode,
1336
+ body: _response.error.body,
1337
+ rawResponse: _response.rawResponse,
1338
+ });
1339
+ }
1340
+ }
1341
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Boarding/applications/{paypointId}");
1342
+ });
1343
+ }
1215
1344
  }
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Request to create a boarding application linked to an existing paypoint. Used for adding new services to a paypoint without creating a duplicate record.
3
+ */
4
+ export interface CreateApplicationFromPaypointRequest {
5
+ /** ID of the existing paypoint to link to this application. */
6
+ paypointId: number;
7
+ /** ID of the boarding template to use for the new application. */
8
+ templateId: number;
9
+ /** Email address where the boarding link is sent. Required. If you don't want to email the merchant, send to an internal address and use `returnBoardingAccessInfoInLine` to retrieve the link from the response instead. */
10
+ recipientEmail: string;
11
+ /** When `true`, returns the boarding access information directly in the response. */
12
+ returnBoardingAccessInfoInLine?: boolean | undefined;
13
+ /** Additional actions to trigger when the application is created. Currently only `submitApplication` is supported, which automatically submits the application on creation and skips the draft state. */
14
+ onCreate?: string[] | undefined;
15
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,20 @@
1
+ import type * as Payabli from "../../../index.mjs";
2
+ /**
3
+ * Response returned when creating a boarding application linked to an existing paypoint.
4
+ */
5
+ export interface CreateApplicationFromPaypointResponse {
6
+ responseCode?: Payabli.Responsecode | undefined;
7
+ pageIdentifier?: Payabli.PageIdentifier | undefined;
8
+ roomId?: Payabli.RoomIdNotInUse | undefined;
9
+ isSuccess?: Payabli.IsSuccess | undefined;
10
+ responseText: Payabli.ResponseText;
11
+ responseData?: CreateApplicationFromPaypointResponse.ResponseData | undefined;
12
+ }
13
+ export declare namespace CreateApplicationFromPaypointResponse {
14
+ interface ResponseData {
15
+ /** Unique identifier for the created application. */
16
+ appId?: number | undefined;
17
+ /** URL where the merchant can complete the boarding process. */
18
+ boardingLink?: string | undefined;
19
+ }
20
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1 +1,3 @@
1
1
  export * from "./AddApplicationRequest.mjs";
2
+ export * from "./CreateApplicationFromPaypointRequest.mjs";
3
+ export * from "./CreateApplicationFromPaypointResponse.mjs";
@@ -1 +1,3 @@
1
1
  export * from "./AddApplicationRequest.mjs";
2
+ export * from "./CreateApplicationFromPaypointRequest.mjs";
3
+ export * from "./CreateApplicationFromPaypointResponse.mjs";
@@ -6,22 +6,22 @@ export interface TransactionDetailCustomer {
6
6
  identifiers: Payabli.Identifierfields | null;
7
7
  firstName: string;
8
8
  lastName: string;
9
- companyName: string;
10
- billingAddress1: Payabli.BillingAddressNullable;
11
- billingAddress2: Payabli.BillingAddressAddtlNullable;
12
- billingCity: Payabli.BillingCityNullable;
13
- billingState: Payabli.BillingStateNullable;
14
- billingZip: Payabli.BillingZip;
15
- billingCountry: Payabli.BillingCountryNullable;
16
- billingPhone: Payabli.PhoneNumber;
17
- billingEmail: Payabli.Email;
18
- customerNumber: Payabli.CustomerNumberNullable;
19
- shippingAddress1: Payabli.Shippingaddress;
20
- shippingAddress2: Payabli.Shippingaddressadditional;
21
- shippingCity: Payabli.Shippingcity;
22
- shippingState: Payabli.Shippingstate;
23
- shippingZip: Payabli.Shippingzip;
24
- shippingCountry: Payabli.Shippingcountry;
9
+ companyName: string | null;
10
+ billingAddress1: Payabli.BillingAddressNullable | null;
11
+ billingAddress2: Payabli.BillingAddressAddtlNullable | null;
12
+ billingCity: Payabli.BillingCityNullable | null;
13
+ billingState: Payabli.BillingStateNullable | null;
14
+ billingZip: Payabli.BillingZip | null;
15
+ billingCountry: Payabli.BillingCountryNullable | null;
16
+ billingPhone: Payabli.PhoneNumber | null;
17
+ billingEmail: Payabli.Email | null;
18
+ customerNumber: Payabli.CustomerNumberNullable | null;
19
+ shippingAddress1: Payabli.Shippingaddress | null;
20
+ shippingAddress2: Payabli.Shippingaddressadditional | null;
21
+ shippingCity: Payabli.Shippingcity | null;
22
+ shippingState: Payabli.Shippingstate | null;
23
+ shippingZip: Payabli.Shippingzip | null;
24
+ shippingCountry: Payabli.Shippingcountry | null;
25
25
  customerId: Payabli.CustomerId;
26
26
  customerStatus: Payabli.CustomerStatus;
27
27
  additionalData: Payabli.AdditionalDataMap | null;
@@ -11,7 +11,11 @@ export declare class MoneyOutClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<MoneyOutClient.Options>;
12
12
  constructor(options?: MoneyOutClient.Options);
13
13
  /**
14
- * Authorizes transaction for payout. If you don't pass the `autoCapture` field with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use `referenceId` returned in the response to capture the transaction.
14
+ * Authorizes a transaction for payout.
15
+ *
16
+ * If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.
17
+ *
18
+ * When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
15
19
  *
16
20
  * @param {Payabli.MoneyOutTypesRequestOutAuthorize} request
17
21
  * @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -20,7 +20,11 @@ export class MoneyOutClient {
20
20
  this._options = normalizeClientOptionsWithAuth(options);
21
21
  }
22
22
  /**
23
- * Authorizes transaction for payout. If you don't pass the `autoCapture` field with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use `referenceId` returned in the response to capture the transaction.
23
+ * Authorizes a transaction for payout.
24
+ *
25
+ * If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.
26
+ *
27
+ * When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
24
28
  *
25
29
  * @param {Payabli.MoneyOutTypesRequestOutAuthorize} request
26
30
  * @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -976,7 +976,7 @@ export interface V2TransactionDetails {
976
976
  transAdditionalData: unknown | null;
977
977
  invoiceData: Payabli.TransactionDetailInvoiceData;
978
978
  entrypageId: Payabli.EntrypageId;
979
- externalPaypointID: Payabli.ExternalPaypointId;
979
+ externalPaypointID: Payabli.ExternalPaypointId | null;
980
980
  /** Indicates if ACH account was validated in real-time. */
981
981
  isValidatedACH: boolean;
982
982
  /** Timestamp when transaction was created. */
@@ -994,7 +994,7 @@ export interface V2TransactionDetails {
994
994
  riskActionCode?: Payabli.RiskActionCode | undefined;
995
995
  deviceId: Payabli.Device;
996
996
  achSecCode: Payabli.AchSecCode;
997
- achHolderType: Payabli.AchHolderType;
997
+ achHolderType: Payabli.AchHolderType | null;
998
998
  ipAddress: Payabli.IpAddress;
999
999
  /** Indicates if ACH transaction uses same-day processing. */
1000
1000
  isSameDayACH: boolean;
@@ -1,4 +1,8 @@
1
1
  /**
2
- * When `true`, the transaction is automatically captured after a successful authorization. When `false`, you must manually capture the transaction after a successful authorization. Defaults to `false`. See [Manage payouts with the API](/guides/pay-out-developer-payouts-manage) for more information.
2
+ * When `true`, Payabli captures the transaction asynchronously after a successful authorization. The authorization request returns once the transaction is authorized; capture happens later, and the response doesn't confirm capture. To confirm capture succeeded, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
3
+ *
4
+ * When `false`, you must manually capture the transaction after a successful authorization. Defaults to `false`.
5
+ *
6
+ * See [Manage payouts with the API](/guides/pay-out-developer-payouts-manage) for more information.
3
7
  */
4
8
  export type AutoCapture = boolean;
@@ -97,8 +97,8 @@ import type * as Payabli from "../index.mjs";
97
97
  * method: "card"
98
98
  * }],
99
99
  * customerSummary: {
100
- * numberofTransactions: 30,
101
- * recentTransactions: [{
100
+ * NumberofTransactions: 30,
101
+ * RecentTransactions: [{
102
102
  * EntrypageId: 0,
103
103
  * FeeAmount: 1,
104
104
  * PayorId: 1551,
@@ -107,8 +107,8 @@ import type * as Payabli from "../index.mjs";
107
107
  * TotalAmount: 30.22,
108
108
  * TransStatus: 1
109
109
  * }],
110
- * totalAmountTransactions: 1500,
111
- * totalNetAmountTransactions: 1500
110
+ * TotalAmountTransactions: 1500,
111
+ * TotalNetAmountTransactions: 1500
112
112
  * },
113
113
  * PaypointLegalname: "Sunshine Services, LLC",
114
114
  * PaypointDbaname: "Sunshine Gutters",
@@ -153,8 +153,8 @@ import type * as Payabli from "../index.mjs";
153
153
  * },
154
154
  * IdentifierFields: ["email"],
155
155
  * customerSummary: {
156
- * numberofTransactions: 30,
157
- * recentTransactions: [{
156
+ * NumberofTransactions: 30,
157
+ * RecentTransactions: [{
158
158
  * EntrypageId: 0,
159
159
  * FeeAmount: 1,
160
160
  * PayorId: 1551,
@@ -163,8 +163,8 @@ import type * as Payabli from "../index.mjs";
163
163
  * TotalAmount: 30.22,
164
164
  * TransStatus: 1
165
165
  * }],
166
- * totalAmountTransactions: 1500,
167
- * totalNetAmountTransactions: 1500
166
+ * TotalAmountTransactions: 1500,
167
+ * TotalNetAmountTransactions: 1500
168
168
  * },
169
169
  * PaypointLegalname: "Gruzya Adventure Outfitters, LLC",
170
170
  * PaypointDbaname: "Gruzya Adventure Outfitters",
@@ -1,11 +1,11 @@
1
1
  import type * as Payabli from "../index.mjs";
2
2
  export interface CustomerSummaryRecord {
3
3
  /** Number total of transactions or payments */
4
- numberofTransactions?: number | undefined;
4
+ NumberofTransactions?: number | undefined;
5
5
  /** List of more recent 5 transactions belonging to the customer */
6
- recentTransactions?: Payabli.TransactionQueryRecords[] | undefined;
6
+ RecentTransactions?: Payabli.TransactionQueryRecords[] | undefined;
7
7
  /** Total amount in transactions */
8
- totalAmountTransactions?: number | undefined;
8
+ TotalAmountTransactions?: number | undefined;
9
9
  /** Total net amount in transactions */
10
- totalNetAmountTransactions?: number | undefined;
10
+ TotalNetAmountTransactions?: number | undefined;
11
11
  }
@@ -13,7 +13,7 @@ export interface SubscriptionQueryRecords {
13
13
  Frequency?: string | undefined;
14
14
  /** The subscription's ID. */
15
15
  IdSub?: number | undefined;
16
- InvoiceData?: Payabli.BillData | undefined;
16
+ invoiceData?: Payabli.BillData | undefined;
17
17
  /** The last time the subscription was processed. */
18
18
  LastRun: string | null;
19
19
  /** The last date and time the subscription was updated. */
@@ -16,7 +16,7 @@ export interface TransactionQueryRecords {
16
16
  FeeAmount?: Payabli.FeeAmount | undefined;
17
17
  /** Internal identifier used for processing. */
18
18
  GatewayTransId?: string | undefined;
19
- InvoiceData?: Payabli.BillData | undefined;
19
+ invoiceData?: Payabli.BillData | undefined;
20
20
  /** Payment method used: card, ach, or wallet. */
21
21
  Method?: string | undefined;
22
22
  /** Net amount paid. */
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.0.142";
1
+ export declare const SDK_VERSION = "0.0.144";
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.0.142";
1
+ export const SDK_VERSION = "0.0.144";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@payabli/sdk-node",
3
- "version": "0.0.142",
3
+ "version": "0.0.144",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -1740,6 +1740,138 @@ await client.boarding.updateApplication(352, {});
1740
1740
  </dl>
1741
1741
 
1742
1742
 
1743
+ </dd>
1744
+ </dl>
1745
+ </details>
1746
+
1747
+ <details><summary><code>client.boarding.<a href="/src/api/resources/boarding/client/Client.ts">addServiceToPaypointFromApp</a>({ ...params }) -> Payabli.CreateApplicationFromPaypointResponse</code></summary>
1748
+ <dl>
1749
+ <dd>
1750
+
1751
+ #### 📝 Description
1752
+
1753
+ <dl>
1754
+ <dd>
1755
+
1756
+ <dl>
1757
+ <dd>
1758
+
1759
+ Creates a new boarding application linked to an existing paypoint as part of the multi-product boarding flow. Use this endpoint to add new services to a paypoint without creating a duplicate record. The system copies eligible business, contact, banking, and address data from the paypoint to the new application based on 1:1 field matching. The merchant only needs to provide fields that are specific to the new service. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
1760
+ </dd>
1761
+ </dl>
1762
+ </dd>
1763
+ </dl>
1764
+
1765
+ #### 🔌 Usage
1766
+
1767
+ <dl>
1768
+ <dd>
1769
+
1770
+ <dl>
1771
+ <dd>
1772
+
1773
+ ```typescript
1774
+ await client.boarding.addServiceToPaypointFromApp({
1775
+ paypointId: 123,
1776
+ templateId: 456,
1777
+ recipientEmail: "merchant@example.com",
1778
+ returnBoardingAccessInfoInLine: true,
1779
+ onCreate: ["submitApplication"]
1780
+ });
1781
+
1782
+ ```
1783
+ </dd>
1784
+ </dl>
1785
+ </dd>
1786
+ </dl>
1787
+
1788
+ #### ⚙️ Parameters
1789
+
1790
+ <dl>
1791
+ <dd>
1792
+
1793
+ <dl>
1794
+ <dd>
1795
+
1796
+ **request:** `Payabli.CreateApplicationFromPaypointRequest`
1797
+
1798
+ </dd>
1799
+ </dl>
1800
+
1801
+ <dl>
1802
+ <dd>
1803
+
1804
+ **requestOptions:** `BoardingClient.RequestOptions`
1805
+
1806
+ </dd>
1807
+ </dl>
1808
+ </dd>
1809
+ </dl>
1810
+
1811
+
1812
+ </dd>
1813
+ </dl>
1814
+ </details>
1815
+
1816
+ <details><summary><code>client.boarding.<a href="/src/api/resources/boarding/client/Client.ts">getApplicationsByPaypointId</a>(paypointId) -> Payabli.QueryBoardingAppsListResponse</code></summary>
1817
+ <dl>
1818
+ <dd>
1819
+
1820
+ #### 📝 Description
1821
+
1822
+ <dl>
1823
+ <dd>
1824
+
1825
+ <dl>
1826
+ <dd>
1827
+
1828
+ Returns all boarding applications associated with a specific paypoint, including those created through the multi-product boarding flow. Use this endpoint to track underwriting progress across multiple service additions or to build reporting views. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
1829
+ </dd>
1830
+ </dl>
1831
+ </dd>
1832
+ </dl>
1833
+
1834
+ #### 🔌 Usage
1835
+
1836
+ <dl>
1837
+ <dd>
1838
+
1839
+ <dl>
1840
+ <dd>
1841
+
1842
+ ```typescript
1843
+ await client.boarding.getApplicationsByPaypointId(12345);
1844
+
1845
+ ```
1846
+ </dd>
1847
+ </dl>
1848
+ </dd>
1849
+ </dl>
1850
+
1851
+ #### ⚙️ Parameters
1852
+
1853
+ <dl>
1854
+ <dd>
1855
+
1856
+ <dl>
1857
+ <dd>
1858
+
1859
+ **paypointId:** `number` — ID of the paypoint to retrieve applications for.
1860
+
1861
+ </dd>
1862
+ </dl>
1863
+
1864
+ <dl>
1865
+ <dd>
1866
+
1867
+ **requestOptions:** `BoardingClient.RequestOptions`
1868
+
1869
+ </dd>
1870
+ </dl>
1871
+ </dd>
1872
+ </dl>
1873
+
1874
+
1743
1875
  </dd>
1744
1876
  </dl>
1745
1877
  </details>
@@ -8507,7 +8639,11 @@ await client.moneyIn.voidv2("10-3ffa27df-b171-44e0-b251-e95fbfc7a723");
8507
8639
  <dl>
8508
8640
  <dd>
8509
8641
 
8510
- Authorizes transaction for payout. If you don't pass the `autoCapture` field with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use `referenceId` returned in the response to capture the transaction.
8642
+ Authorizes a transaction for payout.
8643
+
8644
+ If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.
8645
+
8646
+ When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
8511
8647
  </dd>
8512
8648
  </dl>
8513
8649
  </dd>