modern-treasury 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.js +10 -0
- package/.prettierrc +6 -0
- package/LICENSE +7 -0
- package/README.md +198 -0
- package/build +10 -0
- package/core.ts +746 -0
- package/dist/cjs/core.d.ts +215 -0
- package/dist/cjs/core.js +815 -0
- package/dist/cjs/core.js.map +1 -0
- package/dist/cjs/index.d.ts +118 -0
- package/dist/cjs/index.js +128 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/pagination.d.ts +14 -0
- package/dist/cjs/pagination.js +22 -0
- package/dist/cjs/pagination.js.map +1 -0
- package/dist/cjs/resource.d.ts +11 -0
- package/dist/cjs/resource.js +16 -0
- package/dist/cjs/resource.js.map +1 -0
- package/dist/cjs/resources/counterparties.d.ts +500 -0
- package/dist/cjs/resources/counterparties.js +57 -0
- package/dist/cjs/resources/counterparties.js.map +1 -0
- package/dist/cjs/resources/documents.d.ts +66 -0
- package/dist/cjs/resources/documents.js +23 -0
- package/dist/cjs/resources/documents.js.map +1 -0
- package/dist/cjs/resources/events.d.ts +53 -0
- package/dist/cjs/resources/events.js +22 -0
- package/dist/cjs/resources/events.js.map +1 -0
- package/dist/cjs/resources/expected-payments.d.ts +928 -0
- package/dist/cjs/resources/expected-payments.js +31 -0
- package/dist/cjs/resources/expected-payments.js.map +1 -0
- package/dist/cjs/resources/external-accounts.d.ts +597 -0
- package/dist/cjs/resources/external-accounts.js +51 -0
- package/dist/cjs/resources/external-accounts.js.map +1 -0
- package/dist/cjs/resources/incoming-payment-details.d.ts +487 -0
- package/dist/cjs/resources/incoming-payment-details.js +35 -0
- package/dist/cjs/resources/incoming-payment-details.js.map +1 -0
- package/dist/cjs/resources/index.d.ts +15 -0
- package/dist/cjs/resources/index.js +46 -0
- package/dist/cjs/resources/index.js.map +1 -0
- package/dist/cjs/resources/internal-accounts.d.ts +666 -0
- package/dist/cjs/resources/internal-accounts.js +31 -0
- package/dist/cjs/resources/internal-accounts.js.map +1 -0
- package/dist/cjs/resources/line-items.d.ts +90 -0
- package/dist/cjs/resources/line-items.js +38 -0
- package/dist/cjs/resources/line-items.js.map +1 -0
- package/dist/cjs/resources/paper-items.d.ts +279 -0
- package/dist/cjs/resources/paper-items.js +25 -0
- package/dist/cjs/resources/paper-items.js.map +1 -0
- package/dist/cjs/resources/payment-orders/index.d.ts +2 -0
- package/dist/cjs/resources/payment-orders/index.js +33 -0
- package/dist/cjs/resources/payment-orders/index.js.map +1 -0
- package/dist/cjs/resources/payment-orders/payment-orders.d.ts +2180 -0
- package/dist/cjs/resources/payment-orders/payment-orders.js +56 -0
- package/dist/cjs/resources/payment-orders/payment-orders.js.map +1 -0
- package/dist/cjs/resources/payment-orders/reversals.d.ts +46 -0
- package/dist/cjs/resources/payment-orders/reversals.js +23 -0
- package/dist/cjs/resources/payment-orders/reversals.js.map +1 -0
- package/dist/cjs/resources/returns.d.ts +487 -0
- package/dist/cjs/resources/returns.js +31 -0
- package/dist/cjs/resources/returns.js.map +1 -0
- package/dist/cjs/resources/top-level.d.ts +3 -0
- package/dist/cjs/resources/top-level.js +4 -0
- package/dist/cjs/resources/top-level.js.map +1 -0
- package/dist/cjs/resources/transactions.d.ts +377 -0
- package/dist/cjs/resources/transactions.js +31 -0
- package/dist/cjs/resources/transactions.js.map +1 -0
- package/dist/cjs/resources/validations.d.ts +97 -0
- package/dist/cjs/resources/validations.js +16 -0
- package/dist/cjs/resources/validations.js.map +1 -0
- package/dist/cjs/resources/webhooks.d.ts +31 -0
- package/dist/cjs/resources/webhooks.js +44 -0
- package/dist/cjs/resources/webhooks.js.map +1 -0
- package/dist/cjs/tests/api-resources/counterparties.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/counterparties.test.js +275 -0
- package/dist/cjs/tests/api-resources/counterparties.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/documents.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/documents.test.js +78 -0
- package/dist/cjs/tests/api-resources/documents.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/events.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/events.test.js +100 -0
- package/dist/cjs/tests/api-resources/events.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/expected-payments.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/expected-payments.test.js +176 -0
- package/dist/cjs/tests/api-resources/expected-payments.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/external-accounts.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/external-accounts.test.js +248 -0
- package/dist/cjs/tests/api-resources/external-accounts.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/incoming-payment-details.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/incoming-payment-details.test.js +130 -0
- package/dist/cjs/tests/api-resources/incoming-payment-details.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/internal-accounts.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/internal-accounts.test.js +144 -0
- package/dist/cjs/tests/api-resources/internal-accounts.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/line-items.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/line-items.test.js +123 -0
- package/dist/cjs/tests/api-resources/line-items.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/paper-items.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/paper-items.test.js +96 -0
- package/dist/cjs/tests/api-resources/paper-items.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/payment-orders/payment-orders.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/payment-orders/payment-orders.test.js +77 -0
- package/dist/cjs/tests/api-resources/payment-orders/payment-orders.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/returns.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/returns.test.js +116 -0
- package/dist/cjs/tests/api-resources/returns.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/top-level.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/top-level.test.js +59 -0
- package/dist/cjs/tests/api-resources/top-level.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/transactions.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/transactions.test.js +134 -0
- package/dist/cjs/tests/api-resources/transactions.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/validations.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/validations.test.js +62 -0
- package/dist/cjs/tests/api-resources/validations.test.js.map +1 -0
- package/dist/cjs/tests/api-resources/webhooks.test.d.ts +1 -0
- package/dist/cjs/tests/api-resources/webhooks.test.js +100 -0
- package/dist/cjs/tests/api-resources/webhooks.test.js.map +1 -0
- package/dist/cjs/tests/form.test.d.ts +1 -0
- package/dist/cjs/tests/form.test.js +61 -0
- package/dist/cjs/tests/form.test.js.map +1 -0
- package/dist/cjs/tests/index.test.d.ts +1 -0
- package/dist/cjs/tests/index.test.js +57 -0
- package/dist/cjs/tests/index.test.js.map +1 -0
- package/dist/cjs/tests/responses.test.d.ts +1 -0
- package/dist/cjs/tests/responses.test.js +60 -0
- package/dist/cjs/tests/responses.test.js.map +1 -0
- package/index.ts +175 -0
- package/jest.config.js +8 -0
- package/package.json +47 -0
- package/pagination.ts +36 -0
- package/resource.ts +22 -0
- package/resources/counterparties.ts +666 -0
- package/resources/documents.ts +97 -0
- package/resources/events.ts +86 -0
- package/resources/expected-payments.ts +1016 -0
- package/resources/external-accounts.ts +762 -0
- package/resources/incoming-payment-details.ts +592 -0
- package/resources/index.ts +16 -0
- package/resources/internal-accounts.ts +774 -0
- package/resources/line-items.ts +138 -0
- package/resources/paper-items.ts +317 -0
- package/resources/payment-orders/index.ts +3 -0
- package/resources/payment-orders/payment-orders.ts +2486 -0
- package/resources/payment-orders/reversals.ts +72 -0
- package/resources/returns.ts +545 -0
- package/resources/top-level.ts +5 -0
- package/resources/transactions.ts +441 -0
- package/resources/validations.ts +115 -0
- package/resources/webhooks.ts +48 -0
- package/tests/api-resources/counterparties.test.ts +237 -0
- package/tests/api-resources/documents.test.ts +40 -0
- package/tests/api-resources/events.test.ts +62 -0
- package/tests/api-resources/expected-payments.test.ts +138 -0
- package/tests/api-resources/external-accounts.test.ts +210 -0
- package/tests/api-resources/incoming-payment-details.test.ts +92 -0
- package/tests/api-resources/internal-accounts.test.ts +103 -0
- package/tests/api-resources/line-items.test.ts +85 -0
- package/tests/api-resources/paper-items.test.ts +58 -0
- package/tests/api-resources/payment-orders/payment-orders.test.ts +39 -0
- package/tests/api-resources/returns.test.ts +78 -0
- package/tests/api-resources/top-level.test.ts +21 -0
- package/tests/api-resources/transactions.test.ts +96 -0
- package/tests/api-resources/validations.test.ts +24 -0
- package/tests/api-resources/webhooks.test.ts +102 -0
- package/tests/form.test.ts +27 -0
- package/tests/index.test.ts +62 -0
- package/tests/responses.test.ts +25 -0
- package/tsconfig.cjs.json +8 -0
- package/tsconfig.json +36 -0
|
@@ -0,0 +1,928 @@
|
|
|
1
|
+
import * as Core from '../core';
|
|
2
|
+
import { APIResource } from '../resource';
|
|
3
|
+
import { Page, PageParams } from '../pagination';
|
|
4
|
+
export declare class ExpectedPayments extends APIResource {
|
|
5
|
+
create(
|
|
6
|
+
body: ExpectedPaymentCreateParams,
|
|
7
|
+
options?: Core.RequestOptions,
|
|
8
|
+
): Promise<Core.APIResponse<ExpectedPayment>>;
|
|
9
|
+
retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ExpectedPayment>>;
|
|
10
|
+
update(
|
|
11
|
+
id: string,
|
|
12
|
+
body: ExpectedPaymentUpdateParams,
|
|
13
|
+
options?: Core.RequestOptions,
|
|
14
|
+
): Promise<Core.APIResponse<ExpectedPayment>>;
|
|
15
|
+
list(
|
|
16
|
+
query?: ExpectedPaymentListParams,
|
|
17
|
+
options?: Core.RequestOptions,
|
|
18
|
+
): Core.PagePromise<ExpectedPaymentsPage>;
|
|
19
|
+
list(options?: Core.RequestOptions): Core.PagePromise<ExpectedPaymentsPage>;
|
|
20
|
+
del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ExpectedPayment>>;
|
|
21
|
+
}
|
|
22
|
+
export declare class ExpectedPaymentsPage extends Page<ExpectedPayment> {}
|
|
23
|
+
export interface ExpectedPayment {
|
|
24
|
+
/**
|
|
25
|
+
* The lowest amount this expected payment may be equal to. Value in specified
|
|
26
|
+
* currency's smallest unit. e.g. $10 would be represented as 1000.
|
|
27
|
+
*/
|
|
28
|
+
amount_lower_bound?: number;
|
|
29
|
+
/**
|
|
30
|
+
* The highest amount this expected payment may be equal to. Value in specified
|
|
31
|
+
* currency's smallest unit. e.g. $10 would be represented as 1000.
|
|
32
|
+
*/
|
|
33
|
+
amount_upper_bound?: number;
|
|
34
|
+
/**
|
|
35
|
+
* The ID of the counterparty you expect for this payment.
|
|
36
|
+
*/
|
|
37
|
+
counterparty_id?: string | null;
|
|
38
|
+
created_at?: string;
|
|
39
|
+
/**
|
|
40
|
+
* Must conform to ISO 4217. Defaults to the currency of the internal account.
|
|
41
|
+
*/
|
|
42
|
+
currency?:
|
|
43
|
+
| 'AED'
|
|
44
|
+
| 'AFN'
|
|
45
|
+
| 'ALL'
|
|
46
|
+
| 'AMD'
|
|
47
|
+
| 'ANG'
|
|
48
|
+
| 'AOA'
|
|
49
|
+
| 'ARS'
|
|
50
|
+
| 'AUD'
|
|
51
|
+
| 'AWG'
|
|
52
|
+
| 'AZN'
|
|
53
|
+
| 'BAM'
|
|
54
|
+
| 'BBD'
|
|
55
|
+
| 'BCH'
|
|
56
|
+
| 'BDT'
|
|
57
|
+
| 'BGN'
|
|
58
|
+
| 'BHD'
|
|
59
|
+
| 'BIF'
|
|
60
|
+
| 'BMD'
|
|
61
|
+
| 'BND'
|
|
62
|
+
| 'BOB'
|
|
63
|
+
| 'BRL'
|
|
64
|
+
| 'BSD'
|
|
65
|
+
| 'BTC'
|
|
66
|
+
| 'BTN'
|
|
67
|
+
| 'BWP'
|
|
68
|
+
| 'BYN'
|
|
69
|
+
| 'BYR'
|
|
70
|
+
| 'BZD'
|
|
71
|
+
| 'CAD'
|
|
72
|
+
| 'CDF'
|
|
73
|
+
| 'CHF'
|
|
74
|
+
| 'CLF'
|
|
75
|
+
| 'CLP'
|
|
76
|
+
| 'CNH'
|
|
77
|
+
| 'CNY'
|
|
78
|
+
| 'COP'
|
|
79
|
+
| 'CRC'
|
|
80
|
+
| 'CUC'
|
|
81
|
+
| 'CUP'
|
|
82
|
+
| 'CVE'
|
|
83
|
+
| 'CZK'
|
|
84
|
+
| 'DJF'
|
|
85
|
+
| 'DKK'
|
|
86
|
+
| 'DOP'
|
|
87
|
+
| 'DZD'
|
|
88
|
+
| 'EEK'
|
|
89
|
+
| 'EGP'
|
|
90
|
+
| 'ERN'
|
|
91
|
+
| 'ETB'
|
|
92
|
+
| 'EUR'
|
|
93
|
+
| 'FJD'
|
|
94
|
+
| 'FKP'
|
|
95
|
+
| 'GBP'
|
|
96
|
+
| 'GBX'
|
|
97
|
+
| 'GEL'
|
|
98
|
+
| 'GGP'
|
|
99
|
+
| 'GHS'
|
|
100
|
+
| 'GIP'
|
|
101
|
+
| 'GMD'
|
|
102
|
+
| 'GNF'
|
|
103
|
+
| 'GTQ'
|
|
104
|
+
| 'GYD'
|
|
105
|
+
| 'HKD'
|
|
106
|
+
| 'HNL'
|
|
107
|
+
| 'HRK'
|
|
108
|
+
| 'HTG'
|
|
109
|
+
| 'HUF'
|
|
110
|
+
| 'IDR'
|
|
111
|
+
| 'ILS'
|
|
112
|
+
| 'IMP'
|
|
113
|
+
| 'INR'
|
|
114
|
+
| 'IQD'
|
|
115
|
+
| 'IRR'
|
|
116
|
+
| 'ISK'
|
|
117
|
+
| 'JEP'
|
|
118
|
+
| 'JMD'
|
|
119
|
+
| 'JOD'
|
|
120
|
+
| 'JPY'
|
|
121
|
+
| 'KES'
|
|
122
|
+
| 'KGS'
|
|
123
|
+
| 'KHR'
|
|
124
|
+
| 'KMF'
|
|
125
|
+
| 'KPW'
|
|
126
|
+
| 'KRW'
|
|
127
|
+
| 'KWD'
|
|
128
|
+
| 'KYD'
|
|
129
|
+
| 'KZT'
|
|
130
|
+
| 'LAK'
|
|
131
|
+
| 'LBP'
|
|
132
|
+
| 'LKR'
|
|
133
|
+
| 'LRD'
|
|
134
|
+
| 'LSL'
|
|
135
|
+
| 'LTL'
|
|
136
|
+
| 'LVL'
|
|
137
|
+
| 'LYD'
|
|
138
|
+
| 'MAD'
|
|
139
|
+
| 'MDL'
|
|
140
|
+
| 'MGA'
|
|
141
|
+
| 'MKD'
|
|
142
|
+
| 'MMK'
|
|
143
|
+
| 'MNT'
|
|
144
|
+
| 'MOP'
|
|
145
|
+
| 'MRO'
|
|
146
|
+
| 'MRU'
|
|
147
|
+
| 'MTL'
|
|
148
|
+
| 'MUR'
|
|
149
|
+
| 'MVR'
|
|
150
|
+
| 'MWK'
|
|
151
|
+
| 'MXN'
|
|
152
|
+
| 'MYR'
|
|
153
|
+
| 'MZN'
|
|
154
|
+
| 'NAD'
|
|
155
|
+
| 'NGN'
|
|
156
|
+
| 'NIO'
|
|
157
|
+
| 'NOK'
|
|
158
|
+
| 'NPR'
|
|
159
|
+
| 'NZD'
|
|
160
|
+
| 'OMR'
|
|
161
|
+
| 'PAB'
|
|
162
|
+
| 'PEN'
|
|
163
|
+
| 'PGK'
|
|
164
|
+
| 'PHP'
|
|
165
|
+
| 'PKR'
|
|
166
|
+
| 'PLN'
|
|
167
|
+
| 'PYG'
|
|
168
|
+
| 'QAR'
|
|
169
|
+
| 'RON'
|
|
170
|
+
| 'RSD'
|
|
171
|
+
| 'RUB'
|
|
172
|
+
| 'RWF'
|
|
173
|
+
| 'SAR'
|
|
174
|
+
| 'SBD'
|
|
175
|
+
| 'SCR'
|
|
176
|
+
| 'SDG'
|
|
177
|
+
| 'SEK'
|
|
178
|
+
| 'SGD'
|
|
179
|
+
| 'SHP'
|
|
180
|
+
| 'SKK'
|
|
181
|
+
| 'SLL'
|
|
182
|
+
| 'SOS'
|
|
183
|
+
| 'SRD'
|
|
184
|
+
| 'SSP'
|
|
185
|
+
| 'STD'
|
|
186
|
+
| 'SVC'
|
|
187
|
+
| 'SYP'
|
|
188
|
+
| 'SZL'
|
|
189
|
+
| 'THB'
|
|
190
|
+
| 'TJS'
|
|
191
|
+
| 'TMM'
|
|
192
|
+
| 'TMT'
|
|
193
|
+
| 'TND'
|
|
194
|
+
| 'TOP'
|
|
195
|
+
| 'TRY'
|
|
196
|
+
| 'TTD'
|
|
197
|
+
| 'TWD'
|
|
198
|
+
| 'TZS'
|
|
199
|
+
| 'UAH'
|
|
200
|
+
| 'UGX'
|
|
201
|
+
| 'USD'
|
|
202
|
+
| 'UYU'
|
|
203
|
+
| 'UZS'
|
|
204
|
+
| 'VEF'
|
|
205
|
+
| 'VES'
|
|
206
|
+
| 'VND'
|
|
207
|
+
| 'VUV'
|
|
208
|
+
| 'WST'
|
|
209
|
+
| 'XAF'
|
|
210
|
+
| 'XAG'
|
|
211
|
+
| 'XAU'
|
|
212
|
+
| 'XBA'
|
|
213
|
+
| 'XBB'
|
|
214
|
+
| 'XBC'
|
|
215
|
+
| 'XBD'
|
|
216
|
+
| 'XCD'
|
|
217
|
+
| 'XDR'
|
|
218
|
+
| 'XFU'
|
|
219
|
+
| 'XOF'
|
|
220
|
+
| 'XPD'
|
|
221
|
+
| 'XPF'
|
|
222
|
+
| 'XPT'
|
|
223
|
+
| 'XTS'
|
|
224
|
+
| 'YER'
|
|
225
|
+
| 'ZAR'
|
|
226
|
+
| 'ZMK'
|
|
227
|
+
| 'ZMW'
|
|
228
|
+
| 'ZWD'
|
|
229
|
+
| 'ZWL'
|
|
230
|
+
| 'ZWN'
|
|
231
|
+
| 'ZWR';
|
|
232
|
+
/**
|
|
233
|
+
* The earliest date the payment may come in. Format: yyyy-mm-dd
|
|
234
|
+
*/
|
|
235
|
+
date_lower_bound?: string | null;
|
|
236
|
+
/**
|
|
237
|
+
* The latest date the payment may come in. Format: yyyy-mm-dd
|
|
238
|
+
*/
|
|
239
|
+
date_upper_bound?: string | null;
|
|
240
|
+
/**
|
|
241
|
+
* An optional description for internal use.
|
|
242
|
+
*/
|
|
243
|
+
description?: string | null;
|
|
244
|
+
/**
|
|
245
|
+
* One of credit or debit. When you are receiving money, use credit. When you are
|
|
246
|
+
* being charged, use debit.
|
|
247
|
+
*/
|
|
248
|
+
direction?: 'credit' | 'debit';
|
|
249
|
+
id?: string;
|
|
250
|
+
/**
|
|
251
|
+
* The ID of the Internal Account for the expected payment.
|
|
252
|
+
*/
|
|
253
|
+
internal_account_id?: string;
|
|
254
|
+
/**
|
|
255
|
+
* This field will be true if this object exists in the live environment or false
|
|
256
|
+
* if it exists in the test environment.
|
|
257
|
+
*/
|
|
258
|
+
live_mode?: boolean;
|
|
259
|
+
/**
|
|
260
|
+
* Additional data represented as key-value pairs. Both the key and value must be
|
|
261
|
+
* strings.
|
|
262
|
+
*/
|
|
263
|
+
metadata?: Record<string, string>;
|
|
264
|
+
object?: string;
|
|
265
|
+
/**
|
|
266
|
+
* One of manual if this expected payment was manually reconciled in the dashboard,
|
|
267
|
+
* automatic if it was automatically reconciled by Modern Treasury, or null if it
|
|
268
|
+
* is unreconciled.
|
|
269
|
+
*/
|
|
270
|
+
reconciliation_method?: 'automatic' | 'manual' | null;
|
|
271
|
+
/**
|
|
272
|
+
* For `ach`, this field will be passed through on an addenda record. For `wire`
|
|
273
|
+
* payments the field will be passed through as the "Originator to Beneficiary
|
|
274
|
+
* Information", also known as OBI or Fedwire tag 6000.
|
|
275
|
+
*/
|
|
276
|
+
remittance_information?: string | null;
|
|
277
|
+
/**
|
|
278
|
+
* The statement description you expect to see on the transaction. For ACH
|
|
279
|
+
* payments, this will be the full line item passed from the bank. For wire
|
|
280
|
+
* payments, this will be the OBI field on the wire. For check payments, this will
|
|
281
|
+
* be the memo field.
|
|
282
|
+
*/
|
|
283
|
+
statement_descriptor?: string | null;
|
|
284
|
+
/**
|
|
285
|
+
* One of unreconciled, reconciled, or archived.
|
|
286
|
+
*/
|
|
287
|
+
status?: 'archived' | 'reconciled' | 'unreconciled';
|
|
288
|
+
/**
|
|
289
|
+
* The ID of the Transaction this expected payment object has been matched to.
|
|
290
|
+
*/
|
|
291
|
+
transaction_id?: string | null;
|
|
292
|
+
/**
|
|
293
|
+
* The ID of the Transaction Line Item this expected payment has been matched to.
|
|
294
|
+
*/
|
|
295
|
+
transaction_line_item_id?: string | null;
|
|
296
|
+
/**
|
|
297
|
+
* One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
|
|
298
|
+
* sepa, signet, wire.
|
|
299
|
+
*/
|
|
300
|
+
type?:
|
|
301
|
+
| 'ach'
|
|
302
|
+
| 'au_becs'
|
|
303
|
+
| 'bacs'
|
|
304
|
+
| 'book'
|
|
305
|
+
| 'card'
|
|
306
|
+
| 'check'
|
|
307
|
+
| 'eft'
|
|
308
|
+
| 'interac'
|
|
309
|
+
| 'provxchange'
|
|
310
|
+
| 'rtp'
|
|
311
|
+
| 'sen'
|
|
312
|
+
| 'sepa'
|
|
313
|
+
| 'signet'
|
|
314
|
+
| 'wire'
|
|
315
|
+
| null;
|
|
316
|
+
updated_at?: string;
|
|
317
|
+
}
|
|
318
|
+
export interface ExpectedPaymentCreateParams {
|
|
319
|
+
/**
|
|
320
|
+
* The lowest amount this expected payment may be equal to. Value in specified
|
|
321
|
+
* currency's smallest unit. e.g. $10 would be represented as 1000.
|
|
322
|
+
*/
|
|
323
|
+
amount_lower_bound: number;
|
|
324
|
+
/**
|
|
325
|
+
* The highest amount this expected payment may be equal to. Value in specified
|
|
326
|
+
* currency's smallest unit. e.g. $10 would be represented as 1000.
|
|
327
|
+
*/
|
|
328
|
+
amount_upper_bound: number;
|
|
329
|
+
/**
|
|
330
|
+
* One of credit or debit. When you are receiving money, use credit. When you are
|
|
331
|
+
* being charged, use debit.
|
|
332
|
+
*/
|
|
333
|
+
direction: 'credit' | 'debit';
|
|
334
|
+
/**
|
|
335
|
+
* The ID of the Internal Account for the expected payment.
|
|
336
|
+
*/
|
|
337
|
+
internal_account_id: string;
|
|
338
|
+
/**
|
|
339
|
+
* The ID of the counterparty you expect for this payment.
|
|
340
|
+
*/
|
|
341
|
+
counterparty_id?: string | null;
|
|
342
|
+
/**
|
|
343
|
+
* Must conform to ISO 4217. Defaults to the currency of the internal account.
|
|
344
|
+
*/
|
|
345
|
+
currency?:
|
|
346
|
+
| 'AED'
|
|
347
|
+
| 'AFN'
|
|
348
|
+
| 'ALL'
|
|
349
|
+
| 'AMD'
|
|
350
|
+
| 'ANG'
|
|
351
|
+
| 'AOA'
|
|
352
|
+
| 'ARS'
|
|
353
|
+
| 'AUD'
|
|
354
|
+
| 'AWG'
|
|
355
|
+
| 'AZN'
|
|
356
|
+
| 'BAM'
|
|
357
|
+
| 'BBD'
|
|
358
|
+
| 'BCH'
|
|
359
|
+
| 'BDT'
|
|
360
|
+
| 'BGN'
|
|
361
|
+
| 'BHD'
|
|
362
|
+
| 'BIF'
|
|
363
|
+
| 'BMD'
|
|
364
|
+
| 'BND'
|
|
365
|
+
| 'BOB'
|
|
366
|
+
| 'BRL'
|
|
367
|
+
| 'BSD'
|
|
368
|
+
| 'BTC'
|
|
369
|
+
| 'BTN'
|
|
370
|
+
| 'BWP'
|
|
371
|
+
| 'BYN'
|
|
372
|
+
| 'BYR'
|
|
373
|
+
| 'BZD'
|
|
374
|
+
| 'CAD'
|
|
375
|
+
| 'CDF'
|
|
376
|
+
| 'CHF'
|
|
377
|
+
| 'CLF'
|
|
378
|
+
| 'CLP'
|
|
379
|
+
| 'CNH'
|
|
380
|
+
| 'CNY'
|
|
381
|
+
| 'COP'
|
|
382
|
+
| 'CRC'
|
|
383
|
+
| 'CUC'
|
|
384
|
+
| 'CUP'
|
|
385
|
+
| 'CVE'
|
|
386
|
+
| 'CZK'
|
|
387
|
+
| 'DJF'
|
|
388
|
+
| 'DKK'
|
|
389
|
+
| 'DOP'
|
|
390
|
+
| 'DZD'
|
|
391
|
+
| 'EEK'
|
|
392
|
+
| 'EGP'
|
|
393
|
+
| 'ERN'
|
|
394
|
+
| 'ETB'
|
|
395
|
+
| 'EUR'
|
|
396
|
+
| 'FJD'
|
|
397
|
+
| 'FKP'
|
|
398
|
+
| 'GBP'
|
|
399
|
+
| 'GBX'
|
|
400
|
+
| 'GEL'
|
|
401
|
+
| 'GGP'
|
|
402
|
+
| 'GHS'
|
|
403
|
+
| 'GIP'
|
|
404
|
+
| 'GMD'
|
|
405
|
+
| 'GNF'
|
|
406
|
+
| 'GTQ'
|
|
407
|
+
| 'GYD'
|
|
408
|
+
| 'HKD'
|
|
409
|
+
| 'HNL'
|
|
410
|
+
| 'HRK'
|
|
411
|
+
| 'HTG'
|
|
412
|
+
| 'HUF'
|
|
413
|
+
| 'IDR'
|
|
414
|
+
| 'ILS'
|
|
415
|
+
| 'IMP'
|
|
416
|
+
| 'INR'
|
|
417
|
+
| 'IQD'
|
|
418
|
+
| 'IRR'
|
|
419
|
+
| 'ISK'
|
|
420
|
+
| 'JEP'
|
|
421
|
+
| 'JMD'
|
|
422
|
+
| 'JOD'
|
|
423
|
+
| 'JPY'
|
|
424
|
+
| 'KES'
|
|
425
|
+
| 'KGS'
|
|
426
|
+
| 'KHR'
|
|
427
|
+
| 'KMF'
|
|
428
|
+
| 'KPW'
|
|
429
|
+
| 'KRW'
|
|
430
|
+
| 'KWD'
|
|
431
|
+
| 'KYD'
|
|
432
|
+
| 'KZT'
|
|
433
|
+
| 'LAK'
|
|
434
|
+
| 'LBP'
|
|
435
|
+
| 'LKR'
|
|
436
|
+
| 'LRD'
|
|
437
|
+
| 'LSL'
|
|
438
|
+
| 'LTL'
|
|
439
|
+
| 'LVL'
|
|
440
|
+
| 'LYD'
|
|
441
|
+
| 'MAD'
|
|
442
|
+
| 'MDL'
|
|
443
|
+
| 'MGA'
|
|
444
|
+
| 'MKD'
|
|
445
|
+
| 'MMK'
|
|
446
|
+
| 'MNT'
|
|
447
|
+
| 'MOP'
|
|
448
|
+
| 'MRO'
|
|
449
|
+
| 'MRU'
|
|
450
|
+
| 'MTL'
|
|
451
|
+
| 'MUR'
|
|
452
|
+
| 'MVR'
|
|
453
|
+
| 'MWK'
|
|
454
|
+
| 'MXN'
|
|
455
|
+
| 'MYR'
|
|
456
|
+
| 'MZN'
|
|
457
|
+
| 'NAD'
|
|
458
|
+
| 'NGN'
|
|
459
|
+
| 'NIO'
|
|
460
|
+
| 'NOK'
|
|
461
|
+
| 'NPR'
|
|
462
|
+
| 'NZD'
|
|
463
|
+
| 'OMR'
|
|
464
|
+
| 'PAB'
|
|
465
|
+
| 'PEN'
|
|
466
|
+
| 'PGK'
|
|
467
|
+
| 'PHP'
|
|
468
|
+
| 'PKR'
|
|
469
|
+
| 'PLN'
|
|
470
|
+
| 'PYG'
|
|
471
|
+
| 'QAR'
|
|
472
|
+
| 'RON'
|
|
473
|
+
| 'RSD'
|
|
474
|
+
| 'RUB'
|
|
475
|
+
| 'RWF'
|
|
476
|
+
| 'SAR'
|
|
477
|
+
| 'SBD'
|
|
478
|
+
| 'SCR'
|
|
479
|
+
| 'SDG'
|
|
480
|
+
| 'SEK'
|
|
481
|
+
| 'SGD'
|
|
482
|
+
| 'SHP'
|
|
483
|
+
| 'SKK'
|
|
484
|
+
| 'SLL'
|
|
485
|
+
| 'SOS'
|
|
486
|
+
| 'SRD'
|
|
487
|
+
| 'SSP'
|
|
488
|
+
| 'STD'
|
|
489
|
+
| 'SVC'
|
|
490
|
+
| 'SYP'
|
|
491
|
+
| 'SZL'
|
|
492
|
+
| 'THB'
|
|
493
|
+
| 'TJS'
|
|
494
|
+
| 'TMM'
|
|
495
|
+
| 'TMT'
|
|
496
|
+
| 'TND'
|
|
497
|
+
| 'TOP'
|
|
498
|
+
| 'TRY'
|
|
499
|
+
| 'TTD'
|
|
500
|
+
| 'TWD'
|
|
501
|
+
| 'TZS'
|
|
502
|
+
| 'UAH'
|
|
503
|
+
| 'UGX'
|
|
504
|
+
| 'USD'
|
|
505
|
+
| 'UYU'
|
|
506
|
+
| 'UZS'
|
|
507
|
+
| 'VEF'
|
|
508
|
+
| 'VES'
|
|
509
|
+
| 'VND'
|
|
510
|
+
| 'VUV'
|
|
511
|
+
| 'WST'
|
|
512
|
+
| 'XAF'
|
|
513
|
+
| 'XAG'
|
|
514
|
+
| 'XAU'
|
|
515
|
+
| 'XBA'
|
|
516
|
+
| 'XBB'
|
|
517
|
+
| 'XBC'
|
|
518
|
+
| 'XBD'
|
|
519
|
+
| 'XCD'
|
|
520
|
+
| 'XDR'
|
|
521
|
+
| 'XFU'
|
|
522
|
+
| 'XOF'
|
|
523
|
+
| 'XPD'
|
|
524
|
+
| 'XPF'
|
|
525
|
+
| 'XPT'
|
|
526
|
+
| 'XTS'
|
|
527
|
+
| 'YER'
|
|
528
|
+
| 'ZAR'
|
|
529
|
+
| 'ZMK'
|
|
530
|
+
| 'ZMW'
|
|
531
|
+
| 'ZWD'
|
|
532
|
+
| 'ZWL'
|
|
533
|
+
| 'ZWN'
|
|
534
|
+
| 'ZWR';
|
|
535
|
+
/**
|
|
536
|
+
* The earliest date the payment may come in. Format: yyyy-mm-dd
|
|
537
|
+
*/
|
|
538
|
+
date_lower_bound?: string | null;
|
|
539
|
+
/**
|
|
540
|
+
* The latest date the payment may come in. Format: yyyy-mm-dd
|
|
541
|
+
*/
|
|
542
|
+
date_upper_bound?: string | null;
|
|
543
|
+
/**
|
|
544
|
+
* An optional description for internal use.
|
|
545
|
+
*/
|
|
546
|
+
description?: string | null;
|
|
547
|
+
line_items?: Array<ExpectedPaymentCreateParams.LineItems>;
|
|
548
|
+
/**
|
|
549
|
+
* Additional data represented as key-value pairs. Both the key and value must be
|
|
550
|
+
* strings.
|
|
551
|
+
*/
|
|
552
|
+
metadata?: Record<string, string>;
|
|
553
|
+
/**
|
|
554
|
+
* For `ach`, this field will be passed through on an addenda record. For `wire`
|
|
555
|
+
* payments the field will be passed through as the "Originator to Beneficiary
|
|
556
|
+
* Information", also known as OBI or Fedwire tag 6000.
|
|
557
|
+
*/
|
|
558
|
+
remittance_information?: string | null;
|
|
559
|
+
/**
|
|
560
|
+
* The statement description you expect to see on the transaction. For ACH
|
|
561
|
+
* payments, this will be the full line item passed from the bank. For wire
|
|
562
|
+
* payments, this will be the OBI field on the wire. For check payments, this will
|
|
563
|
+
* be the memo field.
|
|
564
|
+
*/
|
|
565
|
+
statement_descriptor?: string | null;
|
|
566
|
+
/**
|
|
567
|
+
* One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
|
|
568
|
+
* sepa, signet, wire.
|
|
569
|
+
*/
|
|
570
|
+
type?:
|
|
571
|
+
| 'ach'
|
|
572
|
+
| 'au_becs'
|
|
573
|
+
| 'bacs'
|
|
574
|
+
| 'book'
|
|
575
|
+
| 'card'
|
|
576
|
+
| 'check'
|
|
577
|
+
| 'eft'
|
|
578
|
+
| 'interac'
|
|
579
|
+
| 'provxchange'
|
|
580
|
+
| 'rtp'
|
|
581
|
+
| 'sen'
|
|
582
|
+
| 'sepa'
|
|
583
|
+
| 'signet'
|
|
584
|
+
| 'wire'
|
|
585
|
+
| null;
|
|
586
|
+
}
|
|
587
|
+
export declare namespace ExpectedPaymentCreateParams {
|
|
588
|
+
interface LineItems {
|
|
589
|
+
/**
|
|
590
|
+
* Value in specified currency's smallest unit. e.g. $10 would be represented
|
|
591
|
+
* as 1000.
|
|
592
|
+
*/
|
|
593
|
+
amount: number;
|
|
594
|
+
/**
|
|
595
|
+
* The ID of one of your accounting categories. Note that these will only be
|
|
596
|
+
* accessible if your accounting system has been connected.
|
|
597
|
+
*/
|
|
598
|
+
accounting_category_id?: string | null;
|
|
599
|
+
/**
|
|
600
|
+
* A free-form description of the line item.
|
|
601
|
+
*/
|
|
602
|
+
description?: string | null;
|
|
603
|
+
/**
|
|
604
|
+
* Additional data represented as key-value pairs. Both the key and value must be
|
|
605
|
+
* strings.
|
|
606
|
+
*/
|
|
607
|
+
metadata?: Record<string, string>;
|
|
608
|
+
}
|
|
609
|
+
}
|
|
610
|
+
export interface ExpectedPaymentUpdateParams {
|
|
611
|
+
/**
|
|
612
|
+
* The lowest amount this expected payment may be equal to. Value in specified
|
|
613
|
+
* currency's smallest unit. e.g. $10 would be represented as 1000.
|
|
614
|
+
*/
|
|
615
|
+
amount_lower_bound: number;
|
|
616
|
+
/**
|
|
617
|
+
* The highest amount this expected payment may be equal to. Value in specified
|
|
618
|
+
* currency's smallest unit. e.g. $10 would be represented as 1000.
|
|
619
|
+
*/
|
|
620
|
+
amount_upper_bound: number;
|
|
621
|
+
/**
|
|
622
|
+
* One of credit or debit. When you are receiving money, use credit. When you are
|
|
623
|
+
* being charged, use debit.
|
|
624
|
+
*/
|
|
625
|
+
direction: 'credit' | 'debit';
|
|
626
|
+
/**
|
|
627
|
+
* The ID of the Internal Account for the expected payment.
|
|
628
|
+
*/
|
|
629
|
+
internal_account_id: string;
|
|
630
|
+
/**
|
|
631
|
+
* The ID of the counterparty you expect for this payment.
|
|
632
|
+
*/
|
|
633
|
+
counterparty_id?: string | null;
|
|
634
|
+
/**
|
|
635
|
+
* Must conform to ISO 4217. Defaults to the currency of the internal account.
|
|
636
|
+
*/
|
|
637
|
+
currency?:
|
|
638
|
+
| 'AED'
|
|
639
|
+
| 'AFN'
|
|
640
|
+
| 'ALL'
|
|
641
|
+
| 'AMD'
|
|
642
|
+
| 'ANG'
|
|
643
|
+
| 'AOA'
|
|
644
|
+
| 'ARS'
|
|
645
|
+
| 'AUD'
|
|
646
|
+
| 'AWG'
|
|
647
|
+
| 'AZN'
|
|
648
|
+
| 'BAM'
|
|
649
|
+
| 'BBD'
|
|
650
|
+
| 'BCH'
|
|
651
|
+
| 'BDT'
|
|
652
|
+
| 'BGN'
|
|
653
|
+
| 'BHD'
|
|
654
|
+
| 'BIF'
|
|
655
|
+
| 'BMD'
|
|
656
|
+
| 'BND'
|
|
657
|
+
| 'BOB'
|
|
658
|
+
| 'BRL'
|
|
659
|
+
| 'BSD'
|
|
660
|
+
| 'BTC'
|
|
661
|
+
| 'BTN'
|
|
662
|
+
| 'BWP'
|
|
663
|
+
| 'BYN'
|
|
664
|
+
| 'BYR'
|
|
665
|
+
| 'BZD'
|
|
666
|
+
| 'CAD'
|
|
667
|
+
| 'CDF'
|
|
668
|
+
| 'CHF'
|
|
669
|
+
| 'CLF'
|
|
670
|
+
| 'CLP'
|
|
671
|
+
| 'CNH'
|
|
672
|
+
| 'CNY'
|
|
673
|
+
| 'COP'
|
|
674
|
+
| 'CRC'
|
|
675
|
+
| 'CUC'
|
|
676
|
+
| 'CUP'
|
|
677
|
+
| 'CVE'
|
|
678
|
+
| 'CZK'
|
|
679
|
+
| 'DJF'
|
|
680
|
+
| 'DKK'
|
|
681
|
+
| 'DOP'
|
|
682
|
+
| 'DZD'
|
|
683
|
+
| 'EEK'
|
|
684
|
+
| 'EGP'
|
|
685
|
+
| 'ERN'
|
|
686
|
+
| 'ETB'
|
|
687
|
+
| 'EUR'
|
|
688
|
+
| 'FJD'
|
|
689
|
+
| 'FKP'
|
|
690
|
+
| 'GBP'
|
|
691
|
+
| 'GBX'
|
|
692
|
+
| 'GEL'
|
|
693
|
+
| 'GGP'
|
|
694
|
+
| 'GHS'
|
|
695
|
+
| 'GIP'
|
|
696
|
+
| 'GMD'
|
|
697
|
+
| 'GNF'
|
|
698
|
+
| 'GTQ'
|
|
699
|
+
| 'GYD'
|
|
700
|
+
| 'HKD'
|
|
701
|
+
| 'HNL'
|
|
702
|
+
| 'HRK'
|
|
703
|
+
| 'HTG'
|
|
704
|
+
| 'HUF'
|
|
705
|
+
| 'IDR'
|
|
706
|
+
| 'ILS'
|
|
707
|
+
| 'IMP'
|
|
708
|
+
| 'INR'
|
|
709
|
+
| 'IQD'
|
|
710
|
+
| 'IRR'
|
|
711
|
+
| 'ISK'
|
|
712
|
+
| 'JEP'
|
|
713
|
+
| 'JMD'
|
|
714
|
+
| 'JOD'
|
|
715
|
+
| 'JPY'
|
|
716
|
+
| 'KES'
|
|
717
|
+
| 'KGS'
|
|
718
|
+
| 'KHR'
|
|
719
|
+
| 'KMF'
|
|
720
|
+
| 'KPW'
|
|
721
|
+
| 'KRW'
|
|
722
|
+
| 'KWD'
|
|
723
|
+
| 'KYD'
|
|
724
|
+
| 'KZT'
|
|
725
|
+
| 'LAK'
|
|
726
|
+
| 'LBP'
|
|
727
|
+
| 'LKR'
|
|
728
|
+
| 'LRD'
|
|
729
|
+
| 'LSL'
|
|
730
|
+
| 'LTL'
|
|
731
|
+
| 'LVL'
|
|
732
|
+
| 'LYD'
|
|
733
|
+
| 'MAD'
|
|
734
|
+
| 'MDL'
|
|
735
|
+
| 'MGA'
|
|
736
|
+
| 'MKD'
|
|
737
|
+
| 'MMK'
|
|
738
|
+
| 'MNT'
|
|
739
|
+
| 'MOP'
|
|
740
|
+
| 'MRO'
|
|
741
|
+
| 'MRU'
|
|
742
|
+
| 'MTL'
|
|
743
|
+
| 'MUR'
|
|
744
|
+
| 'MVR'
|
|
745
|
+
| 'MWK'
|
|
746
|
+
| 'MXN'
|
|
747
|
+
| 'MYR'
|
|
748
|
+
| 'MZN'
|
|
749
|
+
| 'NAD'
|
|
750
|
+
| 'NGN'
|
|
751
|
+
| 'NIO'
|
|
752
|
+
| 'NOK'
|
|
753
|
+
| 'NPR'
|
|
754
|
+
| 'NZD'
|
|
755
|
+
| 'OMR'
|
|
756
|
+
| 'PAB'
|
|
757
|
+
| 'PEN'
|
|
758
|
+
| 'PGK'
|
|
759
|
+
| 'PHP'
|
|
760
|
+
| 'PKR'
|
|
761
|
+
| 'PLN'
|
|
762
|
+
| 'PYG'
|
|
763
|
+
| 'QAR'
|
|
764
|
+
| 'RON'
|
|
765
|
+
| 'RSD'
|
|
766
|
+
| 'RUB'
|
|
767
|
+
| 'RWF'
|
|
768
|
+
| 'SAR'
|
|
769
|
+
| 'SBD'
|
|
770
|
+
| 'SCR'
|
|
771
|
+
| 'SDG'
|
|
772
|
+
| 'SEK'
|
|
773
|
+
| 'SGD'
|
|
774
|
+
| 'SHP'
|
|
775
|
+
| 'SKK'
|
|
776
|
+
| 'SLL'
|
|
777
|
+
| 'SOS'
|
|
778
|
+
| 'SRD'
|
|
779
|
+
| 'SSP'
|
|
780
|
+
| 'STD'
|
|
781
|
+
| 'SVC'
|
|
782
|
+
| 'SYP'
|
|
783
|
+
| 'SZL'
|
|
784
|
+
| 'THB'
|
|
785
|
+
| 'TJS'
|
|
786
|
+
| 'TMM'
|
|
787
|
+
| 'TMT'
|
|
788
|
+
| 'TND'
|
|
789
|
+
| 'TOP'
|
|
790
|
+
| 'TRY'
|
|
791
|
+
| 'TTD'
|
|
792
|
+
| 'TWD'
|
|
793
|
+
| 'TZS'
|
|
794
|
+
| 'UAH'
|
|
795
|
+
| 'UGX'
|
|
796
|
+
| 'USD'
|
|
797
|
+
| 'UYU'
|
|
798
|
+
| 'UZS'
|
|
799
|
+
| 'VEF'
|
|
800
|
+
| 'VES'
|
|
801
|
+
| 'VND'
|
|
802
|
+
| 'VUV'
|
|
803
|
+
| 'WST'
|
|
804
|
+
| 'XAF'
|
|
805
|
+
| 'XAG'
|
|
806
|
+
| 'XAU'
|
|
807
|
+
| 'XBA'
|
|
808
|
+
| 'XBB'
|
|
809
|
+
| 'XBC'
|
|
810
|
+
| 'XBD'
|
|
811
|
+
| 'XCD'
|
|
812
|
+
| 'XDR'
|
|
813
|
+
| 'XFU'
|
|
814
|
+
| 'XOF'
|
|
815
|
+
| 'XPD'
|
|
816
|
+
| 'XPF'
|
|
817
|
+
| 'XPT'
|
|
818
|
+
| 'XTS'
|
|
819
|
+
| 'YER'
|
|
820
|
+
| 'ZAR'
|
|
821
|
+
| 'ZMK'
|
|
822
|
+
| 'ZMW'
|
|
823
|
+
| 'ZWD'
|
|
824
|
+
| 'ZWL'
|
|
825
|
+
| 'ZWN'
|
|
826
|
+
| 'ZWR';
|
|
827
|
+
/**
|
|
828
|
+
* The earliest date the payment may come in. Format: yyyy-mm-dd
|
|
829
|
+
*/
|
|
830
|
+
date_lower_bound?: string | null;
|
|
831
|
+
/**
|
|
832
|
+
* The latest date the payment may come in. Format: yyyy-mm-dd
|
|
833
|
+
*/
|
|
834
|
+
date_upper_bound?: string | null;
|
|
835
|
+
/**
|
|
836
|
+
* An optional description for internal use.
|
|
837
|
+
*/
|
|
838
|
+
description?: string | null;
|
|
839
|
+
/**
|
|
840
|
+
* Additional data represented as key-value pairs. Both the key and value must be
|
|
841
|
+
* strings.
|
|
842
|
+
*/
|
|
843
|
+
metadata?: Record<string, string>;
|
|
844
|
+
/**
|
|
845
|
+
* For `ach`, this field will be passed through on an addenda record. For `wire`
|
|
846
|
+
* payments the field will be passed through as the "Originator to Beneficiary
|
|
847
|
+
* Information", also known as OBI or Fedwire tag 6000.
|
|
848
|
+
*/
|
|
849
|
+
remittance_information?: string | null;
|
|
850
|
+
/**
|
|
851
|
+
* The statement description you expect to see on the transaction. For ACH
|
|
852
|
+
* payments, this will be the full line item passed from the bank. For wire
|
|
853
|
+
* payments, this will be the OBI field on the wire. For check payments, this will
|
|
854
|
+
* be the memo field.
|
|
855
|
+
*/
|
|
856
|
+
statement_descriptor?: string | null;
|
|
857
|
+
/**
|
|
858
|
+
* One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
|
|
859
|
+
* sepa, signet, wire.
|
|
860
|
+
*/
|
|
861
|
+
type?:
|
|
862
|
+
| 'ach'
|
|
863
|
+
| 'au_becs'
|
|
864
|
+
| 'bacs'
|
|
865
|
+
| 'book'
|
|
866
|
+
| 'card'
|
|
867
|
+
| 'check'
|
|
868
|
+
| 'eft'
|
|
869
|
+
| 'interac'
|
|
870
|
+
| 'provxchange'
|
|
871
|
+
| 'rtp'
|
|
872
|
+
| 'sen'
|
|
873
|
+
| 'sepa'
|
|
874
|
+
| 'signet'
|
|
875
|
+
| 'wire'
|
|
876
|
+
| null;
|
|
877
|
+
}
|
|
878
|
+
export interface ExpectedPaymentListParams extends PageParams {
|
|
879
|
+
/**
|
|
880
|
+
* Specify counterparty_id to see expected_payments for a specific account.
|
|
881
|
+
*/
|
|
882
|
+
counterparty_id?: string;
|
|
883
|
+
/**
|
|
884
|
+
* Used to return expected payments created after some datetime
|
|
885
|
+
*/
|
|
886
|
+
created_at_lower_bound?: string;
|
|
887
|
+
/**
|
|
888
|
+
* Used to return expected payments created before some datetime
|
|
889
|
+
*/
|
|
890
|
+
created_at_upper_bound?: string;
|
|
891
|
+
/**
|
|
892
|
+
* One of credit, debit
|
|
893
|
+
*/
|
|
894
|
+
direction?: 'credit' | 'debit';
|
|
895
|
+
/**
|
|
896
|
+
* Specify internal_account_id to see expected_payments for a specific account.
|
|
897
|
+
*/
|
|
898
|
+
internal_account_id?: string;
|
|
899
|
+
/**
|
|
900
|
+
* For example, if you want to query for records with metadata key `Type` and value
|
|
901
|
+
* `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
|
|
902
|
+
* parameters.
|
|
903
|
+
*/
|
|
904
|
+
metadata?: Record<string, string>;
|
|
905
|
+
/**
|
|
906
|
+
* One of unreconciled, reconciled, or archived.
|
|
907
|
+
*/
|
|
908
|
+
status?: 'archived' | 'reconciled' | 'unreconciled';
|
|
909
|
+
/**
|
|
910
|
+
* One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
|
|
911
|
+
* sepa, signet, wire
|
|
912
|
+
*/
|
|
913
|
+
type?:
|
|
914
|
+
| 'ach'
|
|
915
|
+
| 'au_becs'
|
|
916
|
+
| 'bacs'
|
|
917
|
+
| 'book'
|
|
918
|
+
| 'card'
|
|
919
|
+
| 'check'
|
|
920
|
+
| 'eft'
|
|
921
|
+
| 'interac'
|
|
922
|
+
| 'provxchange'
|
|
923
|
+
| 'rtp'
|
|
924
|
+
| 'sen'
|
|
925
|
+
| 'sepa'
|
|
926
|
+
| 'signet'
|
|
927
|
+
| 'wire';
|
|
928
|
+
}
|