@payabli/sdk-node 0.0.108 → 0.0.110

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 (136) hide show
  1. package/README.md +5 -1
  2. package/dist/cjs/Client.d.ts +2 -2
  3. package/dist/cjs/Client.js +2 -2
  4. package/dist/cjs/api/resources/bill/client/Client.d.ts +2 -2
  5. package/dist/cjs/api/resources/boarding/client/Client.d.ts +2 -2
  6. package/dist/cjs/api/resources/chargeBacks/client/Client.d.ts +2 -2
  7. package/dist/cjs/api/resources/chargeBacks/client/requests/ResponseChargeBack.d.ts +1 -2
  8. package/dist/cjs/api/resources/checkCapture/client/Client.d.ts +2 -2
  9. package/dist/cjs/api/resources/cloud/client/Client.d.ts +2 -2
  10. package/dist/cjs/api/resources/customer/client/Client.d.ts +2 -2
  11. package/dist/cjs/api/resources/export/client/Client.d.ts +2 -2
  12. package/dist/cjs/api/resources/hostedPaymentPages/client/Client.d.ts +2 -2
  13. package/dist/cjs/api/resources/import/client/Client.d.ts +2 -2
  14. package/dist/cjs/api/resources/invoice/client/Client.d.ts +2 -2
  15. package/dist/cjs/api/resources/lineItem/client/Client.d.ts +2 -2
  16. package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +2 -2
  17. package/dist/cjs/api/resources/moneyIn/errors/CaptureError.js +1 -1
  18. package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +8 -10
  19. package/dist/cjs/api/resources/moneyOut/client/Client.js +6 -8
  20. package/dist/cjs/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.ts +6 -8
  21. package/dist/cjs/api/resources/moneyOutTypes/types/AuthorizePaymentMethod.d.ts +30 -0
  22. package/dist/cjs/api/resources/moneyOutTypes/types/AuthorizePaymentMethod.js +5 -0
  23. package/dist/cjs/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.ts +3 -10
  24. package/dist/cjs/api/resources/moneyOutTypes/types/index.d.ts +1 -0
  25. package/dist/cjs/api/resources/moneyOutTypes/types/index.js +1 -0
  26. package/dist/cjs/api/resources/notification/client/Client.d.ts +2 -2
  27. package/dist/cjs/api/resources/ocr/client/Client.d.ts +2 -2
  28. package/dist/cjs/api/resources/organization/client/Client.d.ts +2 -2
  29. package/dist/cjs/api/resources/organization/client/requests/AddOrganizationRequest.d.ts +1 -2
  30. package/dist/cjs/api/resources/paymentLink/client/Client.d.ts +2 -2
  31. package/dist/cjs/api/resources/paymentMethodDomain/client/Client.d.ts +2 -2
  32. package/dist/cjs/api/resources/paypoint/client/Client.d.ts +2 -2
  33. package/dist/cjs/api/resources/query/client/Client.d.ts +2 -2
  34. package/dist/cjs/api/resources/query/client/requests/ListTransfersRequest.d.ts +3 -0
  35. package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts +0 -2
  36. package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts +0 -2
  37. package/dist/cjs/api/resources/queryTypes/types/ListOrganizationsResponse.d.ts +2 -2
  38. package/dist/cjs/api/resources/queryTypes/types/QueryBatchesDetailResponse.d.ts +7 -7
  39. package/dist/cjs/api/resources/queryTypes/types/QueryBatchesResponse.d.ts +10 -10
  40. package/dist/cjs/api/resources/queryTypes/types/QueryTransferDetailResponse.d.ts +72 -72
  41. package/dist/cjs/api/resources/queryTypes/types/QueryTransferResponse.d.ts +2 -2
  42. package/dist/cjs/api/resources/queryTypes/types/QueryTransferSummary.d.ts +23 -18
  43. package/dist/cjs/api/resources/statistic/client/Client.d.ts +2 -2
  44. package/dist/cjs/api/resources/subscription/client/Client.d.ts +2 -2
  45. package/dist/cjs/api/resources/templates/client/Client.d.ts +2 -2
  46. package/dist/cjs/api/resources/tokenStorage/client/Client.d.ts +2 -2
  47. package/dist/cjs/api/resources/user/client/Client.d.ts +2 -2
  48. package/dist/cjs/api/resources/vendor/client/Client.d.ts +2 -2
  49. package/dist/cjs/api/resources/wallet/client/Client.d.ts +2 -2
  50. package/dist/cjs/api/types/AdditionalData.d.ts +1 -1
  51. package/dist/cjs/api/types/BillDetailResponse.d.ts +1 -1
  52. package/dist/cjs/api/types/BillQueryRecord2.d.ts +37 -38
  53. package/dist/cjs/api/types/BillQueryResponse.d.ts +8 -8
  54. package/dist/cjs/api/types/IdempotencyKey.d.ts +1 -1
  55. package/dist/cjs/api/types/PaymentIdString.d.ts +7 -0
  56. package/dist/cjs/api/types/PaymentIdString.js +5 -0
  57. package/dist/cjs/api/types/Paymentid.d.ts +1 -1
  58. package/dist/cjs/api/types/QueryPayoutTransaction.d.ts +2 -2
  59. package/dist/cjs/api/types/TransactionOutQueryRecord.d.ts +1 -1
  60. package/dist/cjs/api/types/Transfer.d.ts +18 -6
  61. package/dist/cjs/api/types/TransferQueryResponse.d.ts +10 -6
  62. package/dist/cjs/api/types/index.d.ts +1 -0
  63. package/dist/cjs/api/types/index.js +1 -0
  64. package/dist/cjs/core/fetcher/Fetcher.d.ts +1 -1
  65. package/dist/cjs/core/fetcher/requestWithRetries.js +34 -2
  66. package/dist/cjs/core/headers.d.ts +2 -2
  67. package/dist/cjs/version.d.ts +1 -1
  68. package/dist/cjs/version.js +1 -1
  69. package/dist/esm/Client.d.mts +2 -2
  70. package/dist/esm/Client.mjs +2 -2
  71. package/dist/esm/api/resources/bill/client/Client.d.mts +2 -2
  72. package/dist/esm/api/resources/boarding/client/Client.d.mts +2 -2
  73. package/dist/esm/api/resources/chargeBacks/client/Client.d.mts +2 -2
  74. package/dist/esm/api/resources/chargeBacks/client/requests/ResponseChargeBack.d.mts +1 -2
  75. package/dist/esm/api/resources/checkCapture/client/Client.d.mts +2 -2
  76. package/dist/esm/api/resources/cloud/client/Client.d.mts +2 -2
  77. package/dist/esm/api/resources/customer/client/Client.d.mts +2 -2
  78. package/dist/esm/api/resources/export/client/Client.d.mts +2 -2
  79. package/dist/esm/api/resources/hostedPaymentPages/client/Client.d.mts +2 -2
  80. package/dist/esm/api/resources/import/client/Client.d.mts +2 -2
  81. package/dist/esm/api/resources/invoice/client/Client.d.mts +2 -2
  82. package/dist/esm/api/resources/lineItem/client/Client.d.mts +2 -2
  83. package/dist/esm/api/resources/moneyIn/client/Client.d.mts +2 -2
  84. package/dist/esm/api/resources/moneyIn/errors/CaptureError.mjs +1 -1
  85. package/dist/esm/api/resources/moneyOut/client/Client.d.mts +8 -10
  86. package/dist/esm/api/resources/moneyOut/client/Client.mjs +6 -8
  87. package/dist/esm/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.mts +6 -8
  88. package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePaymentMethod.d.mts +30 -0
  89. package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePaymentMethod.mjs +4 -0
  90. package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.mts +3 -10
  91. package/dist/esm/api/resources/moneyOutTypes/types/index.d.mts +1 -0
  92. package/dist/esm/api/resources/moneyOutTypes/types/index.mjs +1 -0
  93. package/dist/esm/api/resources/notification/client/Client.d.mts +2 -2
  94. package/dist/esm/api/resources/ocr/client/Client.d.mts +2 -2
  95. package/dist/esm/api/resources/organization/client/Client.d.mts +2 -2
  96. package/dist/esm/api/resources/organization/client/requests/AddOrganizationRequest.d.mts +1 -2
  97. package/dist/esm/api/resources/paymentLink/client/Client.d.mts +2 -2
  98. package/dist/esm/api/resources/paymentMethodDomain/client/Client.d.mts +2 -2
  99. package/dist/esm/api/resources/paypoint/client/Client.d.mts +2 -2
  100. package/dist/esm/api/resources/query/client/Client.d.mts +2 -2
  101. package/dist/esm/api/resources/query/client/requests/ListTransfersRequest.d.mts +3 -0
  102. package/dist/esm/api/resources/query/client/requests/ListVcardsOrgRequest.d.mts +0 -2
  103. package/dist/esm/api/resources/query/client/requests/ListVcardsRequest.d.mts +0 -2
  104. package/dist/esm/api/resources/queryTypes/types/ListOrganizationsResponse.d.mts +2 -2
  105. package/dist/esm/api/resources/queryTypes/types/QueryBatchesDetailResponse.d.mts +7 -7
  106. package/dist/esm/api/resources/queryTypes/types/QueryBatchesResponse.d.mts +10 -10
  107. package/dist/esm/api/resources/queryTypes/types/QueryTransferDetailResponse.d.mts +72 -72
  108. package/dist/esm/api/resources/queryTypes/types/QueryTransferResponse.d.mts +2 -2
  109. package/dist/esm/api/resources/queryTypes/types/QueryTransferSummary.d.mts +23 -18
  110. package/dist/esm/api/resources/statistic/client/Client.d.mts +2 -2
  111. package/dist/esm/api/resources/subscription/client/Client.d.mts +2 -2
  112. package/dist/esm/api/resources/templates/client/Client.d.mts +2 -2
  113. package/dist/esm/api/resources/tokenStorage/client/Client.d.mts +2 -2
  114. package/dist/esm/api/resources/user/client/Client.d.mts +2 -2
  115. package/dist/esm/api/resources/vendor/client/Client.d.mts +2 -2
  116. package/dist/esm/api/resources/wallet/client/Client.d.mts +2 -2
  117. package/dist/esm/api/types/AdditionalData.d.mts +1 -1
  118. package/dist/esm/api/types/BillDetailResponse.d.mts +1 -1
  119. package/dist/esm/api/types/BillQueryRecord2.d.mts +37 -38
  120. package/dist/esm/api/types/BillQueryResponse.d.mts +8 -8
  121. package/dist/esm/api/types/IdempotencyKey.d.mts +1 -1
  122. package/dist/esm/api/types/PaymentIdString.d.mts +7 -0
  123. package/dist/esm/api/types/PaymentIdString.mjs +4 -0
  124. package/dist/esm/api/types/Paymentid.d.mts +1 -1
  125. package/dist/esm/api/types/QueryPayoutTransaction.d.mts +2 -2
  126. package/dist/esm/api/types/TransactionOutQueryRecord.d.mts +1 -1
  127. package/dist/esm/api/types/Transfer.d.mts +18 -6
  128. package/dist/esm/api/types/TransferQueryResponse.d.mts +10 -6
  129. package/dist/esm/api/types/index.d.mts +1 -0
  130. package/dist/esm/api/types/index.mjs +1 -0
  131. package/dist/esm/core/fetcher/Fetcher.d.mts +1 -1
  132. package/dist/esm/core/fetcher/requestWithRetries.mjs +34 -2
  133. package/dist/esm/core/headers.d.mts +2 -2
  134. package/dist/esm/version.d.mts +1 -1
  135. package/dist/esm/version.mjs +1 -1
  136. package/package.json +1 -1
@@ -4,123 +4,123 @@
4
4
  import * as Payabli from "../../../index.mjs";
5
5
  export interface QueryTransferDetailResponse {
6
6
  /** List of transfer detail records */
7
- Records?: QueryTransferDetailResponse.Records.Item[];
7
+ Records: QueryTransferDetailResponse.Records.Item[];
8
8
  /** Summary of the transfer details query */
9
- Summary?: Payabli.QueryTransferSummary;
9
+ Summary: Payabli.QueryTransferSummary;
10
10
  }
11
11
  export declare namespace QueryTransferDetailResponse {
12
12
  type Records = Records.Item[];
13
13
  namespace Records {
14
14
  interface Item {
15
15
  /** Unique identifier for the transfer detail record */
16
- transferDetailId?: number;
16
+ transferDetailId: number | null;
17
17
  /** The ID of the transfer this detail belongs to */
18
- transferId?: number;
18
+ transferId: number | null;
19
19
  /** The transaction ID in Payabli's system */
20
- transactionId?: string;
20
+ transactionId: string | null;
21
21
  /** External transaction reference number */
22
- transactionNumber?: string;
22
+ transactionNumber: string | null;
23
23
  /** The transaction type (credit or debit) */
24
- type?: string;
24
+ type: string | null;
25
25
  /** A field used to categorize the transaction details. Values include: auth, decline, refund, adj, cb, split */
26
- category?: string;
26
+ category: string | null;
27
27
  /** The gross amount of the transaction */
28
- grossAmount?: number;
28
+ grossAmount: number | null;
29
29
  /** Chargeback amount deducted from transaction */
30
- chargeBackAmount?: number;
30
+ chargeBackAmount: number | null;
31
31
  /** ACH return amount deducted from transaction */
32
- returnedAmount?: number;
32
+ returnedAmount: number | null;
33
33
  /** Refund amount deducted from transaction */
34
- refundAmount?: number;
34
+ refundAmount: number | null;
35
35
  /** Amount being held for fraud or risk concerns */
36
- holdAmount?: number;
36
+ holdAmount: number | null;
37
37
  /** Previously held funds that have been released after a risk review */
38
- releasedAmount?: number;
38
+ releasedAmount: number | null;
39
39
  /** Charges applied for transactions and services */
40
- billingFeesAmount?: number;
40
+ billingFeesAmount: number | null;
41
41
  /** Payments captured in the batch cycle that are deposited separately. For example, checks or cash payments recorded in the batch but not deposited via Payabli, or card brands making a direct transfer in certain situations. */
42
- thirdPartyPaidAmount?: number;
42
+ thirdPartyPaidAmount: number | null;
43
43
  /** Corrections applied to Billing & Fees charges */
44
- adjustmentsAmount?: number;
44
+ adjustmentsAmount: number | null;
45
45
  /** The net amount after all deductions */
46
- netTransferAmount?: number;
46
+ netTransferAmount: number | null;
47
47
  /** Total amount directed to split funding destinations */
48
- splitFundingAmount?: number;
49
- billingFeesDetails?: Payabli.BillingFeeDetail[];
50
- ParentOrgName?: Payabli.OrgParentName;
51
- PaypointDbaname?: Payabli.Dbaname;
52
- PaypointLegalname?: Payabli.Legalname;
48
+ splitFundingAmount: number | null;
49
+ billingFeesDetails: Payabli.BillingFeeDetail[] | null;
50
+ ParentOrgName: Payabli.OrgParentName | null;
51
+ PaypointDbaname: Payabli.Dbaname | null;
52
+ PaypointLegalname: Payabli.Legalname | null;
53
53
  /** The paypoint's entryname */
54
- PaypointEntryname?: string;
54
+ PaypointEntryname: string | null;
55
55
  /** The transaction ID for the payment */
56
- PaymentTransId?: string;
56
+ PaymentTransId: string | null;
57
57
  /** The payment connector used to process the transaction */
58
- ConnectorName?: string;
59
- ExternalProcessorInformation?: Payabli.ExternalProcessorInformation;
58
+ ConnectorName: string | null;
59
+ ExternalProcessorInformation: Payabli.ExternalProcessorInformation | null;
60
60
  /** Internal identifier used for processing */
61
- GatewayTransId?: string;
62
- OrderId?: Payabli.OrderId;
61
+ GatewayTransId: string | null;
62
+ OrderId: Payabli.OrderId | null;
63
63
  /** Payment method used: card, ach, or wallet */
64
- Method?: string;
65
- BatchNumber?: Payabli.BatchNumber;
64
+ Method: string | null;
65
+ BatchNumber: Payabli.BatchNumber | null;
66
66
  /** The amount of the batch */
67
- BatchAmount?: number;
67
+ BatchAmount: number | null;
68
68
  /** Unique ID for customer linked to the transaction */
69
- PayorId?: Payabli.PayorId;
70
- PaymentData?: Payabli.QueryPaymentData;
69
+ PayorId: Payabli.PayorId | null;
70
+ PaymentData: Payabli.QueryPaymentData | null;
71
71
  /**
72
72
  * Status of transaction. See [the
73
73
  * docs](/developers/references/money-in-statuses#money-in-transaction-status) for a
74
74
  * full reference.
75
75
  */
76
- TransStatus?: number;
77
- PaypointId?: Payabli.PaypointId;
76
+ TransStatus: number | null;
77
+ PaypointId: Payabli.PaypointId | null;
78
78
  /** Transaction total amount (including service fee or sub-charge) */
79
- TotalAmount?: number;
79
+ TotalAmount: number | null;
80
80
  /** Net amount paid */
81
- NetAmount?: Payabli.Netamountnullable | undefined;
82
- FeeAmount?: Payabli.FeeAmount;
81
+ NetAmount: (Payabli.Netamountnullable | undefined) | null;
82
+ FeeAmount: Payabli.FeeAmount | null;
83
83
  /** Settlement status for transaction. See [the docs](/developers/references/money-in-statuses#payment-funding-status) for a full reference. */
84
- SettlementStatus?: number;
85
- Operation?: Payabli.Operation;
86
- ResponseData?: Payabli.QueryResponseData;
87
- Source?: Payabli.Source;
84
+ SettlementStatus: number | null;
85
+ Operation: Payabli.Operation | null;
86
+ ResponseData: Payabli.QueryResponseData | null;
87
+ Source: Payabli.Source | null;
88
88
  /** Reference to the subscription or schedule that originated the transaction */
89
- ScheduleReference?: number;
90
- OrgId?: Payabli.Orgid;
91
- RefundId?: Payabli.RefundId;
92
- ReturnedId?: Payabli.ReturnedId;
93
- ChargebackId?: Payabli.ChargebackId;
94
- RetrievalId?: Payabli.RetrievalId;
89
+ ScheduleReference: number | null;
90
+ OrgId: Payabli.Orgid | null;
91
+ RefundId: Payabli.RefundId | null;
92
+ ReturnedId: Payabli.ReturnedId | null;
93
+ ChargebackId: Payabli.ChargebackId | null;
94
+ RetrievalId: Payabli.RetrievalId | null;
95
95
  /** Additional transaction data */
96
- TransAdditionalData?: unknown;
96
+ TransAdditionalData: unknown | null;
97
97
  /** Associated invoice data */
98
- invoiceData?: Payabli.BillData;
99
- EntrypageId?: Payabli.EntrypageId;
100
- externalPaypointID?: Payabli.ExternalPaypointId;
98
+ invoiceData: Payabli.BillData | null;
99
+ EntrypageId: Payabli.EntrypageId | null;
100
+ externalPaypointID: Payabli.ExternalPaypointId | null;
101
101
  /** Indicates whether the ACH account has been validated */
102
- IsValidatedACH?: boolean;
102
+ IsValidatedACH: boolean | null;
103
103
  /** Transaction date and time, in UTC */
104
- TransactionTime?: Payabli.DatetimeNullable | undefined;
105
- Customer?: Payabli.QueryTransactionPayorData;
106
- splitFundingInstructions?: Payabli.SplitFunding | undefined;
107
- CfeeTransactions?: Payabli.QueryCFeeTransaction[];
108
- TransactionEvents?: Payabli.QueryTransactionEvents[];
109
- PendingFeeAmount?: Payabli.PendingFeeAmount | undefined;
110
- RiskFlagged?: Payabli.RiskFlagged | undefined;
111
- RiskFlaggedOn?: Payabli.RiskFlaggedOn | undefined;
112
- RiskStatus?: Payabli.RiskStatus;
113
- RiskReason?: Payabli.RiskReason;
114
- RiskAction?: Payabli.RiskAction;
115
- RiskActionCode?: Payabli.RiskActionCode | undefined;
116
- DeviceId?: Payabli.DeviceId | undefined;
117
- AchSecCode?: Payabli.AchSecCode;
118
- AchHolderType?: Payabli.AchHolderType;
119
- IpAddress?: Payabli.IpAddress;
104
+ TransactionTime: (Payabli.DatetimeNullable | undefined) | null;
105
+ Customer: Payabli.QueryTransactionPayorData | null;
106
+ splitFundingInstructions: (Payabli.SplitFunding | undefined) | null;
107
+ CfeeTransactions: Payabli.QueryCFeeTransaction[] | null;
108
+ TransactionEvents: Payabli.QueryTransactionEvents[] | null;
109
+ PendingFeeAmount: (Payabli.PendingFeeAmount | undefined) | null;
110
+ RiskFlagged: (Payabli.RiskFlagged | undefined) | null;
111
+ RiskFlaggedOn: (Payabli.RiskFlaggedOn | undefined) | null;
112
+ RiskStatus: Payabli.RiskStatus | null;
113
+ RiskReason: Payabli.RiskReason | null;
114
+ RiskAction: Payabli.RiskAction | null;
115
+ RiskActionCode: (Payabli.RiskActionCode | undefined) | null;
116
+ DeviceId: (Payabli.DeviceId | undefined) | null;
117
+ AchSecCode: Payabli.AchSecCode | null;
118
+ AchHolderType: Payabli.AchHolderType | null;
119
+ IpAddress: Payabli.IpAddress | null;
120
120
  /** Indicates if this was a same-day ACH transaction. */
121
- IsSameDayACH?: boolean;
121
+ IsSameDayACH: boolean | null;
122
122
  /** Type of wallet used for the transaction (if applicable) */
123
- WalletType?: string;
123
+ WalletType: string | null;
124
124
  }
125
125
  }
126
126
  }
@@ -4,7 +4,7 @@
4
4
  import * as Payabli from "../../../index.mjs";
5
5
  export interface QueryTransferResponse {
6
6
  /** Summary information about the transfers. */
7
- Summary?: Payabli.QueryTransferSummary;
7
+ Summary: Payabli.QueryTransferSummary;
8
8
  /** List of transfer transaction records. */
9
- Records?: Payabli.TransactionQueryRecords[];
9
+ Records: Payabli.TransactionQueryRecords[];
10
10
  }
@@ -4,39 +4,44 @@
4
4
  import * as Payabli from "../../../index.mjs";
5
5
  export interface QueryTransferSummary {
6
6
  /** ACH returns deducted from the batch. */
7
- achReturns?: number;
7
+ achReturns: number | null;
8
8
  /** Corrections applied to Billing & Fees charges. */
9
- adjustments?: number;
9
+ adjustments: number | null;
10
10
  /** Charges applied for transactions and services. */
11
- billingFees?: number;
11
+ billingFees: number | null;
12
12
  /** Chargebacks deducted from batch. */
13
- chargebacks?: number;
13
+ chargebacks: number | null;
14
14
  /** The gross batch amount before deductions. */
15
- grossTransferAmount?: number;
15
+ grossTransferAmount: number | null;
16
16
  /** Previously held funds that have been released after a risk review. */
17
- releaseAmount?: number;
17
+ releaseAmount: number | null;
18
18
  /** Payments captured in the batch cycle that are deposited separately. For example, checks or cash payments recorded in the batch but not deposited via Payabli, or card brands making a direct transfer in certain situations. */
19
- thirdPartyPaid?: number;
19
+ thirdPartyPaid: number | null;
20
20
  /** The gross batch amount minus service fees. */
21
- totalNetAmountTransfer?: number;
21
+ totalNetAmountTransfer: number | null;
22
22
  /** Service fees are any pass-through fees charged to the customer at the time of payment. These aren't transferred to the merchant when the batch is transferred and funded. */
23
- serviceFees?: number;
23
+ serviceFees: number | null;
24
+ /**
25
+ * The net batch amount is the gross batch amount minus any returns, refunds,
26
+ * billing and fees items, chargebacks, adjustments, and third party payments.
27
+ */
28
+ netBatchAmount: number | null;
24
29
  /** The transfer amount is the net batch amount plus or minus any returns, refunds, billing and fees items, chargebacks, adjustments, and third party payments. This is the amount from the batch that is transferred to the merchant bank account. */
25
- transferAmount?: number;
30
+ transferAmount: number | null;
26
31
  /** Refunds deducted from batch. */
27
- refunds?: number;
32
+ refunds: number | null;
28
33
  /** Funds being held for fraud or risk concerns. */
29
- heldAmount?: number;
34
+ heldAmount: number | null;
30
35
  /** Number of records in the response. */
31
- totalRecords?: Payabli.Totalrecords;
36
+ totalRecords: Payabli.Totalrecords | null;
32
37
  /** The total sum of the transfers in the response. */
33
- totalAmount?: number;
38
+ totalAmount: number | null;
34
39
  /** The total sum of the transfers in the response. */
35
- totalNetAmount?: number;
40
+ totalNetAmount: number | null;
36
41
  /** Number of pages in the response. */
37
- totalPages?: Payabli.Totalpages;
42
+ totalPages: Payabli.Totalpages | null;
38
43
  /** Number of records per page. */
39
- pageSize?: Payabli.Pagesize;
44
+ pageSize: Payabli.Pagesize | null;
40
45
  /** Auxiliary validation used internally by payment pages and components. */
41
- pageidentifier?: Payabli.PageIdentifier;
46
+ pageidentifier: Payabli.PageIdentifier | null;
42
47
  }
@@ -11,7 +11,7 @@ export declare namespace Statistic {
11
11
  baseUrl?: core.Supplier<string>;
12
12
  apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
14
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
16
16
  interface RequestOptions {
17
17
  /** The maximum time to wait for a response in seconds. */
@@ -23,7 +23,7 @@ export declare namespace Statistic {
23
23
  /** Additional query string parameters to include in the request. */
24
24
  queryParams?: Record<string, unknown>;
25
25
  /** Additional headers to include in the request. */
26
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
26
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
27
  }
28
28
  }
29
29
  export declare class Statistic {
@@ -11,7 +11,7 @@ export declare namespace Subscription {
11
11
  baseUrl?: core.Supplier<string>;
12
12
  apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
14
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
16
16
  interface RequestOptions {
17
17
  /** The maximum time to wait for a response in seconds. */
@@ -23,7 +23,7 @@ export declare namespace Subscription {
23
23
  /** Additional query string parameters to include in the request. */
24
24
  queryParams?: Record<string, unknown>;
25
25
  /** Additional headers to include in the request. */
26
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
26
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
27
  }
28
28
  }
29
29
  export declare class Subscription {
@@ -11,7 +11,7 @@ export declare namespace Templates {
11
11
  baseUrl?: core.Supplier<string>;
12
12
  apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
14
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
16
16
  interface RequestOptions {
17
17
  /** The maximum time to wait for a response in seconds. */
@@ -23,7 +23,7 @@ export declare namespace Templates {
23
23
  /** Additional query string parameters to include in the request. */
24
24
  queryParams?: Record<string, unknown>;
25
25
  /** Additional headers to include in the request. */
26
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
26
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
27
  }
28
28
  }
29
29
  export declare class Templates {
@@ -11,7 +11,7 @@ export declare namespace TokenStorage {
11
11
  baseUrl?: core.Supplier<string>;
12
12
  apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
14
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
16
16
  interface RequestOptions {
17
17
  /** The maximum time to wait for a response in seconds. */
@@ -23,7 +23,7 @@ export declare namespace TokenStorage {
23
23
  /** Additional query string parameters to include in the request. */
24
24
  queryParams?: Record<string, unknown>;
25
25
  /** Additional headers to include in the request. */
26
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
26
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
27
  }
28
28
  }
29
29
  export declare class TokenStorage {
@@ -11,7 +11,7 @@ export declare namespace User {
11
11
  baseUrl?: core.Supplier<string>;
12
12
  apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
14
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
16
16
  interface RequestOptions {
17
17
  /** The maximum time to wait for a response in seconds. */
@@ -23,7 +23,7 @@ export declare namespace User {
23
23
  /** Additional query string parameters to include in the request. */
24
24
  queryParams?: Record<string, unknown>;
25
25
  /** Additional headers to include in the request. */
26
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
26
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
27
  }
28
28
  }
29
29
  export declare class User {
@@ -11,7 +11,7 @@ export declare namespace Vendor {
11
11
  baseUrl?: core.Supplier<string>;
12
12
  apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
14
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
16
16
  interface RequestOptions {
17
17
  /** The maximum time to wait for a response in seconds. */
@@ -23,7 +23,7 @@ export declare namespace Vendor {
23
23
  /** Additional query string parameters to include in the request. */
24
24
  queryParams?: Record<string, unknown>;
25
25
  /** Additional headers to include in the request. */
26
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
26
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
27
  }
28
28
  }
29
29
  export declare class Vendor {
@@ -11,7 +11,7 @@ export declare namespace Wallet {
11
11
  baseUrl?: core.Supplier<string>;
12
12
  apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
14
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
16
16
  interface RequestOptions {
17
17
  /** The maximum time to wait for a response in seconds. */
@@ -23,7 +23,7 @@ export declare namespace Wallet {
23
23
  /** Additional query string parameters to include in the request. */
24
24
  queryParams?: Record<string, unknown>;
25
25
  /** Additional headers to include in the request. */
26
- headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
26
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
27
  }
28
28
  }
29
29
  export declare class Wallet {
@@ -2,7 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  /**
5
- * Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developers/developer-guides/entities-customers), pass those in this object. Example usage:
5
+ * Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developers/developer-guides/entities-customers), pass those in this object. Max length for a value is 100 characters. Example usage:
6
6
  *
7
7
  * ```json
8
8
  * {
@@ -28,7 +28,7 @@ export interface BillDetailResponse {
28
28
  PaymentData?: Payabli.QueryPaymentData;
29
29
  /** Unique identifier for group or batch containing the transaction. */
30
30
  PaymentGroup?: string;
31
- PaymentId?: Payabli.Paymentid | undefined;
31
+ PaymentId?: Payabli.PaymentIdString;
32
32
  /** Method of payment applied to the transaction. */
33
33
  PaymentMethod?: string;
34
34
  /** Status of payout transaction. */
@@ -3,71 +3,70 @@
3
3
  */
4
4
  import * as Payabli from "../index.mjs";
5
5
  export interface BillQueryRecord2 {
6
- AccountingField1?: Payabli.AccountingField;
7
- AccountingField2?: Payabli.AccountingField;
6
+ AccountingField1: Payabli.AccountingField | null;
7
+ AccountingField2: Payabli.AccountingField | null;
8
8
  /** Additional data associated with the bill. */
9
- AdditionalData?: Record<string, string>;
9
+ AdditionalData: Record<string, string> | null;
10
10
  /** Batch number associated with the bill. */
11
- BatchNumber?: string;
12
- billApprovals?: Payabli.BillQueryRecord2BillApprovalsItem[];
11
+ BatchNumber: string | null;
12
+ billApprovals: Payabli.BillQueryRecord2BillApprovalsItem[] | null;
13
13
  /** Bill creation date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. */
14
- BillDate?: Payabli.Datenullable | undefined;
14
+ BillDate: (Payabli.Datenullable | undefined) | null;
15
15
  /** Events associated with the bill. */
16
- billEvents?: Payabli.GeneralEvents[];
16
+ billEvents: Payabli.GeneralEvents[] | null;
17
17
  /** Array of items included in the bill. */
18
- BillItems?: Payabli.BillItem[];
18
+ BillItems: Payabli.BillItem[] | null;
19
19
  /** Bill number. */
20
- BillNumber?: string;
20
+ BillNumber: string | null;
21
21
  /** Additional comments on the bill. */
22
- Comments?: string;
22
+ Comments: string | null;
23
23
  /** Timestamp of when bill was created, in UTC. */
24
- CreatedAt?: Payabli.CreatedAt;
24
+ CreatedAt: Payabli.CreatedAt | null;
25
25
  /** Discount amount applied to the bill. */
26
- Discount?: number;
26
+ Discount: number | null;
27
27
  /** Reference to documents associated with the bill. */
28
- DocumentsRef?: string;
28
+ DocumentsRef: string | null;
29
29
  /** Bill due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. */
30
- DueDate?: Payabli.Datenullable | undefined;
30
+ DueDate: (Payabli.Datenullable | undefined) | null;
31
31
  /** End date for the bill. */
32
- EndDate?: Payabli.Datenullable | undefined;
32
+ EndDate: (Payabli.Datenullable | undefined) | null;
33
33
  /** Entity identifier associated with the bill. */
34
- EntityID?: string;
35
- externalPaypointID?: Payabli.ExternalPaypointId;
34
+ EntityID: string | null;
35
+ externalPaypointID: Payabli.ExternalPaypointId | null;
36
36
  /** Frequency for scheduled bills. Applied only in `Mode` = 1. */
37
- Frequency?: Payabli.Frequency;
37
+ Frequency: Payabli.Frequency | null;
38
38
  /** Identifier of the bill. */
39
- IdBill?: number;
39
+ IdBill: number | null;
40
40
  /** Timestamp of when bill was last updated, in UTC. */
41
- LastUpdated?: Payabli.DatetimeNullable | undefined;
41
+ LastUpdated: (Payabli.DatetimeNullable | undefined) | null;
42
42
  /** Lot number associated with the bill. */
43
- LotNumber?: string;
43
+ LotNumber: string | null;
44
44
  /** Bill mode: value `0` for single/one-time bills, `1` for scheduled bills. */
45
- Mode?: number;
45
+ Mode: number | null;
46
46
  /** Net amount of the bill. */
47
- NetAmount?: number;
47
+ NetAmount: number | null;
48
48
  /** Parent organization identifier. */
49
- ParentOrgId?: number;
50
- ParentOrgName?: Payabli.OrgParentName;
51
- /** Payment identifier. */
52
- PaymentId?: string;
49
+ ParentOrgId: number | null;
50
+ ParentOrgName: Payabli.OrgParentName | null;
51
+ PaymentId: Payabli.PaymentIdString | null;
53
52
  /** Preferred payment method used. */
54
- PaymentMethod?: Payabli.BillQueryRecord2PaymentMethod;
53
+ PaymentMethod: Payabli.BillQueryRecord2PaymentMethod | null;
55
54
  /** Paylink identifier associated with the bill. */
56
- paylinkId?: string;
55
+ paylinkId: string | null;
57
56
  /** The paypoint's DBA name. */
58
- PaypointDbaname?: Payabli.Dbaname;
57
+ PaypointDbaname: Payabli.Dbaname | null;
59
58
  /** Entry name of the paypoint. */
60
- PaypointEntryname?: string;
59
+ PaypointEntryname: string | null;
61
60
  /** The paypoint's legal name. */
62
- PaypointLegalname?: Payabli.Legalname;
61
+ PaypointLegalname: Payabli.Legalname | null;
63
62
  /** Source of the bill. */
64
- Source?: string;
65
- Status?: Payabli.Billstatus;
63
+ Source: string | null;
64
+ Status: Payabli.Billstatus | null;
66
65
  /** The payment terms for invoice. If no terms were defined initially, then response data for this field will default to `N30`. */
67
- Terms?: Payabli.Terms;
66
+ Terms: Payabli.Terms | null;
68
67
  /** Total amount of the bill including taxes and fees. */
69
- TotalAmount?: number;
68
+ TotalAmount: number | null;
70
69
  /** MoneyOut transaction associated to the bill. */
71
- Transaction?: Payabli.TransactionOutQueryRecord;
72
- Vendor?: Payabli.VendorOutData;
70
+ Transaction: Payabli.TransactionOutQueryRecord | null;
71
+ Vendor: Payabli.VendorOutData | null;
73
72
  }
@@ -31,7 +31,7 @@ import * as Payabli from "../index.mjs";
31
31
  * totalsent2approval: 1
32
32
  * },
33
33
  * Records: [{
34
- * AdditionalData: undefined,
34
+ * AdditionalData: null,
35
35
  * billApprovals: [{
36
36
  * approved: 0,
37
37
  * approvedTime: "2024-03-13T15:54:27Z",
@@ -70,10 +70,10 @@ import * as Payabli from "../index.mjs";
70
70
  * Comments: "PAYBILL",
71
71
  * CreatedAt: "2024-03-13T15:54:26Z",
72
72
  * Discount: 0,
73
- * DocumentsRef: undefined,
73
+ * DocumentsRef: null,
74
74
  * DueDate: "2025-03-10",
75
- * EndDate: undefined,
76
- * EntityID: undefined,
75
+ * EndDate: null,
76
+ * EntityID: null,
77
77
  * externalPaypointID: "micasa-10",
78
78
  * Frequency: Payabli.Frequency.OneTime,
79
79
  * IdBill: 6104,
@@ -83,9 +83,9 @@ import * as Payabli from "../index.mjs";
83
83
  * NetAmount: 200,
84
84
  * ParentOrgId: 1001,
85
85
  * ParentOrgName: "Fitness Hub",
86
- * PaymentId: undefined,
87
- * PaymentMethod: undefined,
88
- * paylinkId: undefined,
86
+ * PaymentId: null,
87
+ * PaymentMethod: null,
88
+ * paylinkId: null,
89
89
  * PaypointDbaname: "MiCasa Sports",
90
90
  * PaypointEntryname: "micasa",
91
91
  * PaypointLegalname: "MiCasa Sports LLC",
@@ -93,7 +93,7 @@ import * as Payabli from "../index.mjs";
93
93
  * Status: 2,
94
94
  * Terms: "Net30",
95
95
  * TotalAmount: 200,
96
- * Transaction: undefined,
96
+ * Transaction: null,
97
97
  * Vendor: {
98
98
  * Address1: "1234 Liberdad St.",
99
99
  * Address2: "Suite 100",
@@ -2,6 +2,6 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  /**
5
- * _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself.
5
+ * _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
6
6
  */
7
7
  export type IdempotencyKey = string;
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * The unique transaction ID. This value is a string representation of a long integer.
6
+ */
7
+ export type PaymentIdString = string;
@@ -0,0 +1,4 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export {};
@@ -4,4 +4,4 @@
4
4
  /**
5
5
  * Unique transaction ID.
6
6
  */
7
- export type Paymentid = string | undefined;
7
+ export type Paymentid = number;
@@ -26,7 +26,7 @@ import * as Payabli from "../index.mjs";
26
26
  * totalAmount: 100
27
27
  * }
28
28
  * },
29
- * PaymentId: "2345667-ddd-fff",
29
+ * PaymentId: "12345678910",
30
30
  * PaymentMethod: "ach",
31
31
  * PaymentStatus: "Processed",
32
32
  * PaypointDbaname: "Sunshine Gutters",
@@ -111,7 +111,7 @@ export declare namespace QueryPayoutTransaction {
111
111
  ParentOrgName?: Payabli.OrgParentName;
112
112
  ParentOrgId?: Payabli.OrgParentId;
113
113
  PaymentData?: Item.PaymentData;
114
- PaymentId?: Payabli.Paymentid | undefined;
114
+ PaymentId?: Payabli.PaymentIdString;
115
115
  /** The payment method for the transaction. */
116
116
  PaymentMethod?: string;
117
117
  /** Status of payout transaction. See [Payout Transaction Statuses](guides/money-out-statuses#payout-transaction-statuses) for a full reference. */