@payabli/sdk-node 0.0.141 → 0.0.142

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 (111) hide show
  1. package/README.md +11 -15
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/Client.d.ts +3 -0
  4. package/dist/cjs/Client.js +41 -36
  5. package/dist/cjs/api/resources/cloud/client/Client.d.ts +4 -0
  6. package/dist/cjs/api/resources/cloud/client/Client.js +4 -0
  7. package/dist/cjs/api/resources/index.d.ts +3 -0
  8. package/dist/cjs/api/resources/index.js +4 -1
  9. package/dist/cjs/api/resources/management/client/Client.d.ts +41 -0
  10. package/dist/cjs/api/resources/management/client/Client.js +131 -0
  11. package/dist/cjs/api/resources/management/client/index.d.ts +1 -0
  12. package/dist/cjs/api/resources/management/client/index.js +17 -0
  13. package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.ts +25 -0
  14. package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.js +3 -0
  15. package/dist/cjs/api/resources/management/client/requests/index.d.ts +1 -0
  16. package/dist/cjs/api/resources/management/client/requests/index.js +2 -0
  17. package/dist/cjs/api/resources/management/exports.d.ts +2 -0
  18. package/dist/cjs/api/resources/management/exports.js +21 -0
  19. package/dist/cjs/api/resources/management/index.d.ts +2 -0
  20. package/dist/cjs/api/resources/management/index.js +18 -0
  21. package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.d.ts +31 -0
  22. package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.js +3 -0
  23. package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.d.ts +9 -0
  24. package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.js +3 -0
  25. package/dist/cjs/api/resources/management/types/index.d.ts +2 -0
  26. package/dist/cjs/api/resources/management/types/index.js +18 -0
  27. package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +1 -1
  28. package/dist/cjs/api/resources/moneyIn/client/Client.js +1 -1
  29. package/dist/cjs/api/resources/moneyIn/types/TransactionDetailPaymentData.d.ts +1 -1
  30. package/dist/cjs/api/resources/query/client/Client.d.ts +42 -0
  31. package/dist/cjs/api/resources/query/client/Client.js +140 -0
  32. package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.d.ts +113 -0
  33. package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.js +3 -0
  34. package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.d.ts +113 -0
  35. package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.js +3 -0
  36. package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts +1 -0
  37. package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts +1 -0
  38. package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
  39. package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.d.ts +50 -0
  40. package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.js +3 -0
  41. package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.d.ts +45 -0
  42. package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.js +3 -0
  43. package/dist/cjs/api/resources/queryTypes/types/index.d.ts +2 -0
  44. package/dist/cjs/api/resources/queryTypes/types/index.js +2 -0
  45. package/dist/cjs/api/types/BinData.d.ts +4 -1
  46. package/dist/cjs/api/types/ProcessingSection.d.ts +5 -0
  47. package/dist/cjs/api/types/QueryChargebacksResponse.d.ts +10 -1
  48. package/dist/cjs/api/types/TemplateElement.d.ts +1 -0
  49. package/dist/cjs/api/types/VCardCardType.d.ts +6 -0
  50. package/dist/cjs/api/types/VCardCardType.js +3 -0
  51. package/dist/cjs/api/types/VCardRecord.d.ts +2 -0
  52. package/dist/cjs/api/types/index.d.ts +1 -0
  53. package/dist/cjs/api/types/index.js +1 -0
  54. package/dist/cjs/version.d.ts +1 -1
  55. package/dist/cjs/version.js +1 -1
  56. package/dist/esm/BaseClient.mjs +2 -2
  57. package/dist/esm/Client.d.mts +3 -0
  58. package/dist/esm/Client.mjs +5 -0
  59. package/dist/esm/api/resources/cloud/client/Client.d.mts +4 -0
  60. package/dist/esm/api/resources/cloud/client/Client.mjs +4 -0
  61. package/dist/esm/api/resources/index.d.mts +3 -0
  62. package/dist/esm/api/resources/index.mjs +3 -0
  63. package/dist/esm/api/resources/management/client/Client.d.mts +41 -0
  64. package/dist/esm/api/resources/management/client/Client.mjs +94 -0
  65. package/dist/esm/api/resources/management/client/index.d.mts +1 -0
  66. package/dist/esm/api/resources/management/client/index.mjs +1 -0
  67. package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.mts +25 -0
  68. package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.mjs +2 -0
  69. package/dist/esm/api/resources/management/client/requests/index.d.mts +1 -0
  70. package/dist/esm/api/resources/management/client/requests/index.mjs +1 -0
  71. package/dist/esm/api/resources/management/exports.d.mts +2 -0
  72. package/dist/esm/api/resources/management/exports.mjs +3 -0
  73. package/dist/esm/api/resources/management/index.d.mts +2 -0
  74. package/dist/esm/api/resources/management/index.mjs +2 -0
  75. package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.d.mts +31 -0
  76. package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.mjs +2 -0
  77. package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.d.mts +9 -0
  78. package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.mjs +2 -0
  79. package/dist/esm/api/resources/management/types/index.d.mts +2 -0
  80. package/dist/esm/api/resources/management/types/index.mjs +2 -0
  81. package/dist/esm/api/resources/moneyIn/client/Client.d.mts +1 -1
  82. package/dist/esm/api/resources/moneyIn/client/Client.mjs +1 -1
  83. package/dist/esm/api/resources/moneyIn/types/TransactionDetailPaymentData.d.mts +1 -1
  84. package/dist/esm/api/resources/query/client/Client.d.mts +42 -0
  85. package/dist/esm/api/resources/query/client/Client.mjs +140 -0
  86. package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.d.mts +113 -0
  87. package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.mjs +2 -0
  88. package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.d.mts +113 -0
  89. package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.mjs +2 -0
  90. package/dist/esm/api/resources/query/client/requests/ListVcardsOrgRequest.d.mts +1 -0
  91. package/dist/esm/api/resources/query/client/requests/ListVcardsRequest.d.mts +1 -0
  92. package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
  93. package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.d.mts +50 -0
  94. package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.mjs +2 -0
  95. package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.d.mts +45 -0
  96. package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.mjs +2 -0
  97. package/dist/esm/api/resources/queryTypes/types/index.d.mts +2 -0
  98. package/dist/esm/api/resources/queryTypes/types/index.mjs +2 -0
  99. package/dist/esm/api/types/BinData.d.mts +4 -1
  100. package/dist/esm/api/types/ProcessingSection.d.mts +5 -0
  101. package/dist/esm/api/types/QueryChargebacksResponse.d.mts +10 -1
  102. package/dist/esm/api/types/TemplateElement.d.mts +1 -0
  103. package/dist/esm/api/types/VCardCardType.d.mts +6 -0
  104. package/dist/esm/api/types/VCardCardType.mjs +2 -0
  105. package/dist/esm/api/types/VCardRecord.d.mts +2 -0
  106. package/dist/esm/api/types/index.d.mts +1 -0
  107. package/dist/esm/api/types/index.mjs +1 -0
  108. package/dist/esm/version.d.mts +1 -1
  109. package/dist/esm/version.mjs +1 -1
  110. package/package.json +12 -1
  111. package/reference.md +236 -1
@@ -0,0 +1,45 @@
1
+ import type * as Payabli from "../../../index.js";
2
+ /**
3
+ * Response body for queries about cloud devices.
4
+ *
5
+ * @example
6
+ * {
7
+ * Summary: {
8
+ * pageSize: 20,
9
+ * totalAmount: 0,
10
+ * totalNetAmount: 0,
11
+ * totalPages: 2,
12
+ * totalRecords: 28
13
+ * },
14
+ * Records: [{
15
+ * deviceId: "DEV-A1B2C3D4",
16
+ * idCloud: 142,
17
+ * description: "Front Counter Terminal",
18
+ * serialNumber: "SN-90210-XR",
19
+ * friendlyName: "Front Counter Terminal",
20
+ * make: "Ingenico",
21
+ * model: "LK2500",
22
+ * deviceType: 1,
23
+ * deviceStatus: 1,
24
+ * deviceOs: null,
25
+ * macAddress: "1A2B3C4D5E6F",
26
+ * lastHealthCheck: "2026-04-09T14:49:42Z",
27
+ * registrationCode: "REG-A1B2C3D4",
28
+ * activationAttempts: 0,
29
+ * activationCodeExpiry: "2026-04-09T14:49:42Z",
30
+ * createdAt: "2026-04-09T01:14:37Z",
31
+ * updatedAt: "2026-04-09T14:49:42Z",
32
+ * paypointId: 12345,
33
+ * paypointDba: "Gruzya Adventure Outfitters",
34
+ * paypointLegal: "Gruzya Adventure Outfitters, LLC",
35
+ * paypointEntry: "8cfec329267",
36
+ * externalPaypointId: "GRUZYA-01",
37
+ * parentOrgId: 100,
38
+ * parentOrgName: "Example Corp"
39
+ * }]
40
+ * }
41
+ */
42
+ export interface QueryDeviceResponse {
43
+ Summary: Payabli.QuerySummary;
44
+ Records: Payabli.DeviceQueryRecord[];
45
+ }
@@ -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,8 +1,10 @@
1
+ export * from "./DeviceQueryRecord.js";
1
2
  export * from "./LimitRecord.js";
2
3
  export * from "./ListOrganizationsResponse.js";
3
4
  export * from "./QueryBatchesDetailResponse.js";
4
5
  export * from "./QueryBatchesResponse.js";
5
6
  export * from "./QueryBatchesTransfer.js";
7
+ export * from "./QueryDeviceResponse.js";
6
8
  export * from "./QueryTransferDetailResponse.js";
7
9
  export * from "./QueryTransferResponse.js";
8
10
  export * from "./QueryTransferSummary.js";
@@ -14,11 +14,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./DeviceQueryRecord.js"), exports);
17
18
  __exportStar(require("./LimitRecord.js"), exports);
18
19
  __exportStar(require("./ListOrganizationsResponse.js"), exports);
19
20
  __exportStar(require("./QueryBatchesDetailResponse.js"), exports);
20
21
  __exportStar(require("./QueryBatchesResponse.js"), exports);
21
22
  __exportStar(require("./QueryBatchesTransfer.js"), exports);
23
+ __exportStar(require("./QueryDeviceResponse.js"), exports);
22
24
  __exportStar(require("./QueryTransferDetailResponse.js"), exports);
23
25
  __exportStar(require("./QueryTransferResponse.js"), exports);
24
26
  __exportStar(require("./QueryTransferSummary.js"), exports);
@@ -46,7 +46,10 @@ export interface BinData {
46
46
  * Discover.
47
47
  */
48
48
  binCardBrand?: string | undefined;
49
- /** The type of card: Credit or Debit. */
49
+ /**
50
+ * The type of card: `Credit` or `Debit`. Case can vary between
51
+ * processors, so compare this value case-insensitively.
52
+ */
50
53
  binCardType?: string | undefined;
51
54
  /** The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked `PREPAID`. */
52
55
  binCardCategory?: string | undefined;
@@ -15,4 +15,9 @@ export interface ProcessingSection {
15
15
  whenDelivered?: Payabli.TemplateElement | undefined;
16
16
  whenProvided?: Payabli.TemplateElement | undefined;
17
17
  whenRefunded?: Payabli.TemplateElement | undefined;
18
+ CombinedBatches?: Payabli.TemplateElement | undefined;
19
+ payoutAverageMonthlyVolume?: Payabli.TemplateElement | undefined;
20
+ payoutHighTicketAmount?: Payabli.TemplateElement | undefined;
21
+ payoutAverageTicketAmount?: Payabli.TemplateElement | undefined;
22
+ payoutCreditLimit?: Payabli.TemplateElement | undefined;
18
23
  }
@@ -51,7 +51,16 @@ export declare namespace QueryChargebacksResponse {
51
51
  Responses?: string | undefined;
52
52
  /** Reference for any scheduled transactions. */
53
53
  ScheduleReference?: number | undefined;
54
- /** Status of the transaction. */
54
+ /**
55
+ * Status of the chargeback or ACH return.
56
+ *
57
+ * - 0: Open (chargebacks only)
58
+ * - 1: Pending (chargebacks only)
59
+ * - 2: ClosedWon (chargebacks only)
60
+ * - 3: ClosedLost (chargebacks only)
61
+ * - 4: ACH return (any Nacha return code except R29)
62
+ * - 5: AchDispute (R29 only — debit block)
63
+ */
55
64
  Status?: number | undefined;
56
65
  Transaction?: Payabli.TransactionQueryRecords | undefined;
57
66
  TransactionTime?: Payabli.TransactionTime | undefined;
@@ -5,4 +5,5 @@ export interface TemplateElement {
5
5
  readOnly?: Payabli.ReadOnly | undefined;
6
6
  value?: Payabli.ValueTemplates | undefined;
7
7
  visible?: Payabli.Visible | undefined;
8
+ required?: Payabli.RequiredElement | undefined;
8
9
  }
@@ -0,0 +1,6 @@
1
+ /**
2
+ * The type of virtual card:
3
+ * - Single-use virtual card: 0
4
+ * - Ghost card: 2
5
+ */
6
+ export type VCardCardType = number;
@@ -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 });
@@ -3,6 +3,7 @@ import type * as Payabli from "../index.js";
3
3
  * @example
4
4
  * {
5
5
  * vcardSent: true,
6
+ * cardType: 0,
6
7
  * cardToken: "vcrd_5Ty8NrBzXjKuqHm9DwElfP",
7
8
  * cardNumber: "44XX XXXX XXXX 1234",
8
9
  * cvc: "XXX",
@@ -43,6 +44,7 @@ import type * as Payabli from "../index.js";
43
44
  export interface VCardRecord {
44
45
  /** When `true`, the vCard has been sent. */
45
46
  vcardSent?: boolean | undefined;
47
+ cardType?: Payabli.VCardCardType | undefined;
46
48
  cardToken?: string | undefined;
47
49
  /** The vCard number. */
48
50
  cardNumber?: string | undefined;
@@ -562,6 +562,7 @@ export * from "./UserQueryRecord.js";
562
562
  export * from "./UsrAccess.js";
563
563
  export * from "./UsrStatus.js";
564
564
  export * from "./ValueTemplates.js";
565
+ export * from "./VCardCardType.js";
565
566
  export * from "./VCardQueryResponse.js";
566
567
  export * from "./VCardRecord.js";
567
568
  export * from "./VCardSummary.js";
@@ -578,6 +578,7 @@ __exportStar(require("./UserQueryRecord.js"), exports);
578
578
  __exportStar(require("./UsrAccess.js"), exports);
579
579
  __exportStar(require("./UsrStatus.js"), exports);
580
580
  __exportStar(require("./ValueTemplates.js"), exports);
581
+ __exportStar(require("./VCardCardType.js"), exports);
581
582
  __exportStar(require("./VCardQueryResponse.js"), exports);
582
583
  __exportStar(require("./VCardRecord.js"), exports);
583
584
  __exportStar(require("./VCardSummary.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.0.141";
1
+ export declare const SDK_VERSION = "0.0.142";
@@ -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.141";
4
+ exports.SDK_VERSION = "0.0.142";
@@ -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.141",
10
- "User-Agent": "@payabli/sdk-node/0.0.141",
9
+ "X-Fern-SDK-Version": "0.0.142",
10
+ "User-Agent": "@payabli/sdk-node/0.0.142",
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);
@@ -10,6 +10,7 @@ import { HostedPaymentPagesClient } from "./api/resources/hostedPaymentPages/cli
10
10
  import { ImportClient } from "./api/resources/import/client/Client.mjs";
11
11
  import { InvoiceClient } from "./api/resources/invoice/client/Client.mjs";
12
12
  import { LineItemClient } from "./api/resources/lineItem/client/Client.mjs";
13
+ import { ManagementClient } from "./api/resources/management/client/Client.mjs";
13
14
  import { MoneyInClient } from "./api/resources/moneyIn/client/Client.mjs";
14
15
  import { MoneyOutClient } from "./api/resources/moneyOut/client/Client.mjs";
15
16
  import { NotificationClient } from "./api/resources/notification/client/Client.mjs";
@@ -50,6 +51,7 @@ export declare class PayabliClient {
50
51
  protected _import: ImportClient | undefined;
51
52
  protected _invoice: InvoiceClient | undefined;
52
53
  protected _lineItem: LineItemClient | undefined;
54
+ protected _management: ManagementClient | undefined;
53
55
  protected _moneyIn: MoneyInClient | undefined;
54
56
  protected _moneyOut: MoneyOutClient | undefined;
55
57
  protected _notification: NotificationClient | undefined;
@@ -81,6 +83,7 @@ export declare class PayabliClient {
81
83
  get import(): ImportClient;
82
84
  get invoice(): InvoiceClient;
83
85
  get lineItem(): LineItemClient;
86
+ get management(): ManagementClient;
84
87
  get moneyIn(): MoneyInClient;
85
88
  get moneyOut(): MoneyOutClient;
86
89
  get notification(): NotificationClient;
@@ -20,6 +20,7 @@ import { HostedPaymentPagesClient } from "./api/resources/hostedPaymentPages/cli
20
20
  import { ImportClient } from "./api/resources/import/client/Client.mjs";
21
21
  import { InvoiceClient } from "./api/resources/invoice/client/Client.mjs";
22
22
  import { LineItemClient } from "./api/resources/lineItem/client/Client.mjs";
23
+ import { ManagementClient } from "./api/resources/management/client/Client.mjs";
23
24
  import { MoneyInClient } from "./api/resources/moneyIn/client/Client.mjs";
24
25
  import { MoneyOutClient } from "./api/resources/moneyOut/client/Client.mjs";
25
26
  import { NotificationClient } from "./api/resources/notification/client/Client.mjs";
@@ -92,6 +93,10 @@ export class PayabliClient {
92
93
  var _a;
93
94
  return ((_a = this._lineItem) !== null && _a !== void 0 ? _a : (this._lineItem = new LineItemClient(this._options)));
94
95
  }
96
+ get management() {
97
+ var _a;
98
+ return ((_a = this._management) !== null && _a !== void 0 ? _a : (this._management = new ManagementClient(this._options)));
99
+ }
95
100
  get moneyIn() {
96
101
  var _a;
97
102
  return ((_a = this._moneyIn) !== null && _a !== void 0 ? _a : (this._moneyIn = new MoneyInClient(this._options)));
@@ -48,6 +48,10 @@ export declare class CloudClient {
48
48
  historyDevice(entry: string, deviceId: string, requestOptions?: CloudClient.RequestOptions): core.HttpResponsePromise<Payabli.CloudQueryApiResponse>;
49
49
  private __historyDevice;
50
50
  /**
51
+ * @deprecated
52
+ *
53
+ * Use [List devices by paypoint](/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint) instead, which supports filters, sorting, and pagination.
54
+ *
51
55
  * Get a list of cloud devices registered to an entrypoint.
52
56
  *
53
57
  * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
@@ -154,6 +154,10 @@ export class CloudClient {
154
154
  });
155
155
  }
156
156
  /**
157
+ * @deprecated
158
+ *
159
+ * Use [List devices by paypoint](/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint) instead, which supports filters, sorting, and pagination.
160
+ *
157
161
  * Get a list of cloud devices registered to an entrypoint.
158
162
  *
159
163
  * @param {string} entry - The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
@@ -31,6 +31,9 @@ export * from "./invoice/types/index.mjs";
31
31
  export * from "./lineItem/client/requests/index.mjs";
32
32
  export * as lineItem from "./lineItem/index.mjs";
33
33
  export * from "./lineItem/types/index.mjs";
34
+ export * from "./management/client/requests/index.mjs";
35
+ export * as management from "./management/index.mjs";
36
+ export * from "./management/types/index.mjs";
34
37
  export * from "./moneyIn/client/requests/index.mjs";
35
38
  export * from "./moneyIn/errors/index.mjs";
36
39
  export * as moneyIn from "./moneyIn/index.mjs";
@@ -31,6 +31,9 @@ export * from "./invoice/types/index.mjs";
31
31
  export * from "./lineItem/client/requests/index.mjs";
32
32
  export * as lineItem from "./lineItem/index.mjs";
33
33
  export * from "./lineItem/types/index.mjs";
34
+ export * from "./management/client/requests/index.mjs";
35
+ export * as management from "./management/index.mjs";
36
+ export * from "./management/types/index.mjs";
34
37
  export * from "./moneyIn/client/requests/index.mjs";
35
38
  export * from "./moneyIn/errors/index.mjs";
36
39
  export * as moneyIn from "./moneyIn/index.mjs";
@@ -0,0 +1,41 @@
1
+ import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
2
+ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
3
+ import * as core from "../../../../core/index.mjs";
4
+ import * as Payabli from "../../../index.mjs";
5
+ export declare namespace ManagementClient {
6
+ type Options = BaseClientOptions;
7
+ interface RequestOptions extends BaseRequestOptions {
8
+ }
9
+ }
10
+ export declare class ManagementClient {
11
+ protected readonly _options: NormalizedClientOptionsWithAuth<ManagementClient.Options>;
12
+ constructor(options?: ManagementClient.Options);
13
+ /**
14
+ * Verifies a bank account and returns detailed verification results from the verification network, including bank name, account status, and response codes. Unlike a pass/fail verification, this endpoint returns granular data to support decision-making and troubleshooting.
15
+ *
16
+ * When bank authentication is enabled for the paypoint's organization, the endpoint performs an identity verification check on the account holder. Otherwise, it performs an account existence check. When bank authentication is enabled, the `accountHolderType` and `holderName` fields are required.
17
+ *
18
+ * Requires `inboundpayments_create` or `outboundpayments_create` permission.
19
+ *
20
+ * @param {string} entry - The paypoint's entry name identifier.
21
+ * @param {Payabli.VerifyAccountDetailsRequest} request
22
+ * @param {ManagementClient.RequestOptions} requestOptions - Request-specific configuration.
23
+ *
24
+ * @throws {@link Payabli.BadRequestError}
25
+ * @throws {@link Payabli.UnauthorizedError}
26
+ * @throws {@link Payabli.InternalServerError}
27
+ * @throws {@link Payabli.ServiceUnavailableError}
28
+ *
29
+ * @example
30
+ * await client.management.verifyAccountDetails("entry752", {
31
+ * routingNumber: "122105278",
32
+ * accountNumber: "0000000016",
33
+ * accountType: "Checking",
34
+ * country: "US",
35
+ * accountHolderType: "personal",
36
+ * holderName: "Jane Doe"
37
+ * })
38
+ */
39
+ verifyAccountDetails(entry: string, request: Payabli.VerifyAccountDetailsRequest, requestOptions?: ManagementClient.RequestOptions): core.HttpResponsePromise<Payabli.VerifyAccountDetailsResponse>;
40
+ private __verifyAccountDetails;
41
+ }
@@ -0,0 +1,94 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
12
+ import { mergeHeaders } from "../../../../core/headers.mjs";
13
+ import * as core from "../../../../core/index.mjs";
14
+ import * as environments from "../../../../environments.mjs";
15
+ import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
16
+ import * as errors from "../../../../errors/index.mjs";
17
+ import * as Payabli from "../../../index.mjs";
18
+ export class ManagementClient {
19
+ constructor(options = {}) {
20
+ this._options = normalizeClientOptionsWithAuth(options);
21
+ }
22
+ /**
23
+ * Verifies a bank account and returns detailed verification results from the verification network, including bank name, account status, and response codes. Unlike a pass/fail verification, this endpoint returns granular data to support decision-making and troubleshooting.
24
+ *
25
+ * When bank authentication is enabled for the paypoint's organization, the endpoint performs an identity verification check on the account holder. Otherwise, it performs an account existence check. When bank authentication is enabled, the `accountHolderType` and `holderName` fields are required.
26
+ *
27
+ * Requires `inboundpayments_create` or `outboundpayments_create` permission.
28
+ *
29
+ * @param {string} entry - The paypoint's entry name identifier.
30
+ * @param {Payabli.VerifyAccountDetailsRequest} request
31
+ * @param {ManagementClient.RequestOptions} requestOptions - Request-specific configuration.
32
+ *
33
+ * @throws {@link Payabli.BadRequestError}
34
+ * @throws {@link Payabli.UnauthorizedError}
35
+ * @throws {@link Payabli.InternalServerError}
36
+ * @throws {@link Payabli.ServiceUnavailableError}
37
+ *
38
+ * @example
39
+ * await client.management.verifyAccountDetails("entry752", {
40
+ * routingNumber: "122105278",
41
+ * accountNumber: "0000000016",
42
+ * accountType: "Checking",
43
+ * country: "US",
44
+ * accountHolderType: "personal",
45
+ * holderName: "Jane Doe"
46
+ * })
47
+ */
48
+ verifyAccountDetails(entry, request, requestOptions) {
49
+ return core.HttpResponsePromise.fromPromise(this.__verifyAccountDetails(entry, request, requestOptions));
50
+ }
51
+ __verifyAccountDetails(entry, request, requestOptions) {
52
+ return __awaiter(this, void 0, void 0, function* () {
53
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
54
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
55
+ 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);
56
+ const _response = yield core.fetcher({
57
+ 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, `Management/verifyAccountDetails/${core.url.encodePathParam(entry)}`),
58
+ method: "POST",
59
+ headers: _headers,
60
+ contentType: "application/json",
61
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
62
+ requestType: "json",
63
+ body: request,
64
+ 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,
65
+ 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,
66
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
67
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
68
+ logging: this._options.logging,
69
+ });
70
+ if (_response.ok) {
71
+ return { data: _response.body, rawResponse: _response.rawResponse };
72
+ }
73
+ if (_response.error.reason === "status-code") {
74
+ switch (_response.error.statusCode) {
75
+ case 400:
76
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
77
+ case 401:
78
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
79
+ case 500:
80
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
81
+ case 503:
82
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
83
+ default:
84
+ throw new errors.PayabliError({
85
+ statusCode: _response.error.statusCode,
86
+ body: _response.error.body,
87
+ rawResponse: _response.rawResponse,
88
+ });
89
+ }
90
+ }
91
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/Management/verifyAccountDetails/{entry}");
92
+ });
93
+ }
94
+ }
@@ -0,0 +1 @@
1
+ export * from "./requests/index.mjs";
@@ -0,0 +1 @@
1
+ export * from "./requests/index.mjs";
@@ -0,0 +1,25 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * routingNumber: "122105278",
5
+ * accountNumber: "0000000016",
6
+ * accountType: "Checking",
7
+ * country: "US",
8
+ * accountHolderType: "personal",
9
+ * holderName: "Jane Doe"
10
+ * }
11
+ */
12
+ export interface VerifyAccountDetailsRequest {
13
+ /** The bank routing number to verify. */
14
+ routingNumber: string;
15
+ /** The bank account number to verify. */
16
+ accountNumber: string;
17
+ /** The type of bank account, such as `Checking` or `Savings`. */
18
+ accountType?: string;
19
+ /** The ISO country code for the bank account, such as `US`. */
20
+ country?: string;
21
+ /** The type of account holder. Accepted values are `personal` or `business`. Required when bank authentication is enabled for the paypoint's organization. */
22
+ accountHolderType?: string;
23
+ /** The name of the bank account holder. For personal accounts, provide the holder's full name (for example, `Jane Doe`); the value is split on the first space into first and last name. For business accounts, provide the legal business name. Required when bank authentication is enabled for the paypoint's organization. */
24
+ holderName?: string;
25
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1 @@
1
+ export type { VerifyAccountDetailsRequest } from "./VerifyAccountDetailsRequest.mjs";
@@ -0,0 +1,2 @@
1
+ export { ManagementClient } from "./client/Client.mjs";
2
+ export * from "./client/index.mjs";
@@ -0,0 +1,3 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export { ManagementClient } from "./client/Client.mjs";
3
+ export * from "./client/index.mjs";
@@ -0,0 +1,2 @@
1
+ export * from "./client/index.mjs";
2
+ export * from "./types/index.mjs";
@@ -0,0 +1,2 @@
1
+ export * from "./client/index.mjs";
2
+ export * from "./types/index.mjs";
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Detailed bank account verification results from the verification network.
3
+ */
4
+ export interface BankAccountVerificationDetailsResponse {
5
+ /** The ABA routing number that was verified. */
6
+ aba?: string | undefined;
7
+ /** The account number that was verified. */
8
+ accountNumber?: string | undefined;
9
+ /** Whether the bank account passed verification. */
10
+ isValid: boolean;
11
+ /** Error message if the verification request failed. */
12
+ errorMessage?: string | undefined;
13
+ /** Overall verification outcome. Possible values include `Pass`, `Verified`, `Declined`, `NoData`, `Bypassed`, and `Error`. */
14
+ verificationResponse?: string | undefined;
15
+ /** Response code returned by the verification network. */
16
+ responseCode?: string | undefined;
17
+ /** Response value associated with the verification outcome. */
18
+ responseValue?: string | undefined;
19
+ /** Human-readable description of the verification outcome. */
20
+ responseDescription?: string | undefined;
21
+ /** Name of the bank associated with the routing number. */
22
+ bankName?: string | undefined;
23
+ /** Account type as reported by the verification network, such as `Checking` or `Savings`. */
24
+ reportedAccountType?: string | undefined;
25
+ /** Date the account was first seen by the verification network (ISO 8601 format). */
26
+ accountAddedDate?: string | undefined;
27
+ /** Date the account record was last updated in the verification network (ISO 8601 format). */
28
+ accountLastUpdatedDate?: string | undefined;
29
+ /** Date the account was closed, if applicable (ISO 8601 format). */
30
+ accountClosedDate?: string | undefined;
31
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ import type * as Payabli from "../../../index.mjs";
2
+ /**
3
+ * Response wrapper for the bank account verification details endpoint.
4
+ */
5
+ export interface VerifyAccountDetailsResponse {
6
+ isSuccess?: Payabli.IsSuccess | undefined;
7
+ responseText: Payabli.ResponseText;
8
+ responseData?: Payabli.BankAccountVerificationDetailsResponse | undefined;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,2 @@
1
+ export * from "./BankAccountVerificationDetailsResponse.mjs";
2
+ export * from "./VerifyAccountDetailsResponse.mjs";
@@ -0,0 +1,2 @@
1
+ export * from "./BankAccountVerificationDetailsResponse.mjs";
2
+ export * from "./VerifyAccountDetailsResponse.mjs";
@@ -389,7 +389,7 @@ export declare class MoneyInClient {
389
389
  getpaid(request: Payabli.RequestPayment, requestOptions?: MoneyInClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseGetPaid>;
390
390
  private __getpaid;
391
391
  /**
392
- * A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not.
392
+ * A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not. This endpoint only works on transactions made with the v1 API. For v2 transactions, check the transaction's settlement status and call v2 void or v2 refund based on the result.
393
393
  *
394
394
  * @param {string} transId - ReferenceId for the transaction (PaymentId).
395
395
  * @param {number} amount -
@@ -684,7 +684,7 @@ export class MoneyInClient {
684
684
  });
685
685
  }
686
686
  /**
687
- * A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not.
687
+ * A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not. This endpoint only works on transactions made with the v1 API. For v2 transactions, check the transaction's settlement status and call v2 void or v2 refund based on the result.
688
688
  *
689
689
  * @param {string} transId - ReferenceId for the transaction (PaymentId).
690
690
  * @param {number} amount -
@@ -11,7 +11,7 @@ export interface TransactionDetailPaymentData {
11
11
  initiator: Payabli.Initiator | null;
12
12
  storedMethodUsageType: Payabli.StoredMethodUsageType | null;
13
13
  sequence: Payabli.Sequence | null;
14
- orderDescription: Payabli.Orderdescription;
14
+ orderDescription: Payabli.Orderdescription | null;
15
15
  accountId: Payabli.AccountId | null;
16
16
  signatureData: Payabli.Signaturedata | null;
17
17
  binData: Payabli.BinData | null;