-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathach_transfers.py
More file actions
839 lines (694 loc) · 35.3 KB
/
ach_transfers.py
File metadata and controls
839 lines (694 loc) · 35.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing_extensions import Literal
import httpx
from ..types import ach_transfer_list_params, ach_transfer_create_params
from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
from .._utils import (
maybe_transform,
async_maybe_transform,
)
from .._compat import cached_property
from .._resource import SyncAPIResource, AsyncAPIResource
from .._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ..pagination import SyncPage, AsyncPage
from .._base_client import AsyncPaginator, make_request_options
from ..types.ach_transfer import ACHTransfer
__all__ = ["ACHTransfersResource", "AsyncACHTransfersResource"]
class ACHTransfersResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> ACHTransfersResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/Increase/increase-python#accessing-raw-response-data-eg-headers
"""
return ACHTransfersResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> ACHTransfersResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/Increase/increase-python#with_streaming_response
"""
return ACHTransfersResourceWithStreamingResponse(self)
def create(
self,
*,
account_id: str,
amount: int,
statement_descriptor: str,
account_number: str | NotGiven = NOT_GIVEN,
addenda: ach_transfer_create_params.Addenda | NotGiven = NOT_GIVEN,
company_descriptive_date: str | NotGiven = NOT_GIVEN,
company_discretionary_data: str | NotGiven = NOT_GIVEN,
company_entry_description: str | NotGiven = NOT_GIVEN,
company_name: str | NotGiven = NOT_GIVEN,
destination_account_holder: Literal["business", "individual", "unknown"] | NotGiven = NOT_GIVEN,
external_account_id: str | NotGiven = NOT_GIVEN,
funding: Literal["checking", "savings"] | NotGiven = NOT_GIVEN,
individual_id: str | NotGiven = NOT_GIVEN,
individual_name: str | NotGiven = NOT_GIVEN,
preferred_effective_date: ach_transfer_create_params.PreferredEffectiveDate | NotGiven = NOT_GIVEN,
require_approval: bool | NotGiven = NOT_GIVEN,
routing_number: str | NotGiven = NOT_GIVEN,
standard_entry_class_code: Literal[
"corporate_credit_or_debit",
"corporate_trade_exchange",
"prearranged_payments_and_deposit",
"internet_initiated",
]
| NotGiven = NOT_GIVEN,
transaction_timing: Literal["synchronous", "asynchronous"] | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
idempotency_key: str | None = None,
) -> ACHTransfer:
"""
Create an ACH Transfer
Args:
account_id: The Increase identifier for the account that will send the transfer.
amount: The transfer amount in USD cents. A positive amount originates a credit transfer
pushing funds to the receiving account. A negative amount originates a debit
transfer pulling funds from the receiving account.
statement_descriptor: A description you choose to give the transfer. This will be saved with the
transfer details, displayed in the dashboard, and returned by the API. If
`individual_name` and `company_name` are not explicitly set by this API, the
`statement_descriptor` will be sent in those fields to the receiving bank to
help the customer recognize the transfer. You are highly encouraged to pass
`individual_name` and `company_name` instead of relying on this fallback.
account_number: The account number for the destination account.
addenda: Additional information that will be sent to the recipient. This is included in
the transfer data sent to the receiving bank.
company_descriptive_date: The description of the date of the transfer, usually in the format `YYMMDD`.
This is included in the transfer data sent to the receiving bank.
company_discretionary_data: The data you choose to associate with the transfer. This is included in the
transfer data sent to the receiving bank.
company_entry_description: A description of the transfer. This is included in the transfer data sent to the
receiving bank.
company_name: The name by which the recipient knows you. This is included in the transfer data
sent to the receiving bank.
destination_account_holder: The type of entity that owns the account to which the ACH Transfer is being
sent.
- `business` - The External Account is owned by a business.
- `individual` - The External Account is owned by an individual.
- `unknown` - It's unknown what kind of entity owns the External Account.
external_account_id: The ID of an External Account to initiate a transfer to. If this parameter is
provided, `account_number`, `routing_number`, and `funding` must be absent.
funding: The type of the account to which the transfer will be sent.
- `checking` - A checking account.
- `savings` - A savings account.
individual_id: Your identifier for the transfer recipient.
individual_name: The name of the transfer recipient. This value is informational and not verified
by the recipient's bank.
preferred_effective_date: Configuration for how the effective date of the transfer will be set. This
determines same-day vs future-dated settlement timing. If not set, defaults to a
`settlement_schedule` of `same_day`. If set, exactly one of the child attributes
must be set.
require_approval: Whether the transfer requires explicit approval via the dashboard or API.
routing_number: The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
destination account.
standard_entry_class_code: The Standard Entry Class (SEC) code to use for the transfer.
- `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
- `corporate_trade_exchange` - Corporate Trade Exchange (CTX).
- `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
- `internet_initiated` - Internet Initiated (WEB).
transaction_timing: The timing of the transaction.
- `synchronous` - A Transaction will be created immediately.
- `asynchronous` - A Transaction will be created when the funds settle at the
Federal Reserve.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
idempotency_key: Specify a custom idempotency key for this request
"""
return self._post(
"/ach_transfers",
body=maybe_transform(
{
"account_id": account_id,
"amount": amount,
"statement_descriptor": statement_descriptor,
"account_number": account_number,
"addenda": addenda,
"company_descriptive_date": company_descriptive_date,
"company_discretionary_data": company_discretionary_data,
"company_entry_description": company_entry_description,
"company_name": company_name,
"destination_account_holder": destination_account_holder,
"external_account_id": external_account_id,
"funding": funding,
"individual_id": individual_id,
"individual_name": individual_name,
"preferred_effective_date": preferred_effective_date,
"require_approval": require_approval,
"routing_number": routing_number,
"standard_entry_class_code": standard_entry_class_code,
"transaction_timing": transaction_timing,
},
ach_transfer_create_params.ACHTransferCreateParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=ACHTransfer,
)
def retrieve(
self,
ach_transfer_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ACHTransfer:
"""
Retrieve an ACH Transfer
Args:
ach_transfer_id: The identifier of the ACH Transfer.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not ach_transfer_id:
raise ValueError(f"Expected a non-empty value for `ach_transfer_id` but received {ach_transfer_id!r}")
return self._get(
f"/ach_transfers/{ach_transfer_id}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=ACHTransfer,
)
def list(
self,
*,
account_id: str | NotGiven = NOT_GIVEN,
created_at: ach_transfer_list_params.CreatedAt | NotGiven = NOT_GIVEN,
cursor: str | NotGiven = NOT_GIVEN,
external_account_id: str | NotGiven = NOT_GIVEN,
idempotency_key: str | NotGiven = NOT_GIVEN,
limit: int | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> SyncPage[ACHTransfer]:
"""
List ACH Transfers
Args:
account_id: Filter ACH Transfers to those that originated from the specified Account.
cursor: Return the page of entries after this one.
external_account_id: Filter ACH Transfers to those made to the specified External Account.
idempotency_key: Filter records to the one with the specified `idempotency_key` you chose for
that object. This value is unique across Increase and is used to ensure that a
request is only processed once. Learn more about
[idempotency](https://increase.com/documentation/idempotency-keys).
limit: Limit the size of the list that is returned. The default (and maximum) is 100
objects.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get_api_list(
"/ach_transfers",
page=SyncPage[ACHTransfer],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"account_id": account_id,
"created_at": created_at,
"cursor": cursor,
"external_account_id": external_account_id,
"idempotency_key": idempotency_key,
"limit": limit,
},
ach_transfer_list_params.ACHTransferListParams,
),
),
model=ACHTransfer,
)
def approve(
self,
ach_transfer_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
idempotency_key: str | None = None,
) -> ACHTransfer:
"""
Approves an ACH Transfer in a pending_approval state.
Args:
ach_transfer_id: The identifier of the ACH Transfer to approve.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
idempotency_key: Specify a custom idempotency key for this request
"""
if not ach_transfer_id:
raise ValueError(f"Expected a non-empty value for `ach_transfer_id` but received {ach_transfer_id!r}")
return self._post(
f"/ach_transfers/{ach_transfer_id}/approve",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=ACHTransfer,
)
def cancel(
self,
ach_transfer_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
idempotency_key: str | None = None,
) -> ACHTransfer:
"""
Cancels an ACH Transfer in a pending_approval state.
Args:
ach_transfer_id: The identifier of the pending ACH Transfer to cancel.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
idempotency_key: Specify a custom idempotency key for this request
"""
if not ach_transfer_id:
raise ValueError(f"Expected a non-empty value for `ach_transfer_id` but received {ach_transfer_id!r}")
return self._post(
f"/ach_transfers/{ach_transfer_id}/cancel",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=ACHTransfer,
)
class AsyncACHTransfersResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncACHTransfersResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/Increase/increase-python#accessing-raw-response-data-eg-headers
"""
return AsyncACHTransfersResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncACHTransfersResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/Increase/increase-python#with_streaming_response
"""
return AsyncACHTransfersResourceWithStreamingResponse(self)
async def create(
self,
*,
account_id: str,
amount: int,
statement_descriptor: str,
account_number: str | NotGiven = NOT_GIVEN,
addenda: ach_transfer_create_params.Addenda | NotGiven = NOT_GIVEN,
company_descriptive_date: str | NotGiven = NOT_GIVEN,
company_discretionary_data: str | NotGiven = NOT_GIVEN,
company_entry_description: str | NotGiven = NOT_GIVEN,
company_name: str | NotGiven = NOT_GIVEN,
destination_account_holder: Literal["business", "individual", "unknown"] | NotGiven = NOT_GIVEN,
external_account_id: str | NotGiven = NOT_GIVEN,
funding: Literal["checking", "savings"] | NotGiven = NOT_GIVEN,
individual_id: str | NotGiven = NOT_GIVEN,
individual_name: str | NotGiven = NOT_GIVEN,
preferred_effective_date: ach_transfer_create_params.PreferredEffectiveDate | NotGiven = NOT_GIVEN,
require_approval: bool | NotGiven = NOT_GIVEN,
routing_number: str | NotGiven = NOT_GIVEN,
standard_entry_class_code: Literal[
"corporate_credit_or_debit",
"corporate_trade_exchange",
"prearranged_payments_and_deposit",
"internet_initiated",
]
| NotGiven = NOT_GIVEN,
transaction_timing: Literal["synchronous", "asynchronous"] | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
idempotency_key: str | None = None,
) -> ACHTransfer:
"""
Create an ACH Transfer
Args:
account_id: The Increase identifier for the account that will send the transfer.
amount: The transfer amount in USD cents. A positive amount originates a credit transfer
pushing funds to the receiving account. A negative amount originates a debit
transfer pulling funds from the receiving account.
statement_descriptor: A description you choose to give the transfer. This will be saved with the
transfer details, displayed in the dashboard, and returned by the API. If
`individual_name` and `company_name` are not explicitly set by this API, the
`statement_descriptor` will be sent in those fields to the receiving bank to
help the customer recognize the transfer. You are highly encouraged to pass
`individual_name` and `company_name` instead of relying on this fallback.
account_number: The account number for the destination account.
addenda: Additional information that will be sent to the recipient. This is included in
the transfer data sent to the receiving bank.
company_descriptive_date: The description of the date of the transfer, usually in the format `YYMMDD`.
This is included in the transfer data sent to the receiving bank.
company_discretionary_data: The data you choose to associate with the transfer. This is included in the
transfer data sent to the receiving bank.
company_entry_description: A description of the transfer. This is included in the transfer data sent to the
receiving bank.
company_name: The name by which the recipient knows you. This is included in the transfer data
sent to the receiving bank.
destination_account_holder: The type of entity that owns the account to which the ACH Transfer is being
sent.
- `business` - The External Account is owned by a business.
- `individual` - The External Account is owned by an individual.
- `unknown` - It's unknown what kind of entity owns the External Account.
external_account_id: The ID of an External Account to initiate a transfer to. If this parameter is
provided, `account_number`, `routing_number`, and `funding` must be absent.
funding: The type of the account to which the transfer will be sent.
- `checking` - A checking account.
- `savings` - A savings account.
individual_id: Your identifier for the transfer recipient.
individual_name: The name of the transfer recipient. This value is informational and not verified
by the recipient's bank.
preferred_effective_date: Configuration for how the effective date of the transfer will be set. This
determines same-day vs future-dated settlement timing. If not set, defaults to a
`settlement_schedule` of `same_day`. If set, exactly one of the child attributes
must be set.
require_approval: Whether the transfer requires explicit approval via the dashboard or API.
routing_number: The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
destination account.
standard_entry_class_code: The Standard Entry Class (SEC) code to use for the transfer.
- `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
- `corporate_trade_exchange` - Corporate Trade Exchange (CTX).
- `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
- `internet_initiated` - Internet Initiated (WEB).
transaction_timing: The timing of the transaction.
- `synchronous` - A Transaction will be created immediately.
- `asynchronous` - A Transaction will be created when the funds settle at the
Federal Reserve.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
idempotency_key: Specify a custom idempotency key for this request
"""
return await self._post(
"/ach_transfers",
body=await async_maybe_transform(
{
"account_id": account_id,
"amount": amount,
"statement_descriptor": statement_descriptor,
"account_number": account_number,
"addenda": addenda,
"company_descriptive_date": company_descriptive_date,
"company_discretionary_data": company_discretionary_data,
"company_entry_description": company_entry_description,
"company_name": company_name,
"destination_account_holder": destination_account_holder,
"external_account_id": external_account_id,
"funding": funding,
"individual_id": individual_id,
"individual_name": individual_name,
"preferred_effective_date": preferred_effective_date,
"require_approval": require_approval,
"routing_number": routing_number,
"standard_entry_class_code": standard_entry_class_code,
"transaction_timing": transaction_timing,
},
ach_transfer_create_params.ACHTransferCreateParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=ACHTransfer,
)
async def retrieve(
self,
ach_transfer_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ACHTransfer:
"""
Retrieve an ACH Transfer
Args:
ach_transfer_id: The identifier of the ACH Transfer.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not ach_transfer_id:
raise ValueError(f"Expected a non-empty value for `ach_transfer_id` but received {ach_transfer_id!r}")
return await self._get(
f"/ach_transfers/{ach_transfer_id}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=ACHTransfer,
)
def list(
self,
*,
account_id: str | NotGiven = NOT_GIVEN,
created_at: ach_transfer_list_params.CreatedAt | NotGiven = NOT_GIVEN,
cursor: str | NotGiven = NOT_GIVEN,
external_account_id: str | NotGiven = NOT_GIVEN,
idempotency_key: str | NotGiven = NOT_GIVEN,
limit: int | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> AsyncPaginator[ACHTransfer, AsyncPage[ACHTransfer]]:
"""
List ACH Transfers
Args:
account_id: Filter ACH Transfers to those that originated from the specified Account.
cursor: Return the page of entries after this one.
external_account_id: Filter ACH Transfers to those made to the specified External Account.
idempotency_key: Filter records to the one with the specified `idempotency_key` you chose for
that object. This value is unique across Increase and is used to ensure that a
request is only processed once. Learn more about
[idempotency](https://increase.com/documentation/idempotency-keys).
limit: Limit the size of the list that is returned. The default (and maximum) is 100
objects.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get_api_list(
"/ach_transfers",
page=AsyncPage[ACHTransfer],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"account_id": account_id,
"created_at": created_at,
"cursor": cursor,
"external_account_id": external_account_id,
"idempotency_key": idempotency_key,
"limit": limit,
},
ach_transfer_list_params.ACHTransferListParams,
),
),
model=ACHTransfer,
)
async def approve(
self,
ach_transfer_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
idempotency_key: str | None = None,
) -> ACHTransfer:
"""
Approves an ACH Transfer in a pending_approval state.
Args:
ach_transfer_id: The identifier of the ACH Transfer to approve.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
idempotency_key: Specify a custom idempotency key for this request
"""
if not ach_transfer_id:
raise ValueError(f"Expected a non-empty value for `ach_transfer_id` but received {ach_transfer_id!r}")
return await self._post(
f"/ach_transfers/{ach_transfer_id}/approve",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=ACHTransfer,
)
async def cancel(
self,
ach_transfer_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
idempotency_key: str | None = None,
) -> ACHTransfer:
"""
Cancels an ACH Transfer in a pending_approval state.
Args:
ach_transfer_id: The identifier of the pending ACH Transfer to cancel.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
idempotency_key: Specify a custom idempotency key for this request
"""
if not ach_transfer_id:
raise ValueError(f"Expected a non-empty value for `ach_transfer_id` but received {ach_transfer_id!r}")
return await self._post(
f"/ach_transfers/{ach_transfer_id}/cancel",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=ACHTransfer,
)
class ACHTransfersResourceWithRawResponse:
def __init__(self, ach_transfers: ACHTransfersResource) -> None:
self._ach_transfers = ach_transfers
self.create = to_raw_response_wrapper(
ach_transfers.create,
)
self.retrieve = to_raw_response_wrapper(
ach_transfers.retrieve,
)
self.list = to_raw_response_wrapper(
ach_transfers.list,
)
self.approve = to_raw_response_wrapper(
ach_transfers.approve,
)
self.cancel = to_raw_response_wrapper(
ach_transfers.cancel,
)
class AsyncACHTransfersResourceWithRawResponse:
def __init__(self, ach_transfers: AsyncACHTransfersResource) -> None:
self._ach_transfers = ach_transfers
self.create = async_to_raw_response_wrapper(
ach_transfers.create,
)
self.retrieve = async_to_raw_response_wrapper(
ach_transfers.retrieve,
)
self.list = async_to_raw_response_wrapper(
ach_transfers.list,
)
self.approve = async_to_raw_response_wrapper(
ach_transfers.approve,
)
self.cancel = async_to_raw_response_wrapper(
ach_transfers.cancel,
)
class ACHTransfersResourceWithStreamingResponse:
def __init__(self, ach_transfers: ACHTransfersResource) -> None:
self._ach_transfers = ach_transfers
self.create = to_streamed_response_wrapper(
ach_transfers.create,
)
self.retrieve = to_streamed_response_wrapper(
ach_transfers.retrieve,
)
self.list = to_streamed_response_wrapper(
ach_transfers.list,
)
self.approve = to_streamed_response_wrapper(
ach_transfers.approve,
)
self.cancel = to_streamed_response_wrapper(
ach_transfers.cancel,
)
class AsyncACHTransfersResourceWithStreamingResponse:
def __init__(self, ach_transfers: AsyncACHTransfersResource) -> None:
self._ach_transfers = ach_transfers
self.create = async_to_streamed_response_wrapper(
ach_transfers.create,
)
self.retrieve = async_to_streamed_response_wrapper(
ach_transfers.retrieve,
)
self.list = async_to_streamed_response_wrapper(
ach_transfers.list,
)
self.approve = async_to_streamed_response_wrapper(
ach_transfers.approve,
)
self.cancel = async_to_streamed_response_wrapper(
ach_transfers.cancel,
)