increase 0.11.0 → 0.11.2
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/CHANGELOG.md +30 -0
- package/README.md +8 -4
- package/_shims/MultipartBody.d.ts +9 -0
- package/_shims/MultipartBody.d.ts.map +1 -0
- package/_shims/MultipartBody.js +16 -0
- package/_shims/MultipartBody.js.map +1 -0
- package/_shims/MultipartBody.mjs +12 -0
- package/_shims/MultipartBody.mjs.map +1 -0
- package/_shims/README.md +46 -0
- package/{src/_shims/ReadableStream-node.ts → _shims/auto/runtime-bun.d.ts} +2 -3
- package/_shims/auto/runtime-bun.d.ts.map +1 -0
- package/_shims/auto/runtime-bun.js +21 -0
- package/_shims/auto/runtime-bun.js.map +1 -0
- package/_shims/auto/runtime-bun.mjs +2 -0
- package/_shims/auto/runtime-bun.mjs.map +1 -0
- package/_shims/auto/runtime-node.d.ts +5 -0
- package/_shims/auto/runtime-node.d.ts.map +1 -0
- package/_shims/auto/runtime-node.js +21 -0
- package/_shims/auto/runtime-node.js.map +1 -0
- package/_shims/auto/runtime-node.mjs +2 -0
- package/_shims/auto/runtime-node.mjs.map +1 -0
- package/_shims/auto/runtime.d.ts +5 -0
- package/_shims/auto/runtime.d.ts.map +1 -0
- package/_shims/auto/runtime.js +21 -0
- package/_shims/auto/runtime.js.map +1 -0
- package/_shims/auto/runtime.mjs +2 -0
- package/_shims/auto/runtime.mjs.map +1 -0
- package/_shims/auto/types-node.d.ts +5 -0
- package/_shims/auto/types-node.d.ts.map +1 -0
- package/_shims/auto/types-node.js +21 -0
- package/_shims/auto/types-node.js.map +1 -0
- package/_shims/auto/types-node.mjs +2 -0
- package/_shims/auto/types-node.mjs.map +1 -0
- package/_shims/auto/types.d.ts +99 -0
- package/_shims/{ReadableStream.js → auto/types.js} +0 -2
- package/{src/_shims/ReadableStream.js → _shims/auto/types.mjs} +0 -2
- package/_shims/bun-runtime.d.ts +6 -0
- package/_shims/bun-runtime.d.ts.map +1 -0
- package/_shims/bun-runtime.js +14 -0
- package/_shims/bun-runtime.js.map +1 -0
- package/_shims/bun-runtime.mjs +10 -0
- package/_shims/bun-runtime.mjs.map +1 -0
- package/_shims/index.d.ts +79 -0
- package/_shims/index.js +13 -0
- package/_shims/index.mjs +7 -0
- package/_shims/manual-types.d.ts +12 -0
- package/_shims/manual-types.js +3 -0
- package/_shims/manual-types.mjs +3 -0
- package/_shims/node-runtime.d.ts +3 -0
- package/_shims/node-runtime.d.ts.map +1 -0
- package/_shims/node-runtime.js +87 -0
- package/_shims/node-runtime.js.map +1 -0
- package/_shims/node-runtime.mjs +54 -0
- package/_shims/node-runtime.mjs.map +1 -0
- package/_shims/node-types.d.ts +42 -0
- package/_shims/node-types.js +3 -0
- package/_shims/node-types.mjs +3 -0
- package/_shims/registry.d.ts +35 -0
- package/_shims/registry.d.ts.map +1 -0
- package/_shims/registry.js +39 -0
- package/_shims/registry.js.map +1 -0
- package/_shims/registry.mjs +35 -0
- package/_shims/registry.mjs.map +1 -0
- package/_shims/web-runtime.d.ts +5 -0
- package/_shims/web-runtime.d.ts.map +1 -0
- package/_shims/web-runtime.js +70 -0
- package/_shims/web-runtime.js.map +1 -0
- package/_shims/web-runtime.mjs +63 -0
- package/_shims/web-runtime.mjs.map +1 -0
- package/_shims/web-types.d.ts +82 -0
- package/_shims/web-types.js +3 -0
- package/_shims/web-types.mjs +3 -0
- package/core.d.ts +170 -218
- package/core.d.ts.map +1 -1
- package/core.js +673 -729
- package/core.js.map +1 -1
- package/core.mjs +667 -680
- package/core.mjs.map +1 -1
- package/error.d.ts +104 -177
- package/error.js +247 -280
- package/error.js.map +1 -1
- package/error.mjs +244 -252
- package/error.mjs.map +1 -1
- package/index.d.mts +332 -356
- package/index.d.ts +332 -356
- package/index.d.ts.map +1 -1
- package/index.js +193 -264
- package/index.mjs +170 -198
- package/package.json +31 -23
- package/pagination.d.ts +25 -25
- package/pagination.js +29 -25
- package/pagination.mjs +27 -23
- package/resource.d.ts +10 -10
- package/resource.js +12 -12
- package/resource.mjs +10 -10
- package/resources/account-numbers.d.ts +162 -168
- package/resources/account-numbers.js +33 -31
- package/resources/account-numbers.mjs +28 -26
- package/resources/account-statements.d.ts +79 -81
- package/resources/account-statements.js +21 -21
- package/resources/account-statements.mjs +16 -14
- package/resources/account-transfers.d.ts +192 -194
- package/resources/account-transfers.js +39 -39
- package/resources/account-transfers.mjs +34 -32
- package/resources/accounts.d.ts +148 -151
- package/resources/accounts.js +39 -37
- package/resources/accounts.mjs +34 -32
- package/resources/ach-prenotifications.d.ts +370 -438
- package/resources/ach-prenotifications.d.ts.map +1 -1
- package/resources/ach-prenotifications.js +27 -27
- package/resources/ach-prenotifications.js.map +1 -1
- package/resources/ach-prenotifications.mjs +22 -20
- package/resources/ach-prenotifications.mjs.map +1 -1
- package/resources/ach-transfers.d.ts +604 -679
- package/resources/ach-transfers.d.ts.map +1 -1
- package/resources/ach-transfers.js +39 -37
- package/resources/ach-transfers.js.map +1 -1
- package/resources/ach-transfers.mjs +34 -32
- package/resources/ach-transfers.mjs.map +1 -1
- package/resources/balance-lookups.d.ts +35 -38
- package/resources/balance-lookups.js +12 -11
- package/resources/balance-lookups.mjs +9 -8
- package/resources/bookkeeping-accounts.d.ts +66 -70
- package/resources/bookkeeping-accounts.js +21 -21
- package/resources/bookkeeping-accounts.mjs +16 -14
- package/resources/bookkeeping-entries.d.ts +36 -37
- package/resources/bookkeeping-entries.js +15 -15
- package/resources/bookkeeping-entries.mjs +10 -8
- package/resources/bookkeeping-entry-sets.d.ts +61 -64
- package/resources/bookkeeping-entry-sets.js +12 -13
- package/resources/bookkeeping-entry-sets.mjs +9 -8
- package/resources/card-disputes.d.ts +127 -129
- package/resources/card-disputes.js +27 -25
- package/resources/card-disputes.mjs +22 -20
- package/resources/card-profiles.d.ts +235 -245
- package/resources/card-profiles.js +33 -31
- package/resources/card-profiles.mjs +28 -26
- package/resources/card-purchase-supplements.d.ts +219 -238
- package/resources/card-purchase-supplements.js +21 -21
- package/resources/card-purchase-supplements.mjs +16 -14
- package/resources/cards.d.ts +288 -279
- package/resources/cards.d.ts.map +1 -1
- package/resources/cards.js +39 -37
- package/resources/cards.js.map +1 -1
- package/resources/cards.mjs +34 -32
- package/resources/cards.mjs.map +1 -1
- package/resources/check-deposits.d.ts +238 -260
- package/resources/check-deposits.js +27 -25
- package/resources/check-deposits.mjs +22 -20
- package/resources/check-transfers.d.ts +487 -503
- package/resources/check-transfers.js +45 -43
- package/resources/check-transfers.mjs +40 -38
- package/resources/declined-transactions.d.ts +806 -918
- package/resources/declined-transactions.d.ts.map +1 -1
- package/resources/declined-transactions.js +21 -21
- package/resources/declined-transactions.js.map +1 -1
- package/resources/declined-transactions.mjs +16 -14
- package/resources/declined-transactions.mjs.map +1 -1
- package/resources/digital-wallet-tokens.d.ts +75 -77
- package/resources/digital-wallet-tokens.js +21 -21
- package/resources/digital-wallet-tokens.mjs +16 -14
- package/resources/documents.d.ts +78 -77
- package/resources/documents.js +21 -19
- package/resources/documents.mjs +16 -14
- package/resources/entities/beneficial-owners.d.ts +233 -244
- package/resources/entities/beneficial-owners.js +24 -25
- package/resources/entities/beneficial-owners.mjs +21 -20
- package/resources/entities/entities.d.ts +1532 -1585
- package/resources/entities/entities.d.ts.map +1 -1
- package/resources/entities/entities.js +67 -83
- package/resources/entities/entities.mjs +43 -42
- package/resources/entities/index.d.ts +4 -22
- package/resources/entities/index.js +12 -42
- package/resources/entities/index.mjs +4 -4
- package/resources/entities/supplemental-documents.d.ts +38 -44
- package/resources/entities/supplemental-documents.js +24 -24
- package/resources/entities/supplemental-documents.mjs +20 -18
- package/resources/event-subscriptions.d.ts +242 -355
- package/resources/event-subscriptions.js +33 -33
- package/resources/event-subscriptions.mjs +28 -26
- package/resources/events.d.ts +150 -254
- package/resources/events.js +21 -19
- package/resources/events.mjs +16 -14
- package/resources/exports.d.ts +210 -158
- package/resources/exports.d.ts.map +1 -1
- package/resources/exports.js +27 -25
- package/resources/exports.js.map +1 -1
- package/resources/exports.mjs +22 -20
- package/resources/exports.mjs.map +1 -1
- package/resources/external-accounts.d.ts +122 -128
- package/resources/external-accounts.js +33 -33
- package/resources/external-accounts.mjs +28 -26
- package/resources/files.d.ts +149 -196
- package/resources/files.js +30 -28
- package/resources/files.mjs +24 -22
- package/resources/groups.d.ts +35 -35
- package/resources/groups.js +12 -11
- package/resources/groups.mjs +9 -8
- package/resources/inbound-ach-transfers.d.ts +265 -305
- package/resources/inbound-ach-transfers.js +42 -42
- package/resources/inbound-ach-transfers.mjs +37 -35
- package/resources/inbound-wire-drawdown-requests.d.ts +113 -119
- package/resources/inbound-wire-drawdown-requests.js +24 -25
- package/resources/inbound-wire-drawdown-requests.mjs +19 -19
- package/resources/index.d.ts +39 -205
- package/resources/index.js +114 -540
- package/resources/index.mjs +39 -42
- package/resources/oauth-connections.d.ts +43 -44
- package/resources/oauth-connections.js +21 -21
- package/resources/oauth-connections.mjs +16 -14
- package/resources/pending-transactions.d.ts +560 -597
- package/resources/pending-transactions.d.ts.map +1 -1
- package/resources/pending-transactions.js +21 -21
- package/resources/pending-transactions.js.map +1 -1
- package/resources/pending-transactions.mjs +16 -14
- package/resources/pending-transactions.mjs.map +1 -1
- package/resources/programs.d.ts +41 -39
- package/resources/programs.js +21 -19
- package/resources/programs.mjs +16 -14
- package/resources/real-time-decisions.d.ts +384 -411
- package/resources/real-time-decisions.js +18 -19
- package/resources/real-time-decisions.mjs +15 -14
- package/resources/real-time-payments-transfers.d.ts +304 -342
- package/resources/real-time-payments-transfers.js +30 -30
- package/resources/real-time-payments-transfers.mjs +25 -23
- package/resources/routing-numbers.d.ts +52 -54
- package/resources/routing-numbers.js +18 -16
- package/resources/routing-numbers.mjs +14 -12
- package/resources/simulations/account-statements.d.ts +12 -15
- package/resources/simulations/account-statements.js +13 -14
- package/resources/simulations/account-statements.mjs +10 -9
- package/resources/simulations/account-transfers.d.ts +8 -11
- package/resources/simulations/account-transfers.js +13 -13
- package/resources/simulations/account-transfers.mjs +10 -10
- package/resources/simulations/ach-transfers.d.ts +3612 -3835
- package/resources/simulations/ach-transfers.d.ts.map +1 -1
- package/resources/simulations/ach-transfers.js +40 -35
- package/resources/simulations/ach-transfers.js.map +1 -1
- package/resources/simulations/ach-transfers.mjs +37 -32
- package/resources/simulations/ach-transfers.mjs.map +1 -1
- package/resources/simulations/card-disputes.d.ts +22 -26
- package/resources/simulations/card-disputes.js +15 -14
- package/resources/simulations/card-disputes.mjs +12 -11
- package/resources/simulations/card-profiles.d.ts +9 -9
- package/resources/simulations/card-profiles.js +14 -14
- package/resources/simulations/card-profiles.mjs +11 -11
- package/resources/simulations/card-refunds.d.ts +13 -16
- package/resources/simulations/card-refunds.js +13 -12
- package/resources/simulations/card-refunds.mjs +10 -9
- package/resources/simulations/cards.d.ts +1307 -1437
- package/resources/simulations/cards.d.ts.map +1 -1
- package/resources/simulations/cards.js +28 -27
- package/resources/simulations/cards.js.map +1 -1
- package/resources/simulations/cards.mjs +25 -24
- package/resources/simulations/cards.mjs.map +1 -1
- package/resources/simulations/check-deposits.d.ts +17 -17
- package/resources/simulations/check-deposits.js +26 -26
- package/resources/simulations/check-deposits.mjs +23 -23
- package/resources/simulations/check-transfers.d.ts +12 -18
- package/resources/simulations/check-transfers.js +19 -19
- package/resources/simulations/check-transfers.mjs +16 -16
- package/resources/simulations/digital-wallet-token-requests.d.ts +35 -43
- package/resources/simulations/digital-wallet-token-requests.js +13 -15
- package/resources/simulations/digital-wallet-token-requests.mjs +10 -9
- package/resources/simulations/documents.d.ts +11 -11
- package/resources/simulations/documents.js +12 -11
- package/resources/simulations/documents.mjs +9 -8
- package/resources/simulations/inbound-funds-holds.d.ts +63 -66
- package/resources/simulations/inbound-funds-holds.js +13 -14
- package/resources/simulations/inbound-funds-holds.mjs +10 -9
- package/resources/simulations/inbound-wire-drawdown-requests.d.ts +94 -97
- package/resources/simulations/inbound-wire-drawdown-requests.js +13 -15
- package/resources/simulations/inbound-wire-drawdown-requests.mjs +10 -11
- package/resources/simulations/index.d.ts +19 -40
- package/resources/simulations/index.js +40 -148
- package/resources/simulations/index.mjs +19 -19
- package/resources/simulations/interest-payments.d.ts +2482 -2743
- package/resources/simulations/interest-payments.d.ts.map +1 -1
- package/resources/simulations/interest-payments.js +13 -14
- package/resources/simulations/interest-payments.js.map +1 -1
- package/resources/simulations/interest-payments.mjs +10 -9
- package/resources/simulations/interest-payments.mjs.map +1 -1
- package/resources/simulations/programs.d.ts +13 -13
- package/resources/simulations/programs.js +14 -13
- package/resources/simulations/programs.mjs +11 -10
- package/resources/simulations/real-time-payments-transfers.d.ts +3342 -3727
- package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
- package/resources/simulations/real-time-payments-transfers.js +24 -25
- package/resources/simulations/real-time-payments-transfers.js.map +1 -1
- package/resources/simulations/real-time-payments-transfers.mjs +21 -20
- package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
- package/resources/simulations/simulations.d.ts +75 -75
- package/resources/simulations/simulations.js +78 -101
- package/resources/simulations/simulations.mjs +56 -56
- package/resources/simulations/wire-transfers.d.ts +2540 -2801
- package/resources/simulations/wire-transfers.d.ts.map +1 -1
- package/resources/simulations/wire-transfers.js +12 -11
- package/resources/simulations/wire-transfers.js.map +1 -1
- package/resources/simulations/wire-transfers.mjs +9 -8
- package/resources/simulations/wire-transfers.mjs.map +1 -1
- package/resources/transactions.d.ts +2539 -2830
- package/resources/transactions.d.ts.map +1 -1
- package/resources/transactions.js +21 -19
- package/resources/transactions.js.map +1 -1
- package/resources/transactions.mjs +16 -14
- package/resources/transactions.mjs.map +1 -1
- package/resources/wire-drawdown-requests.d.ts +140 -147
- package/resources/wire-drawdown-requests.js +27 -27
- package/resources/wire-drawdown-requests.mjs +22 -20
- package/resources/wire-transfers.d.ts +315 -324
- package/resources/wire-transfers.js +56 -54
- package/resources/wire-transfers.mjs +51 -49
- package/shims/node.d.ts +29 -0
- package/shims/node.d.ts.map +1 -0
- package/shims/node.js +31 -0
- package/shims/node.js.map +1 -0
- package/shims/node.mjs +5 -0
- package/shims/node.mjs.map +1 -0
- package/shims/web.d.ts +26 -0
- package/shims/web.d.ts.map +1 -0
- package/shims/web.js +31 -0
- package/shims/web.js.map +1 -0
- package/shims/web.mjs +5 -0
- package/shims/web.mjs.map +1 -0
- package/src/_shims/MultipartBody.ts +9 -0
- package/src/_shims/README.md +46 -0
- package/src/_shims/auto/runtime-bun.ts +4 -0
- package/src/_shims/auto/runtime-node.ts +4 -0
- package/src/_shims/auto/runtime.ts +4 -0
- package/src/_shims/auto/types-node.ts +4 -0
- package/src/_shims/auto/types.d.ts +99 -0
- package/src/_shims/auto/types.js +3 -0
- package/src/_shims/auto/types.mjs +3 -0
- package/src/_shims/bun-runtime.ts +14 -0
- package/src/_shims/index.d.ts +79 -0
- package/src/_shims/index.js +13 -0
- package/src/_shims/index.mjs +7 -0
- package/src/_shims/manual-types.d.ts +12 -0
- package/src/_shims/manual-types.js +3 -0
- package/src/_shims/manual-types.mjs +3 -0
- package/src/_shims/node-runtime.ts +79 -0
- package/src/_shims/node-types.d.ts +42 -0
- package/src/_shims/node-types.js +3 -0
- package/src/_shims/node-types.mjs +3 -0
- package/src/_shims/registry.ts +64 -0
- package/src/_shims/web-runtime.ts +91 -0
- package/src/_shims/web-types.d.ts +82 -0
- package/src/_shims/web-types.js +3 -0
- package/src/_shims/web-types.mjs +3 -0
- package/src/core.ts +37 -17
- package/src/error.ts +3 -3
- package/src/index.ts +6 -6
- package/src/pagination.ts +1 -1
- package/src/resource.ts +1 -1
- package/src/resources/account-numbers.ts +5 -5
- package/src/resources/account-statements.ts +5 -5
- package/src/resources/account-transfers.ts +5 -5
- package/src/resources/accounts.ts +5 -5
- package/src/resources/ach-prenotifications.ts +45 -16
- package/src/resources/ach-transfers.ts +47 -17
- package/src/resources/balance-lookups.ts +3 -3
- package/src/resources/bookkeeping-accounts.ts +5 -5
- package/src/resources/bookkeeping-entries.ts +5 -5
- package/src/resources/bookkeeping-entry-sets.ts +3 -3
- package/src/resources/card-disputes.ts +5 -5
- package/src/resources/card-profiles.ts +5 -5
- package/src/resources/card-purchase-supplements.ts +5 -5
- package/src/resources/cards.ts +15 -5
- package/src/resources/check-deposits.ts +5 -5
- package/src/resources/check-transfers.ts +5 -5
- package/src/resources/declined-transactions.ts +15 -5
- package/src/resources/digital-wallet-tokens.ts +5 -5
- package/src/resources/documents.ts +5 -5
- package/src/resources/entities/beneficial-owners.ts +5 -5
- package/src/resources/entities/entities.ts +18 -18
- package/src/resources/entities/index.ts +3 -3
- package/src/resources/entities/supplemental-documents.ts +5 -5
- package/src/resources/event-subscriptions.ts +5 -5
- package/src/resources/events.ts +5 -5
- package/src/resources/exports.ts +64 -7
- package/src/resources/external-accounts.ts +5 -5
- package/src/resources/files.ts +6 -6
- package/src/resources/groups.ts +3 -3
- package/src/resources/inbound-ach-transfers.ts +5 -5
- package/src/resources/inbound-wire-drawdown-requests.ts +5 -5
- package/src/resources/index.ts +38 -38
- package/src/resources/oauth-connections.ts +5 -5
- package/src/resources/pending-transactions.ts +10 -5
- package/src/resources/programs.ts +5 -5
- package/src/resources/real-time-decisions.ts +3 -3
- package/src/resources/real-time-payments-transfers.ts +5 -5
- package/src/resources/routing-numbers.ts +4 -4
- package/src/resources/simulations/account-statements.ts +4 -4
- package/src/resources/simulations/account-transfers.ts +3 -3
- package/src/resources/simulations/ach-transfers.ts +318 -30
- package/src/resources/simulations/card-disputes.ts +4 -4
- package/src/resources/simulations/card-profiles.ts +3 -3
- package/src/resources/simulations/card-refunds.ts +4 -4
- package/src/resources/simulations/cards.ts +19 -4
- package/src/resources/simulations/check-deposits.ts +3 -3
- package/src/resources/simulations/check-transfers.ts +3 -3
- package/src/resources/simulations/digital-wallet-token-requests.ts +3 -3
- package/src/resources/simulations/documents.ts +4 -4
- package/src/resources/simulations/inbound-funds-holds.ts +3 -3
- package/src/resources/simulations/inbound-wire-drawdown-requests.ts +4 -4
- package/src/resources/simulations/index.ts +18 -18
- package/src/resources/simulations/interest-payments.ts +29 -15
- package/src/resources/simulations/programs.ts +4 -4
- package/src/resources/simulations/real-time-payments-transfers.ts +40 -16
- package/src/resources/simulations/simulations.ts +19 -19
- package/src/resources/simulations/wire-transfers.ts +29 -15
- package/src/resources/transactions.ts +31 -17
- package/src/resources/wire-drawdown-requests.ts +5 -5
- package/src/resources/wire-transfers.ts +5 -5
- package/src/shims/node.ts +50 -0
- package/src/shims/web.ts +50 -0
- package/src/uploads.ts +12 -16
- package/src/version.ts +1 -1
- package/uploads.d.ts +23 -39
- package/uploads.d.ts.map +1 -1
- package/uploads.js +115 -157
- package/uploads.js.map +1 -1
- package/uploads.mjs +111 -133
- package/uploads.mjs.map +1 -1
- package/version.d.ts +2 -2
- package/version.js +4 -4
- package/version.mjs +2 -2
- package/_shims/ReadableStream-node.d.ts +0 -6
- package/_shims/ReadableStream-node.d.ts.map +0 -1
- package/_shims/ReadableStream-node.js +0 -14
- package/_shims/ReadableStream-node.js.map +0 -1
- package/_shims/ReadableStream-node.mjs +0 -3
- package/_shims/ReadableStream-node.mjs.map +0 -1
- package/_shims/ReadableStream.d.ts +0 -38
- package/_shims/ReadableStream.mjs +0 -7
- package/_shims/agent-node.d.ts +0 -7
- package/_shims/agent-node.d.ts.map +0 -1
- package/_shims/agent-node.js +0 -28
- package/_shims/agent-node.js.map +0 -1
- package/_shims/agent-node.mjs +0 -16
- package/_shims/agent-node.mjs.map +0 -1
- package/_shims/agent.d.ts +0 -9
- package/_shims/agent.d.ts.map +0 -1
- package/_shims/agent.js +0 -14
- package/_shims/agent.js.map +0 -1
- package/_shims/agent.mjs +0 -10
- package/_shims/agent.mjs.map +0 -1
- package/_shims/fetch-node.d.ts +0 -64
- package/_shims/fetch-node.js +0 -12
- package/_shims/fetch-node.mjs +0 -14
- package/_shims/fetch.d.ts +0 -60
- package/_shims/fetch.js +0 -13
- package/_shims/fetch.mjs +0 -15
- package/_shims/fileFromPath-node.d.ts +0 -17
- package/_shims/fileFromPath-node.d.ts.map +0 -1
- package/_shims/fileFromPath-node.js +0 -17
- package/_shims/fileFromPath-node.js.map +0 -1
- package/_shims/fileFromPath-node.mjs +0 -13
- package/_shims/fileFromPath-node.mjs.map +0 -1
- package/_shims/fileFromPath.d.ts +0 -22
- package/_shims/fileFromPath.d.ts.map +0 -1
- package/_shims/fileFromPath.js +0 -16
- package/_shims/fileFromPath.js.map +0 -1
- package/_shims/fileFromPath.mjs +0 -12
- package/_shims/fileFromPath.mjs.map +0 -1
- package/_shims/form-data-node.d.ts +0 -45
- package/_shims/form-data-node.js +0 -11
- package/_shims/form-data-node.mjs +0 -9
- package/_shims/form-data.d.ts +0 -43
- package/_shims/form-data.js +0 -17
- package/_shims/form-data.mjs +0 -20
- package/_shims/getMultipartRequestOptions-node.d.ts +0 -10
- package/_shims/getMultipartRequestOptions-node.d.ts.map +0 -1
- package/_shims/getMultipartRequestOptions-node.js +0 -22
- package/_shims/getMultipartRequestOptions-node.js.map +0 -1
- package/_shims/getMultipartRequestOptions-node.mjs +0 -18
- package/_shims/getMultipartRequestOptions-node.mjs.map +0 -1
- package/_shims/getMultipartRequestOptions.d.ts +0 -10
- package/_shims/getMultipartRequestOptions.d.ts.map +0 -1
- package/_shims/getMultipartRequestOptions.js +0 -12
- package/_shims/getMultipartRequestOptions.js.map +0 -1
- package/_shims/getMultipartRequestOptions.mjs +0 -8
- package/_shims/getMultipartRequestOptions.mjs.map +0 -1
- package/_shims/node-readable-node.d.ts +0 -8
- package/_shims/node-readable-node.d.ts.map +0 -1
- package/_shims/node-readable-node.js +0 -9
- package/_shims/node-readable-node.js.map +0 -1
- package/_shims/node-readable-node.mjs +0 -5
- package/_shims/node-readable-node.mjs.map +0 -1
- package/_shims/node-readable.d.ts +0 -23
- package/_shims/node-readable.d.ts.map +0 -1
- package/_shims/node-readable.js +0 -11
- package/_shims/node-readable.js.map +0 -1
- package/_shims/node-readable.mjs +0 -7
- package/_shims/node-readable.mjs.map +0 -1
- package/src/_shims/ReadableStream.d.ts +0 -38
- package/src/_shims/ReadableStream.mjs +0 -7
- package/src/_shims/agent-node.ts +0 -22
- package/src/_shims/agent.ts +0 -12
- package/src/_shims/fetch-node.d.ts +0 -64
- package/src/_shims/fetch-node.js +0 -12
- package/src/_shims/fetch-node.mjs +0 -14
- package/src/_shims/fetch.d.ts +0 -60
- package/src/_shims/fetch.js +0 -13
- package/src/_shims/fetch.mjs +0 -15
- package/src/_shims/fileFromPath-node.ts +0 -29
- package/src/_shims/fileFromPath.ts +0 -29
- package/src/_shims/form-data-node.d.ts +0 -45
- package/src/_shims/form-data-node.js +0 -11
- package/src/_shims/form-data-node.mjs +0 -9
- package/src/_shims/form-data.d.ts +0 -43
- package/src/_shims/form-data.js +0 -17
- package/src/_shims/form-data.mjs +0 -20
- package/src/_shims/getMultipartRequestOptions-node.ts +0 -25
- package/src/_shims/getMultipartRequestOptions.ts +0 -14
- package/src/_shims/node-readable-node.ts +0 -10
- package/src/_shims/node-readable.ts +0 -30
|
@@ -1,724 +1,649 @@
|
|
|
1
1
|
import * as Core from 'increase/core';
|
|
2
2
|
import { APIResource } from 'increase/resource';
|
|
3
|
-
import * as API from
|
|
3
|
+
import * as API from "./index.js";
|
|
4
4
|
import { Page, PageParams } from 'increase/pagination';
|
|
5
5
|
export declare class ACHTransfers extends APIResource {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
cancel(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfer>;
|
|
6
|
+
/**
|
|
7
|
+
* Create an ACH Transfer
|
|
8
|
+
*/
|
|
9
|
+
create(body: ACHTransferCreateParams, options?: Core.RequestOptions): Core.APIPromise<ACHTransfer>;
|
|
10
|
+
/**
|
|
11
|
+
* Retrieve an ACH Transfer
|
|
12
|
+
*/
|
|
13
|
+
retrieve(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfer>;
|
|
14
|
+
/**
|
|
15
|
+
* List ACH Transfers
|
|
16
|
+
*/
|
|
17
|
+
list(query?: ACHTransferListParams, options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage, ACHTransfer>;
|
|
18
|
+
list(options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage, ACHTransfer>;
|
|
19
|
+
/**
|
|
20
|
+
* Approves an ACH Transfer in a pending_approval state.
|
|
21
|
+
*/
|
|
22
|
+
approve(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfer>;
|
|
23
|
+
/**
|
|
24
|
+
* Cancels an ACH Transfer in a pending_approval state.
|
|
25
|
+
*/
|
|
26
|
+
cancel(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfer>;
|
|
27
|
+
}
|
|
28
|
+
export declare class ACHTransfersPage extends Page<ACHTransfer> {
|
|
30
29
|
}
|
|
31
|
-
export declare class ACHTransfersPage extends Page<ACHTransfer> {}
|
|
32
30
|
type _ACHTransfersPage = ACHTransfersPage;
|
|
33
31
|
/**
|
|
34
32
|
* ACH transfers move funds between your Increase account and any other account
|
|
35
33
|
* accessible by the Automated Clearing House (ACH).
|
|
36
34
|
*/
|
|
37
35
|
export interface ACHTransfer {
|
|
38
|
-
/**
|
|
39
|
-
* The ACH transfer's identifier.
|
|
40
|
-
*/
|
|
41
|
-
id: string;
|
|
42
|
-
/**
|
|
43
|
-
* The Account to which the transfer belongs.
|
|
44
|
-
*/
|
|
45
|
-
account_id: string;
|
|
46
|
-
/**
|
|
47
|
-
* The destination account number.
|
|
48
|
-
*/
|
|
49
|
-
account_number: string;
|
|
50
|
-
/**
|
|
51
|
-
* After the transfer is acknowledged by FedACH, this will contain supplemental
|
|
52
|
-
* details. The Federal Reserve sends an acknowledgement message for each file that
|
|
53
|
-
* Increase submits.
|
|
54
|
-
*/
|
|
55
|
-
acknowledgement: ACHTransfer.Acknowledgement | null;
|
|
56
|
-
/**
|
|
57
|
-
* Additional information that will be sent to the recipient.
|
|
58
|
-
*/
|
|
59
|
-
addendum: string | null;
|
|
60
|
-
/**
|
|
61
|
-
* The transfer amount in USD cents. A positive amount indicates a credit transfer
|
|
62
|
-
* pushing funds to the receiving account. A negative amount indicates a debit
|
|
63
|
-
* transfer pulling funds from the receiving account.
|
|
64
|
-
*/
|
|
65
|
-
amount: number;
|
|
66
|
-
/**
|
|
67
|
-
* If your account requires approvals for transfers and the transfer was approved,
|
|
68
|
-
* this will contain details of the approval.
|
|
69
|
-
*/
|
|
70
|
-
approval: ACHTransfer.Approval | null;
|
|
71
|
-
/**
|
|
72
|
-
* If your account requires approvals for transfers and the transfer was not
|
|
73
|
-
* approved, this will contain details of the cancellation.
|
|
74
|
-
*/
|
|
75
|
-
cancellation: ACHTransfer.Cancellation | null;
|
|
76
|
-
/**
|
|
77
|
-
* The description of the date of the transfer.
|
|
78
|
-
*/
|
|
79
|
-
company_descriptive_date: string | null;
|
|
80
|
-
/**
|
|
81
|
-
* The data you chose to associate with the transfer.
|
|
82
|
-
*/
|
|
83
|
-
company_discretionary_data: string | null;
|
|
84
|
-
/**
|
|
85
|
-
* The description of the transfer you set to be shown to the recipient.
|
|
86
|
-
*/
|
|
87
|
-
company_entry_description: string | null;
|
|
88
|
-
/**
|
|
89
|
-
* The name by which the recipient knows you.
|
|
90
|
-
*/
|
|
91
|
-
company_name: string | null;
|
|
92
|
-
/**
|
|
93
|
-
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
94
|
-
* the transfer was created.
|
|
95
|
-
*/
|
|
96
|
-
created_at: string;
|
|
97
|
-
/**
|
|
98
|
-
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
|
|
99
|
-
* currency. For ACH transfers this is always equal to `usd`.
|
|
100
|
-
*
|
|
101
|
-
* - `CAD` - Canadian Dollar (CAD)
|
|
102
|
-
* - `CHF` - Swiss Franc (CHF)
|
|
103
|
-
* - `EUR` - Euro (EUR)
|
|
104
|
-
* - `GBP` - British Pound (GBP)
|
|
105
|
-
* - `JPY` - Japanese Yen (JPY)
|
|
106
|
-
* - `USD` - US Dollar (USD)
|
|
107
|
-
*/
|
|
108
|
-
currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
|
|
109
|
-
/**
|
|
110
|
-
* The transfer effective date in
|
|
111
|
-
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
|
112
|
-
*/
|
|
113
|
-
effective_date: string | null;
|
|
114
|
-
/**
|
|
115
|
-
* The identifier of the External Account the transfer was made to, if any.
|
|
116
|
-
*/
|
|
117
|
-
external_account_id: string | null;
|
|
118
|
-
/**
|
|
119
|
-
* The type of the account to which the transfer will be sent.
|
|
120
|
-
*
|
|
121
|
-
* - `checking` - A checking account.
|
|
122
|
-
* - `savings` - A savings account.
|
|
123
|
-
*/
|
|
124
|
-
funding: 'checking' | 'savings';
|
|
125
|
-
/**
|
|
126
|
-
* Your identifier for the transfer recipient.
|
|
127
|
-
*/
|
|
128
|
-
individual_id: string | null;
|
|
129
|
-
/**
|
|
130
|
-
* The name of the transfer recipient. This value is information and not verified
|
|
131
|
-
* by the recipient's bank.
|
|
132
|
-
*/
|
|
133
|
-
individual_name: string | null;
|
|
134
|
-
/**
|
|
135
|
-
* The transfer's network.
|
|
136
|
-
*/
|
|
137
|
-
network: 'ach';
|
|
138
|
-
/**
|
|
139
|
-
* If the receiving bank accepts the transfer but notifies that future transfers
|
|
140
|
-
* should use different details, this will contain those details.
|
|
141
|
-
*/
|
|
142
|
-
notifications_of_change: Array<ACHTransfer.NotificationsOfChange>;
|
|
143
|
-
/**
|
|
144
|
-
* The ID for the pending transaction representing the transfer. A pending
|
|
145
|
-
* transaction is created when the transfer
|
|
146
|
-
* [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
|
|
147
|
-
* by someone else in your organization.
|
|
148
|
-
*/
|
|
149
|
-
pending_transaction_id: string | null;
|
|
150
|
-
/**
|
|
151
|
-
* If your transfer is returned, this will contain details of the return.
|
|
152
|
-
*/
|
|
153
|
-
return: ACHTransfer.Return | null;
|
|
154
|
-
/**
|
|
155
|
-
* The American Bankers' Association (ABA) Routing Transit Number (RTN).
|
|
156
|
-
*/
|
|
157
|
-
routing_number: string;
|
|
158
|
-
/**
|
|
159
|
-
* The Standard Entry Class (SEC) code to use for the transfer.
|
|
160
|
-
*
|
|
161
|
-
* - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
|
|
162
|
-
* - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
|
|
163
|
-
* - `internet_initiated` - Internet Initiated (WEB).
|
|
164
|
-
*/
|
|
165
|
-
standard_entry_class_code:
|
|
166
|
-
| 'corporate_credit_or_debit'
|
|
167
|
-
| 'prearranged_payments_and_deposit'
|
|
168
|
-
| 'internet_initiated';
|
|
169
|
-
/**
|
|
170
|
-
* The descriptor that will show on the recipient's bank statement.
|
|
171
|
-
*/
|
|
172
|
-
statement_descriptor: string;
|
|
173
|
-
/**
|
|
174
|
-
* The lifecycle status of the transfer.
|
|
175
|
-
*
|
|
176
|
-
* - `pending_approval` - The transfer is pending approval.
|
|
177
|
-
* - `canceled` - The transfer has been canceled.
|
|
178
|
-
* - `pending_reviewing` - The transfer is pending review by Increase.
|
|
179
|
-
* - `pending_submission` - The transfer is pending submission to the Federal
|
|
180
|
-
* Reserve.
|
|
181
|
-
* - `submitted` - The transfer is complete.
|
|
182
|
-
* - `returned` - The transfer has been returned.
|
|
183
|
-
* - `requires_attention` - The transfer requires attention from an Increase
|
|
184
|
-
* operator.
|
|
185
|
-
* - `rejected` - The transfer has been rejected.
|
|
186
|
-
*/
|
|
187
|
-
status:
|
|
188
|
-
| 'pending_approval'
|
|
189
|
-
| 'canceled'
|
|
190
|
-
| 'pending_reviewing'
|
|
191
|
-
| 'pending_submission'
|
|
192
|
-
| 'submitted'
|
|
193
|
-
| 'returned'
|
|
194
|
-
| 'requires_attention'
|
|
195
|
-
| 'rejected';
|
|
196
|
-
/**
|
|
197
|
-
* After the transfer is submitted to FedACH, this will contain supplemental
|
|
198
|
-
* details. Increase batches transfers and submits a file to the Federal Reserve
|
|
199
|
-
* roughly every 30 minutes. The Federal Reserve processes ACH transfers during
|
|
200
|
-
* weekdays according to their
|
|
201
|
-
* [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
|
|
202
|
-
*/
|
|
203
|
-
submission: ACHTransfer.Submission | null;
|
|
204
|
-
/**
|
|
205
|
-
* The ID for the transaction funding the transfer.
|
|
206
|
-
*/
|
|
207
|
-
transaction_id: string | null;
|
|
208
|
-
/**
|
|
209
|
-
* A constant representing the object's type. For this resource it will always be
|
|
210
|
-
* `ach_transfer`.
|
|
211
|
-
*/
|
|
212
|
-
type: 'ach_transfer';
|
|
213
|
-
/**
|
|
214
|
-
* The unique identifier you chose for this transfer.
|
|
215
|
-
*/
|
|
216
|
-
unique_identifier: string | null;
|
|
217
|
-
}
|
|
218
|
-
export declare namespace ACHTransfer {
|
|
219
|
-
/**
|
|
220
|
-
* After the transfer is acknowledged by FedACH, this will contain supplemental
|
|
221
|
-
* details. The Federal Reserve sends an acknowledgement message for each file that
|
|
222
|
-
* Increase submits.
|
|
223
|
-
*/
|
|
224
|
-
interface Acknowledgement {
|
|
225
|
-
/**
|
|
226
|
-
* When the Federal Reserve acknowledged the submitted file containing this
|
|
227
|
-
* transfer.
|
|
228
|
-
*/
|
|
229
|
-
acknowledged_at: string;
|
|
230
|
-
}
|
|
231
|
-
/**
|
|
232
|
-
* If your account requires approvals for transfers and the transfer was approved,
|
|
233
|
-
* this will contain details of the approval.
|
|
234
|
-
*/
|
|
235
|
-
interface Approval {
|
|
236
36
|
/**
|
|
237
|
-
* The
|
|
238
|
-
* the transfer was approved.
|
|
37
|
+
* The ACH transfer's identifier.
|
|
239
38
|
*/
|
|
240
|
-
|
|
39
|
+
id: string;
|
|
241
40
|
/**
|
|
242
|
-
*
|
|
243
|
-
* that user.
|
|
41
|
+
* The Account to which the transfer belongs.
|
|
244
42
|
*/
|
|
245
|
-
|
|
246
|
-
}
|
|
247
|
-
/**
|
|
248
|
-
* If your account requires approvals for transfers and the transfer was not
|
|
249
|
-
* approved, this will contain details of the cancellation.
|
|
250
|
-
*/
|
|
251
|
-
interface Cancellation {
|
|
43
|
+
account_id: string;
|
|
252
44
|
/**
|
|
253
|
-
* The
|
|
254
|
-
* the Transfer was canceled.
|
|
45
|
+
* The destination account number.
|
|
255
46
|
*/
|
|
256
|
-
|
|
47
|
+
account_number: string;
|
|
257
48
|
/**
|
|
258
|
-
*
|
|
259
|
-
* that
|
|
49
|
+
* After the transfer is acknowledged by FedACH, this will contain supplemental
|
|
50
|
+
* details. The Federal Reserve sends an acknowledgement message for each file that
|
|
51
|
+
* Increase submits.
|
|
260
52
|
*/
|
|
261
|
-
|
|
262
|
-
}
|
|
263
|
-
interface NotificationsOfChange {
|
|
53
|
+
acknowledgement: ACHTransfer.Acknowledgement | null;
|
|
264
54
|
/**
|
|
265
|
-
*
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
* - `incorrect_account_number` - The account number was incorrect.
|
|
269
|
-
* - `incorrect_routing_number` - The routing number was incorrect.
|
|
270
|
-
* - `incorrect_routing_number_and_account_number` - Both the routing number and
|
|
271
|
-
* the account number were incorrect.
|
|
272
|
-
* - `incorrect_transaction_code` - The transaction code was incorrect.
|
|
273
|
-
* - `incorrect_account_number_and_transaction_code` - The account number and the
|
|
274
|
-
* transaction code were incorrect.
|
|
275
|
-
* - `incorrect_routing_number_account_number_and_transaction_code` - The routing
|
|
276
|
-
* number, account number, and transaction code were incorrect.
|
|
277
|
-
* - `incorrect_receiving_depository_financial_institution_identification` - The
|
|
278
|
-
* receiving depository financial institution identification was incorrect.
|
|
279
|
-
* - `incorrect_individual_identification_number` - The individual identification
|
|
280
|
-
* number was incorrect.
|
|
281
|
-
* - `addenda_format_error` - The addenda had an incorrect format.
|
|
282
|
-
* - `incorrect_standard_entry_class_code_for_outbound_international_payment` - The
|
|
283
|
-
* standard entry class code was incorrect for an outbound international payment.
|
|
284
|
-
*/
|
|
285
|
-
change_code:
|
|
286
|
-
| 'incorrect_account_number'
|
|
287
|
-
| 'incorrect_routing_number'
|
|
288
|
-
| 'incorrect_routing_number_and_account_number'
|
|
289
|
-
| 'incorrect_transaction_code'
|
|
290
|
-
| 'incorrect_account_number_and_transaction_code'
|
|
291
|
-
| 'incorrect_routing_number_account_number_and_transaction_code'
|
|
292
|
-
| 'incorrect_receiving_depository_financial_institution_identification'
|
|
293
|
-
| 'incorrect_individual_identification_number'
|
|
294
|
-
| 'addenda_format_error'
|
|
295
|
-
| 'incorrect_standard_entry_class_code_for_outbound_international_payment';
|
|
296
|
-
/**
|
|
297
|
-
* The corrected data that should be used in future ACHs to this account.
|
|
298
|
-
*/
|
|
299
|
-
corrected_data: string;
|
|
55
|
+
* Additional information that will be sent to the recipient.
|
|
56
|
+
*/
|
|
57
|
+
addendum: string | null;
|
|
300
58
|
/**
|
|
301
|
-
* The
|
|
302
|
-
* the
|
|
59
|
+
* The transfer amount in USD cents. A positive amount indicates a credit transfer
|
|
60
|
+
* pushing funds to the receiving account. A negative amount indicates a debit
|
|
61
|
+
* transfer pulling funds from the receiving account.
|
|
303
62
|
*/
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
63
|
+
amount: number;
|
|
64
|
+
/**
|
|
65
|
+
* If your account requires approvals for transfers and the transfer was approved,
|
|
66
|
+
* this will contain details of the approval.
|
|
67
|
+
*/
|
|
68
|
+
approval: ACHTransfer.Approval | null;
|
|
69
|
+
/**
|
|
70
|
+
* If your account requires approvals for transfers and the transfer was not
|
|
71
|
+
* approved, this will contain details of the cancellation.
|
|
72
|
+
*/
|
|
73
|
+
cancellation: ACHTransfer.Cancellation | null;
|
|
74
|
+
/**
|
|
75
|
+
* The description of the date of the transfer.
|
|
76
|
+
*/
|
|
77
|
+
company_descriptive_date: string | null;
|
|
78
|
+
/**
|
|
79
|
+
* The data you chose to associate with the transfer.
|
|
80
|
+
*/
|
|
81
|
+
company_discretionary_data: string | null;
|
|
82
|
+
/**
|
|
83
|
+
* The description of the transfer you set to be shown to the recipient.
|
|
84
|
+
*/
|
|
85
|
+
company_entry_description: string | null;
|
|
86
|
+
/**
|
|
87
|
+
* The name by which the recipient knows you.
|
|
88
|
+
*/
|
|
89
|
+
company_name: string | null;
|
|
310
90
|
/**
|
|
311
91
|
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
312
92
|
* the transfer was created.
|
|
313
93
|
*/
|
|
314
94
|
created_at: string;
|
|
315
95
|
/**
|
|
316
|
-
* The
|
|
96
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
|
|
97
|
+
* currency. For ACH transfers this is always equal to `usd`.
|
|
98
|
+
*
|
|
99
|
+
* - `CAD` - Canadian Dollar (CAD)
|
|
100
|
+
* - `CHF` - Swiss Franc (CHF)
|
|
101
|
+
* - `EUR` - Euro (EUR)
|
|
102
|
+
* - `GBP` - British Pound (GBP)
|
|
103
|
+
* - `JPY` - Japanese Yen (JPY)
|
|
104
|
+
* - `USD` - US Dollar (USD)
|
|
105
|
+
*/
|
|
106
|
+
currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
|
|
107
|
+
/**
|
|
108
|
+
* The transfer effective date in
|
|
109
|
+
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
|
110
|
+
*/
|
|
111
|
+
effective_date: string | null;
|
|
112
|
+
/**
|
|
113
|
+
* The identifier of the External Account the transfer was made to, if any.
|
|
317
114
|
*/
|
|
318
|
-
|
|
115
|
+
external_account_id: string | null;
|
|
319
116
|
/**
|
|
320
|
-
*
|
|
117
|
+
* The type of the account to which the transfer will be sent.
|
|
321
118
|
*
|
|
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
|
-
* - `invalid_individual_id_number` - Code R22. A rare return reason. The
|
|
408
|
-
* Individual ID number field of the ACH was invalid.
|
|
409
|
-
* - `item_and_rck_entry_presented_for_payment` - Code R53. A rare return reason.
|
|
410
|
-
* Both the Represented Check ("RCK") entry and the original check were presented
|
|
411
|
-
* to the bank.
|
|
412
|
-
* - `item_related_to_rck_entry_is_ineligible` - Code R51. A rare return reason.
|
|
413
|
-
* The Represented Check ("RCK") entry is ineligible.
|
|
414
|
-
* - `mandatory_field_error` - Code R26. A rare return reason. The ACH is missing a
|
|
415
|
-
* required field.
|
|
416
|
-
* - `misrouted_dishonored_return` - Code R71. A rare return reason. The receiving
|
|
417
|
-
* bank does not recognize the routing number in a dishonored return entry.
|
|
418
|
-
* - `misrouted_return` - Code R61. A rare return reason. The receiving bank does
|
|
419
|
-
* not recognize the routing number in a return entry.
|
|
420
|
-
* - `no_errors_found` - Code R76. A rare return reason. Sent in response to a
|
|
421
|
-
* return, the bank does not find the errors alleged by the returning bank.
|
|
422
|
-
* - `non_acceptance_of_r62_dishonored_return` - Code R77. A rare return reason.
|
|
423
|
-
* The receiving bank does not accept the return of the erroneous debit. The
|
|
424
|
-
* funds are not available at the receiving bank.
|
|
425
|
-
* - `non_participant_in_iat_program` - Code R81. A rare return reason. The
|
|
426
|
-
* receiving bank does not accept International ACH Transfers.
|
|
427
|
-
* - `permissible_return_entry` - Code R31. A rare return reason. A return that has
|
|
428
|
-
* been agreed to be accepted by the receiving bank, despite falling outside of
|
|
429
|
-
* the usual return timeframe.
|
|
430
|
-
* - `permissible_return_entry_not_accepted` - Code R70. A rare return reason. The
|
|
431
|
-
* receiving bank had not approved this return.
|
|
432
|
-
* - `rdfi_non_settlement` - Code R32. A rare return reason. The receiving bank
|
|
433
|
-
* could not settle this transaction.
|
|
434
|
-
* - `rdfi_participant_in_check_truncation_program` - Code R30. A rare return
|
|
435
|
-
* reason. The receiving bank does not accept Check Truncation ACH transfers.
|
|
436
|
-
* - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - Code
|
|
437
|
-
* R14. A rare return reason. The payee is deceased.
|
|
438
|
-
* - `return_not_a_duplicate` - Code R75. A rare return reason. The originating
|
|
439
|
-
* bank disputes that an earlier `duplicate_entry` return was actually a
|
|
440
|
-
* duplicate.
|
|
441
|
-
* - `return_of_erroneous_or_reversing_debit` - Code R62. A rare return reason. The
|
|
442
|
-
* originating financial institution made a mistake and this return corrects it.
|
|
443
|
-
* - `return_of_improper_credit_entry` - Code R36. A rare return reason. Return of
|
|
444
|
-
* a malformed credit entry.
|
|
445
|
-
* - `return_of_improper_debit_entry` - Code R35. A rare return reason. Return of a
|
|
446
|
-
* malformed debit entry.
|
|
447
|
-
* - `return_of_xck_entry` - Code R33. A rare return reason. Return of a Destroyed
|
|
448
|
-
* Check ("XKC") entry.
|
|
449
|
-
* - `source_document_presented_for_payment` - Code R37. A rare return reason. The
|
|
450
|
-
* source document related to this ACH, usually an ACH check conversion, was
|
|
451
|
-
* presented to the bank.
|
|
452
|
-
* - `state_law_affecting_rck_acceptance` - Code R50. A rare return reason. State
|
|
453
|
-
* law prevents the bank from accepting the Represented Check ("RCK") entry.
|
|
454
|
-
* - `stop_payment_on_item_related_to_rck_entry` - Code R52. A rare return reason.
|
|
455
|
-
* A stop payment was issued on a Represented Check ("RCK") entry.
|
|
456
|
-
* - `stop_payment_on_source_document` - Code R38. A rare return reason. The source
|
|
457
|
-
* attached to the ACH, usually an ACH check conversion, includes a stop payment.
|
|
458
|
-
* - `timely_original_return` - Code R73. A rare return reason. The bank receiving
|
|
459
|
-
* an `untimely_return` believes it was on time.
|
|
460
|
-
* - `trace_number_error` - Code R27. A rare return reason. An ACH Return's trace
|
|
461
|
-
* number does not match an originated ACH.
|
|
462
|
-
* - `untimely_dishonored_return` - Code R72. A rare return reason. The dishonored
|
|
463
|
-
* return was sent too late.
|
|
464
|
-
* - `untimely_return` - Code R68. A rare return reason. The return was sent too
|
|
465
|
-
* late.
|
|
466
|
-
*/
|
|
467
|
-
return_reason_code:
|
|
468
|
-
| 'insufficient_fund'
|
|
469
|
-
| 'no_account'
|
|
470
|
-
| 'account_closed'
|
|
471
|
-
| 'invalid_account_number_structure'
|
|
472
|
-
| 'account_frozen_entry_returned_per_ofac_instruction'
|
|
473
|
-
| 'credit_entry_refused_by_receiver'
|
|
474
|
-
| 'unauthorized_debit_to_consumer_account_using_corporate_sec_code'
|
|
475
|
-
| 'corporate_customer_advised_not_authorized'
|
|
476
|
-
| 'payment_stopped'
|
|
477
|
-
| 'non_transaction_account'
|
|
478
|
-
| 'uncollected_funds'
|
|
479
|
-
| 'routing_number_check_digit_error'
|
|
480
|
-
| 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
|
|
481
|
-
| 'amount_field_error'
|
|
482
|
-
| 'authorization_revoked_by_customer'
|
|
483
|
-
| 'invalid_ach_routing_number'
|
|
484
|
-
| 'file_record_edit_criteria'
|
|
485
|
-
| 'enr_invalid_individual_name'
|
|
486
|
-
| 'returned_per_odfi_request'
|
|
487
|
-
| 'limited_participation_dfi'
|
|
488
|
-
| 'incorrectly_coded_outbound_international_payment'
|
|
489
|
-
| 'account_sold_to_another_dfi'
|
|
490
|
-
| 'addenda_error'
|
|
491
|
-
| 'beneficiary_or_account_holder_deceased'
|
|
492
|
-
| 'customer_advised_not_within_authorization_terms'
|
|
493
|
-
| 'corrected_return'
|
|
494
|
-
| 'duplicate_entry'
|
|
495
|
-
| 'duplicate_return'
|
|
496
|
-
| 'enr_duplicate_enrollment'
|
|
497
|
-
| 'enr_invalid_dfi_account_number'
|
|
498
|
-
| 'enr_invalid_individual_id_number'
|
|
499
|
-
| 'enr_invalid_representative_payee_indicator'
|
|
500
|
-
| 'enr_invalid_transaction_code'
|
|
501
|
-
| 'enr_return_of_enr_entry'
|
|
502
|
-
| 'enr_routing_number_check_digit_error'
|
|
503
|
-
| 'entry_not_processed_by_gateway'
|
|
504
|
-
| 'field_error'
|
|
505
|
-
| 'foreign_receiving_dfi_unable_to_settle'
|
|
506
|
-
| 'iat_entry_coding_error'
|
|
507
|
-
| 'improper_effective_entry_date'
|
|
508
|
-
| 'improper_source_document_source_document_presented'
|
|
509
|
-
| 'invalid_company_id'
|
|
510
|
-
| 'invalid_foreign_receiving_dfi_identification'
|
|
511
|
-
| 'invalid_individual_id_number'
|
|
512
|
-
| 'item_and_rck_entry_presented_for_payment'
|
|
513
|
-
| 'item_related_to_rck_entry_is_ineligible'
|
|
514
|
-
| 'mandatory_field_error'
|
|
515
|
-
| 'misrouted_dishonored_return'
|
|
516
|
-
| 'misrouted_return'
|
|
517
|
-
| 'no_errors_found'
|
|
518
|
-
| 'non_acceptance_of_r62_dishonored_return'
|
|
519
|
-
| 'non_participant_in_iat_program'
|
|
520
|
-
| 'permissible_return_entry'
|
|
521
|
-
| 'permissible_return_entry_not_accepted'
|
|
522
|
-
| 'rdfi_non_settlement'
|
|
523
|
-
| 'rdfi_participant_in_check_truncation_program'
|
|
524
|
-
| 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
|
|
525
|
-
| 'return_not_a_duplicate'
|
|
526
|
-
| 'return_of_erroneous_or_reversing_debit'
|
|
527
|
-
| 'return_of_improper_credit_entry'
|
|
528
|
-
| 'return_of_improper_debit_entry'
|
|
529
|
-
| 'return_of_xck_entry'
|
|
530
|
-
| 'source_document_presented_for_payment'
|
|
531
|
-
| 'state_law_affecting_rck_acceptance'
|
|
532
|
-
| 'stop_payment_on_item_related_to_rck_entry'
|
|
533
|
-
| 'stop_payment_on_source_document'
|
|
534
|
-
| 'timely_original_return'
|
|
535
|
-
| 'trace_number_error'
|
|
536
|
-
| 'untimely_dishonored_return'
|
|
537
|
-
| 'untimely_return';
|
|
538
|
-
/**
|
|
539
|
-
* The identifier of the Transaction associated with this return.
|
|
540
|
-
*/
|
|
541
|
-
transaction_id: string;
|
|
542
|
-
/**
|
|
543
|
-
* The identifier of the ACH Transfer associated with this return.
|
|
544
|
-
*/
|
|
545
|
-
transfer_id: string;
|
|
546
|
-
}
|
|
547
|
-
/**
|
|
548
|
-
* After the transfer is submitted to FedACH, this will contain supplemental
|
|
549
|
-
* details. Increase batches transfers and submits a file to the Federal Reserve
|
|
550
|
-
* roughly every 30 minutes. The Federal Reserve processes ACH transfers during
|
|
551
|
-
* weekdays according to their
|
|
552
|
-
* [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
|
|
553
|
-
*/
|
|
554
|
-
interface Submission {
|
|
555
|
-
/**
|
|
556
|
-
* When the funds transfer is expected to settle in the recipient's account.
|
|
557
|
-
* Credits may be available sooner, at the receiving banks discretion. The FedACH
|
|
558
|
-
* schedule is published
|
|
559
|
-
* [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
|
|
560
|
-
*/
|
|
561
|
-
expected_funds_settlement_at: string;
|
|
562
|
-
/**
|
|
563
|
-
* When the ACH transfer was sent to FedACH.
|
|
564
|
-
*/
|
|
565
|
-
submitted_at: string;
|
|
566
|
-
/**
|
|
567
|
-
* A 15 digit number recorded in the Nacha file and transmitted to the receiving
|
|
568
|
-
* bank. Along with the amount, date, and originating routing number, this can be
|
|
569
|
-
* used to identify the ACH transfer at the receiving bank. ACH trace numbers are
|
|
570
|
-
* not unique, but are
|
|
571
|
-
* [used to correlate returns](https://increase.com/documentation/ach#returns).
|
|
572
|
-
*/
|
|
573
|
-
trace_number: string;
|
|
574
|
-
}
|
|
575
|
-
}
|
|
576
|
-
export interface ACHTransferCreateParams {
|
|
577
|
-
/**
|
|
578
|
-
* The Increase identifier for the account that will send the transfer.
|
|
579
|
-
*/
|
|
580
|
-
account_id: string;
|
|
581
|
-
/**
|
|
582
|
-
* The transfer amount in cents. A positive amount originates a credit transfer
|
|
583
|
-
* pushing funds to the receiving account. A negative amount originates a debit
|
|
584
|
-
* transfer pulling funds from the receiving account.
|
|
585
|
-
*/
|
|
586
|
-
amount: number;
|
|
587
|
-
/**
|
|
588
|
-
* A description you choose to give the transfer. This will be saved with the
|
|
589
|
-
* transfer details, displayed in the dashboard, and returned by the API. If
|
|
590
|
-
* `individual_name` and `company_name` are not explicitly set by this API, the
|
|
591
|
-
* `statement_descriptor` will be sent in those fields to the receiving bank to
|
|
592
|
-
* help the customer recognize the transfer. You are highly encouraged to pass
|
|
593
|
-
* `individual_name` and `company_name` instead of relying on this fallback.
|
|
594
|
-
*/
|
|
595
|
-
statement_descriptor: string;
|
|
596
|
-
/**
|
|
597
|
-
* The account number for the destination account.
|
|
598
|
-
*/
|
|
599
|
-
account_number?: string;
|
|
600
|
-
/**
|
|
601
|
-
* Additional information that will be sent to the recipient. This is included in
|
|
602
|
-
* the transfer data sent to the receiving bank.
|
|
603
|
-
*/
|
|
604
|
-
addendum?: string;
|
|
605
|
-
/**
|
|
606
|
-
* The description of the date of the transfer, usually in the format `YYMMDD`.
|
|
607
|
-
* This is included in the transfer data sent to the receiving bank.
|
|
608
|
-
*/
|
|
609
|
-
company_descriptive_date?: string;
|
|
610
|
-
/**
|
|
611
|
-
* The data you choose to associate with the transfer. This is included in the
|
|
612
|
-
* transfer data sent to the receiving bank.
|
|
613
|
-
*/
|
|
614
|
-
company_discretionary_data?: string;
|
|
615
|
-
/**
|
|
616
|
-
* A description of the transfer. This is included in the transfer data sent to the
|
|
617
|
-
* receiving bank.
|
|
618
|
-
*/
|
|
619
|
-
company_entry_description?: string;
|
|
620
|
-
/**
|
|
621
|
-
* The name by which the recipient knows you. This is included in the transfer data
|
|
622
|
-
* sent to the receiving bank.
|
|
623
|
-
*/
|
|
624
|
-
company_name?: string;
|
|
625
|
-
/**
|
|
626
|
-
* The transfer effective date in
|
|
627
|
-
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
|
628
|
-
*/
|
|
629
|
-
effective_date?: string;
|
|
630
|
-
/**
|
|
631
|
-
* The ID of an External Account to initiate a transfer to. If this parameter is
|
|
632
|
-
* provided, `account_number`, `routing_number`, and `funding` must be absent.
|
|
633
|
-
*/
|
|
634
|
-
external_account_id?: string;
|
|
635
|
-
/**
|
|
636
|
-
* The type of the account to which the transfer will be sent.
|
|
637
|
-
*
|
|
638
|
-
* - `checking` - A checking account.
|
|
639
|
-
* - `savings` - A savings account.
|
|
640
|
-
*/
|
|
641
|
-
funding?: 'checking' | 'savings';
|
|
642
|
-
/**
|
|
643
|
-
* Your identifier for the transfer recipient.
|
|
644
|
-
*/
|
|
645
|
-
individual_id?: string;
|
|
646
|
-
/**
|
|
647
|
-
* The name of the transfer recipient. This value is informational and not verified
|
|
648
|
-
* by the recipient's bank.
|
|
649
|
-
*/
|
|
650
|
-
individual_name?: string;
|
|
651
|
-
/**
|
|
652
|
-
* Whether the transfer requires explicit approval via the dashboard or API.
|
|
653
|
-
*/
|
|
654
|
-
require_approval?: boolean;
|
|
655
|
-
/**
|
|
656
|
-
* The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
|
|
657
|
-
* destination account.
|
|
658
|
-
*/
|
|
659
|
-
routing_number?: string;
|
|
660
|
-
/**
|
|
661
|
-
* The Standard Entry Class (SEC) code to use for the transfer.
|
|
662
|
-
*
|
|
663
|
-
* - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
|
|
664
|
-
* - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
|
|
665
|
-
* - `internet_initiated` - Internet Initiated (WEB).
|
|
666
|
-
*/
|
|
667
|
-
standard_entry_class_code?:
|
|
668
|
-
| 'corporate_credit_or_debit'
|
|
669
|
-
| 'prearranged_payments_and_deposit'
|
|
670
|
-
| 'internet_initiated';
|
|
671
|
-
/**
|
|
672
|
-
* A unique identifier you choose for the transfer. Reusing this identifier for
|
|
673
|
-
* another transfer will result in an error. You can query for the transfer
|
|
674
|
-
* associated with this identifier using the List endpoint.
|
|
675
|
-
*/
|
|
676
|
-
unique_identifier?: string;
|
|
119
|
+
* - `checking` - A checking account.
|
|
120
|
+
* - `savings` - A savings account.
|
|
121
|
+
*/
|
|
122
|
+
funding: 'checking' | 'savings';
|
|
123
|
+
/**
|
|
124
|
+
* Your identifier for the transfer recipient.
|
|
125
|
+
*/
|
|
126
|
+
individual_id: string | null;
|
|
127
|
+
/**
|
|
128
|
+
* The name of the transfer recipient. This value is information and not verified
|
|
129
|
+
* by the recipient's bank.
|
|
130
|
+
*/
|
|
131
|
+
individual_name: string | null;
|
|
132
|
+
/**
|
|
133
|
+
* The transfer's network.
|
|
134
|
+
*/
|
|
135
|
+
network: 'ach';
|
|
136
|
+
/**
|
|
137
|
+
* If the receiving bank accepts the transfer but notifies that future transfers
|
|
138
|
+
* should use different details, this will contain those details.
|
|
139
|
+
*/
|
|
140
|
+
notifications_of_change: Array<ACHTransfer.NotificationsOfChange>;
|
|
141
|
+
/**
|
|
142
|
+
* The ID for the pending transaction representing the transfer. A pending
|
|
143
|
+
* transaction is created when the transfer
|
|
144
|
+
* [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
|
|
145
|
+
* by someone else in your organization.
|
|
146
|
+
*/
|
|
147
|
+
pending_transaction_id: string | null;
|
|
148
|
+
/**
|
|
149
|
+
* If your transfer is returned, this will contain details of the return.
|
|
150
|
+
*/
|
|
151
|
+
return: ACHTransfer.Return | null;
|
|
152
|
+
/**
|
|
153
|
+
* The American Bankers' Association (ABA) Routing Transit Number (RTN).
|
|
154
|
+
*/
|
|
155
|
+
routing_number: string;
|
|
156
|
+
/**
|
|
157
|
+
* The Standard Entry Class (SEC) code to use for the transfer.
|
|
158
|
+
*
|
|
159
|
+
* - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
|
|
160
|
+
* - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
|
|
161
|
+
* - `internet_initiated` - Internet Initiated (WEB).
|
|
162
|
+
*/
|
|
163
|
+
standard_entry_class_code: 'corporate_credit_or_debit' | 'prearranged_payments_and_deposit' | 'internet_initiated';
|
|
164
|
+
/**
|
|
165
|
+
* The descriptor that will show on the recipient's bank statement.
|
|
166
|
+
*/
|
|
167
|
+
statement_descriptor: string;
|
|
168
|
+
/**
|
|
169
|
+
* The lifecycle status of the transfer.
|
|
170
|
+
*
|
|
171
|
+
* - `pending_approval` - The transfer is pending approval.
|
|
172
|
+
* - `canceled` - The transfer has been canceled.
|
|
173
|
+
* - `pending_reviewing` - The transfer is pending review by Increase.
|
|
174
|
+
* - `pending_submission` - The transfer is pending submission to the Federal
|
|
175
|
+
* Reserve.
|
|
176
|
+
* - `submitted` - The transfer is complete.
|
|
177
|
+
* - `returned` - The transfer has been returned.
|
|
178
|
+
* - `requires_attention` - The transfer requires attention from an Increase
|
|
179
|
+
* operator.
|
|
180
|
+
* - `rejected` - The transfer has been rejected.
|
|
181
|
+
*/
|
|
182
|
+
status: 'pending_approval' | 'canceled' | 'pending_reviewing' | 'pending_submission' | 'submitted' | 'returned' | 'requires_attention' | 'rejected';
|
|
183
|
+
/**
|
|
184
|
+
* After the transfer is submitted to FedACH, this will contain supplemental
|
|
185
|
+
* details. Increase batches transfers and submits a file to the Federal Reserve
|
|
186
|
+
* roughly every 30 minutes. The Federal Reserve processes ACH transfers during
|
|
187
|
+
* weekdays according to their
|
|
188
|
+
* [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
|
|
189
|
+
*/
|
|
190
|
+
submission: ACHTransfer.Submission | null;
|
|
191
|
+
/**
|
|
192
|
+
* The ID for the transaction funding the transfer.
|
|
193
|
+
*/
|
|
194
|
+
transaction_id: string | null;
|
|
195
|
+
/**
|
|
196
|
+
* A constant representing the object's type. For this resource it will always be
|
|
197
|
+
* `ach_transfer`.
|
|
198
|
+
*/
|
|
199
|
+
type: 'ach_transfer';
|
|
200
|
+
/**
|
|
201
|
+
* The unique identifier you chose for this transfer.
|
|
202
|
+
*/
|
|
203
|
+
unique_identifier: string | null;
|
|
677
204
|
}
|
|
678
|
-
export
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
205
|
+
export declare namespace ACHTransfer {
|
|
206
|
+
/**
|
|
207
|
+
* After the transfer is acknowledged by FedACH, this will contain supplemental
|
|
208
|
+
* details. The Federal Reserve sends an acknowledgement message for each file that
|
|
209
|
+
* Increase submits.
|
|
210
|
+
*/
|
|
211
|
+
interface Acknowledgement {
|
|
212
|
+
/**
|
|
213
|
+
* When the Federal Reserve acknowledged the submitted file containing this
|
|
214
|
+
* transfer.
|
|
215
|
+
*/
|
|
216
|
+
acknowledged_at: string;
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* If your account requires approvals for transfers and the transfer was approved,
|
|
220
|
+
* this will contain details of the approval.
|
|
221
|
+
*/
|
|
222
|
+
interface Approval {
|
|
223
|
+
/**
|
|
224
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
225
|
+
* the transfer was approved.
|
|
226
|
+
*/
|
|
227
|
+
approved_at: string;
|
|
228
|
+
/**
|
|
229
|
+
* If the Transfer was approved by a user in the dashboard, the email address of
|
|
230
|
+
* that user.
|
|
231
|
+
*/
|
|
232
|
+
approved_by: string | null;
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* If your account requires approvals for transfers and the transfer was not
|
|
236
|
+
* approved, this will contain details of the cancellation.
|
|
237
|
+
*/
|
|
238
|
+
interface Cancellation {
|
|
239
|
+
/**
|
|
240
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
241
|
+
* the Transfer was canceled.
|
|
242
|
+
*/
|
|
243
|
+
canceled_at: string;
|
|
244
|
+
/**
|
|
245
|
+
* If the Transfer was canceled by a user in the dashboard, the email address of
|
|
246
|
+
* that user.
|
|
247
|
+
*/
|
|
248
|
+
canceled_by: string | null;
|
|
249
|
+
}
|
|
250
|
+
interface NotificationsOfChange {
|
|
251
|
+
/**
|
|
252
|
+
* The required type of change that is being signaled by the receiving financial
|
|
253
|
+
* institution.
|
|
254
|
+
*
|
|
255
|
+
* - `incorrect_account_number` - The account number was incorrect.
|
|
256
|
+
* - `incorrect_routing_number` - The routing number was incorrect.
|
|
257
|
+
* - `incorrect_routing_number_and_account_number` - Both the routing number and
|
|
258
|
+
* the account number were incorrect.
|
|
259
|
+
* - `incorrect_transaction_code` - The transaction code was incorrect.
|
|
260
|
+
* - `incorrect_account_number_and_transaction_code` - The account number and the
|
|
261
|
+
* transaction code were incorrect.
|
|
262
|
+
* - `incorrect_routing_number_account_number_and_transaction_code` - The routing
|
|
263
|
+
* number, account number, and transaction code were incorrect.
|
|
264
|
+
* - `incorrect_receiving_depository_financial_institution_identification` - The
|
|
265
|
+
* receiving depository financial institution identification was incorrect.
|
|
266
|
+
* - `incorrect_individual_identification_number` - The individual identification
|
|
267
|
+
* number was incorrect.
|
|
268
|
+
* - `addenda_format_error` - The addenda had an incorrect format.
|
|
269
|
+
* - `incorrect_standard_entry_class_code_for_outbound_international_payment` - The
|
|
270
|
+
* standard entry class code was incorrect for an outbound international payment.
|
|
271
|
+
* - `misrouted_notification_of_change` - The notification of change was misrouted.
|
|
272
|
+
* - `incorrect_trace_number` - The trace number was incorrect.
|
|
273
|
+
* - `incorrect_company_identification_number` - The company identification number
|
|
274
|
+
* was incorrect.
|
|
275
|
+
* - `incorrect_identification_number` - The individual identification number or
|
|
276
|
+
* identification number was incorrect.
|
|
277
|
+
* - `incorrectly_formatted_corrected_data` - The corrected data was incorrectly
|
|
278
|
+
* formatted.
|
|
279
|
+
* - `incorrect_discretionary_data` - The discretionary data was incorrect.
|
|
280
|
+
* - `routing_number_not_from_original_entry_detail_record` - The routing number
|
|
281
|
+
* was not from the original entry detail record.
|
|
282
|
+
* - `depository_financial_institution_account_number_not_from_original_entry_detail_record` -
|
|
283
|
+
* The depository financial institution account number was not from the original
|
|
284
|
+
* entry detail record.
|
|
285
|
+
* - `incorrect_transaction_code_by_originating_depository_financial_institution` -
|
|
286
|
+
* The transaction code was incorrect, initiated by the originating depository
|
|
287
|
+
* financial institution.
|
|
288
|
+
*/
|
|
289
|
+
change_code: 'incorrect_account_number' | 'incorrect_routing_number' | 'incorrect_routing_number_and_account_number' | 'incorrect_transaction_code' | 'incorrect_account_number_and_transaction_code' | 'incorrect_routing_number_account_number_and_transaction_code' | 'incorrect_receiving_depository_financial_institution_identification' | 'incorrect_individual_identification_number' | 'addenda_format_error' | 'incorrect_standard_entry_class_code_for_outbound_international_payment' | 'misrouted_notification_of_change' | 'incorrect_trace_number' | 'incorrect_company_identification_number' | 'incorrect_identification_number' | 'incorrectly_formatted_corrected_data' | 'incorrect_discretionary_data' | 'routing_number_not_from_original_entry_detail_record' | 'depository_financial_institution_account_number_not_from_original_entry_detail_record' | 'incorrect_transaction_code_by_originating_depository_financial_institution';
|
|
290
|
+
/**
|
|
291
|
+
* The corrected data that should be used in future ACHs to this account.
|
|
292
|
+
*/
|
|
293
|
+
corrected_data: string;
|
|
294
|
+
/**
|
|
295
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
296
|
+
* the notification occurred.
|
|
297
|
+
*/
|
|
298
|
+
created_at: string;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* If your transfer is returned, this will contain details of the return.
|
|
302
|
+
*/
|
|
303
|
+
interface Return {
|
|
304
|
+
/**
|
|
305
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
306
|
+
* the transfer was created.
|
|
307
|
+
*/
|
|
308
|
+
created_at: string;
|
|
309
|
+
/**
|
|
310
|
+
* The three character ACH return code, in the range R01 to R85.
|
|
311
|
+
*/
|
|
312
|
+
raw_return_reason_code: string;
|
|
313
|
+
/**
|
|
314
|
+
* Why the ACH Transfer was returned. This reason code is sent by the receiving
|
|
315
|
+
* bank back to Increase.
|
|
316
|
+
*
|
|
317
|
+
* - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
|
|
318
|
+
* Sometimes abbreviated to NSF.
|
|
319
|
+
* - `no_account` - Code R03. The account does not exist or the receiving bank was
|
|
320
|
+
* unable to locate it.
|
|
321
|
+
* - `account_closed` - Code R02. The account is closed at the receiving bank.
|
|
322
|
+
* - `invalid_account_number_structure` - Code R04. The account number is invalid
|
|
323
|
+
* at the receiving bank.
|
|
324
|
+
* - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
|
|
325
|
+
* at the receiving bank was frozen per the Office of Foreign Assets Control.
|
|
326
|
+
* - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
|
|
327
|
+
* refused a credit transfer.
|
|
328
|
+
* - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
|
|
329
|
+
* The receiving bank rejected because of an incorrect Standard Entry Class code.
|
|
330
|
+
* - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
|
|
331
|
+
* at the receiving bank reversed the transfer.
|
|
332
|
+
* - `payment_stopped` - Code R08. The receiving bank stopped payment on this
|
|
333
|
+
* transfer.
|
|
334
|
+
* - `non_transaction_account` - Code R20. The receiving bank account does not
|
|
335
|
+
* perform transfers.
|
|
336
|
+
* - `uncollected_funds` - Code R09. The receiving bank account does not have
|
|
337
|
+
* enough available balance for the transfer.
|
|
338
|
+
* - `routing_number_check_digit_error` - Code R28. The routing number is
|
|
339
|
+
* incorrect.
|
|
340
|
+
* - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
|
|
341
|
+
* The customer at the receiving bank reversed the transfer.
|
|
342
|
+
* - `amount_field_error` - Code R19. The amount field is incorrect or too large.
|
|
343
|
+
* - `authorization_revoked_by_customer` - Code R07. The customer at the receiving
|
|
344
|
+
* institution informed their bank that they have revoked authorization for a
|
|
345
|
+
* previously authorized transfer.
|
|
346
|
+
* - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
|
|
347
|
+
* - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
|
|
348
|
+
* process a field in the transfer.
|
|
349
|
+
* - `enr_invalid_individual_name` - Code R45. The individual name field was
|
|
350
|
+
* invalid.
|
|
351
|
+
* - `returned_per_odfi_request` - Code R06. The originating financial institution
|
|
352
|
+
* asked for this transfer to be returned. The receiving bank is complying with
|
|
353
|
+
* the request.
|
|
354
|
+
* - `limited_participation_dfi` - Code R34. The receiving bank's regulatory
|
|
355
|
+
* supervisor has limited their participation in the ACH network.
|
|
356
|
+
* - `incorrectly_coded_outbound_international_payment` - Code R85. The outbound
|
|
357
|
+
* international ACH transfer was incorrect.
|
|
358
|
+
* - `account_sold_to_another_dfi` - Code R12. A rare return reason. The account
|
|
359
|
+
* was sold to another bank.
|
|
360
|
+
* - `addenda_error` - Code R25. The addenda record is incorrect or missing.
|
|
361
|
+
* - `beneficiary_or_account_holder_deceased` - Code R15. A rare return reason. The
|
|
362
|
+
* account holder is deceased.
|
|
363
|
+
* - `customer_advised_not_within_authorization_terms` - Code R11. A rare return
|
|
364
|
+
* reason. The customer authorized some payment to the sender, but this payment
|
|
365
|
+
* was not in error.
|
|
366
|
+
* - `corrected_return` - Code R74. A rare return reason. Sent in response to a
|
|
367
|
+
* return that was returned with code `field_error`. The latest return should
|
|
368
|
+
* include the corrected field(s).
|
|
369
|
+
* - `duplicate_entry` - Code R24. A rare return reason. The receiving bank
|
|
370
|
+
* received an exact duplicate entry with the same trace number and amount.
|
|
371
|
+
* - `duplicate_return` - Code R67. A rare return reason. The return this message
|
|
372
|
+
* refers to was a duplicate.
|
|
373
|
+
* - `enr_duplicate_enrollment` - Code R47. A rare return reason. Only used for US
|
|
374
|
+
* Government agency non-monetary automatic enrollment messages.
|
|
375
|
+
* - `enr_invalid_dfi_account_number` - Code R43. A rare return reason. Only used
|
|
376
|
+
* for US Government agency non-monetary automatic enrollment messages.
|
|
377
|
+
* - `enr_invalid_individual_id_number` - Code R44. A rare return reason. Only used
|
|
378
|
+
* for US Government agency non-monetary automatic enrollment messages.
|
|
379
|
+
* - `enr_invalid_representative_payee_indicator` - Code R46. A rare return reason.
|
|
380
|
+
* Only used for US Government agency non-monetary automatic enrollment messages.
|
|
381
|
+
* - `enr_invalid_transaction_code` - Code R41. A rare return reason. Only used for
|
|
382
|
+
* US Government agency non-monetary automatic enrollment messages.
|
|
383
|
+
* - `enr_return_of_enr_entry` - Code R40. A rare return reason. Only used for US
|
|
384
|
+
* Government agency non-monetary automatic enrollment messages.
|
|
385
|
+
* - `enr_routing_number_check_digit_error` - Code R42. A rare return reason. Only
|
|
386
|
+
* used for US Government agency non-monetary automatic enrollment messages.
|
|
387
|
+
* - `entry_not_processed_by_gateway` - Code R84. A rare return reason. The
|
|
388
|
+
* International ACH Transfer cannot be processed by the gateway.
|
|
389
|
+
* - `field_error` - Code R69. A rare return reason. One or more of the fields in
|
|
390
|
+
* the ACH were malformed.
|
|
391
|
+
* - `foreign_receiving_dfi_unable_to_settle` - Code R83. A rare return reason. The
|
|
392
|
+
* Foreign receiving bank was unable to settle this ACH transfer.
|
|
393
|
+
* - `iat_entry_coding_error` - Code R80. A rare return reason. The International
|
|
394
|
+
* ACH Transfer is malformed.
|
|
395
|
+
* - `improper_effective_entry_date` - Code R18. A rare return reason. The ACH has
|
|
396
|
+
* an improper effective entry date field.
|
|
397
|
+
* - `improper_source_document_source_document_presented` - Code R39. A rare return
|
|
398
|
+
* reason. The source document related to this ACH, usually an ACH check
|
|
399
|
+
* conversion, was presented to the bank.
|
|
400
|
+
* - `invalid_company_id` - Code R21. A rare return reason. The Company ID field of
|
|
401
|
+
* the ACH was invalid.
|
|
402
|
+
* - `invalid_foreign_receiving_dfi_identification` - Code R82. A rare return
|
|
403
|
+
* reason. The foreign receiving bank identifier for an International ACH
|
|
404
|
+
* Transfer was invalid.
|
|
405
|
+
* - `invalid_individual_id_number` - Code R22. A rare return reason. The
|
|
406
|
+
* Individual ID number field of the ACH was invalid.
|
|
407
|
+
* - `item_and_rck_entry_presented_for_payment` - Code R53. A rare return reason.
|
|
408
|
+
* Both the Represented Check ("RCK") entry and the original check were presented
|
|
409
|
+
* to the bank.
|
|
410
|
+
* - `item_related_to_rck_entry_is_ineligible` - Code R51. A rare return reason.
|
|
411
|
+
* The Represented Check ("RCK") entry is ineligible.
|
|
412
|
+
* - `mandatory_field_error` - Code R26. A rare return reason. The ACH is missing a
|
|
413
|
+
* required field.
|
|
414
|
+
* - `misrouted_dishonored_return` - Code R71. A rare return reason. The receiving
|
|
415
|
+
* bank does not recognize the routing number in a dishonored return entry.
|
|
416
|
+
* - `misrouted_return` - Code R61. A rare return reason. The receiving bank does
|
|
417
|
+
* not recognize the routing number in a return entry.
|
|
418
|
+
* - `no_errors_found` - Code R76. A rare return reason. Sent in response to a
|
|
419
|
+
* return, the bank does not find the errors alleged by the returning bank.
|
|
420
|
+
* - `non_acceptance_of_r62_dishonored_return` - Code R77. A rare return reason.
|
|
421
|
+
* The receiving bank does not accept the return of the erroneous debit. The
|
|
422
|
+
* funds are not available at the receiving bank.
|
|
423
|
+
* - `non_participant_in_iat_program` - Code R81. A rare return reason. The
|
|
424
|
+
* receiving bank does not accept International ACH Transfers.
|
|
425
|
+
* - `permissible_return_entry` - Code R31. A rare return reason. A return that has
|
|
426
|
+
* been agreed to be accepted by the receiving bank, despite falling outside of
|
|
427
|
+
* the usual return timeframe.
|
|
428
|
+
* - `permissible_return_entry_not_accepted` - Code R70. A rare return reason. The
|
|
429
|
+
* receiving bank had not approved this return.
|
|
430
|
+
* - `rdfi_non_settlement` - Code R32. A rare return reason. The receiving bank
|
|
431
|
+
* could not settle this transaction.
|
|
432
|
+
* - `rdfi_participant_in_check_truncation_program` - Code R30. A rare return
|
|
433
|
+
* reason. The receiving bank does not accept Check Truncation ACH transfers.
|
|
434
|
+
* - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - Code
|
|
435
|
+
* R14. A rare return reason. The payee is deceased.
|
|
436
|
+
* - `return_not_a_duplicate` - Code R75. A rare return reason. The originating
|
|
437
|
+
* bank disputes that an earlier `duplicate_entry` return was actually a
|
|
438
|
+
* duplicate.
|
|
439
|
+
* - `return_of_erroneous_or_reversing_debit` - Code R62. A rare return reason. The
|
|
440
|
+
* originating financial institution made a mistake and this return corrects it.
|
|
441
|
+
* - `return_of_improper_credit_entry` - Code R36. A rare return reason. Return of
|
|
442
|
+
* a malformed credit entry.
|
|
443
|
+
* - `return_of_improper_debit_entry` - Code R35. A rare return reason. Return of a
|
|
444
|
+
* malformed debit entry.
|
|
445
|
+
* - `return_of_xck_entry` - Code R33. A rare return reason. Return of a Destroyed
|
|
446
|
+
* Check ("XKC") entry.
|
|
447
|
+
* - `source_document_presented_for_payment` - Code R37. A rare return reason. The
|
|
448
|
+
* source document related to this ACH, usually an ACH check conversion, was
|
|
449
|
+
* presented to the bank.
|
|
450
|
+
* - `state_law_affecting_rck_acceptance` - Code R50. A rare return reason. State
|
|
451
|
+
* law prevents the bank from accepting the Represented Check ("RCK") entry.
|
|
452
|
+
* - `stop_payment_on_item_related_to_rck_entry` - Code R52. A rare return reason.
|
|
453
|
+
* A stop payment was issued on a Represented Check ("RCK") entry.
|
|
454
|
+
* - `stop_payment_on_source_document` - Code R38. A rare return reason. The source
|
|
455
|
+
* attached to the ACH, usually an ACH check conversion, includes a stop payment.
|
|
456
|
+
* - `timely_original_return` - Code R73. A rare return reason. The bank receiving
|
|
457
|
+
* an `untimely_return` believes it was on time.
|
|
458
|
+
* - `trace_number_error` - Code R27. A rare return reason. An ACH return's trace
|
|
459
|
+
* number does not match an originated ACH.
|
|
460
|
+
* - `untimely_dishonored_return` - Code R72. A rare return reason. The dishonored
|
|
461
|
+
* return was sent too late.
|
|
462
|
+
* - `untimely_return` - Code R68. A rare return reason. The return was sent too
|
|
463
|
+
* late.
|
|
464
|
+
*/
|
|
465
|
+
return_reason_code: 'insufficient_fund' | 'no_account' | 'account_closed' | 'invalid_account_number_structure' | 'account_frozen_entry_returned_per_ofac_instruction' | 'credit_entry_refused_by_receiver' | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code' | 'corporate_customer_advised_not_authorized' | 'payment_stopped' | 'non_transaction_account' | 'uncollected_funds' | 'routing_number_check_digit_error' | 'customer_advised_unauthorized_improper_ineligible_or_incomplete' | 'amount_field_error' | 'authorization_revoked_by_customer' | 'invalid_ach_routing_number' | 'file_record_edit_criteria' | 'enr_invalid_individual_name' | 'returned_per_odfi_request' | 'limited_participation_dfi' | 'incorrectly_coded_outbound_international_payment' | 'account_sold_to_another_dfi' | 'addenda_error' | 'beneficiary_or_account_holder_deceased' | 'customer_advised_not_within_authorization_terms' | 'corrected_return' | 'duplicate_entry' | 'duplicate_return' | 'enr_duplicate_enrollment' | 'enr_invalid_dfi_account_number' | 'enr_invalid_individual_id_number' | 'enr_invalid_representative_payee_indicator' | 'enr_invalid_transaction_code' | 'enr_return_of_enr_entry' | 'enr_routing_number_check_digit_error' | 'entry_not_processed_by_gateway' | 'field_error' | 'foreign_receiving_dfi_unable_to_settle' | 'iat_entry_coding_error' | 'improper_effective_entry_date' | 'improper_source_document_source_document_presented' | 'invalid_company_id' | 'invalid_foreign_receiving_dfi_identification' | 'invalid_individual_id_number' | 'item_and_rck_entry_presented_for_payment' | 'item_related_to_rck_entry_is_ineligible' | 'mandatory_field_error' | 'misrouted_dishonored_return' | 'misrouted_return' | 'no_errors_found' | 'non_acceptance_of_r62_dishonored_return' | 'non_participant_in_iat_program' | 'permissible_return_entry' | 'permissible_return_entry_not_accepted' | 'rdfi_non_settlement' | 'rdfi_participant_in_check_truncation_program' | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity' | 'return_not_a_duplicate' | 'return_of_erroneous_or_reversing_debit' | 'return_of_improper_credit_entry' | 'return_of_improper_debit_entry' | 'return_of_xck_entry' | 'source_document_presented_for_payment' | 'state_law_affecting_rck_acceptance' | 'stop_payment_on_item_related_to_rck_entry' | 'stop_payment_on_source_document' | 'timely_original_return' | 'trace_number_error' | 'untimely_dishonored_return' | 'untimely_return';
|
|
466
|
+
/**
|
|
467
|
+
* The identifier of the Transaction associated with this return.
|
|
468
|
+
*/
|
|
469
|
+
transaction_id: string;
|
|
470
|
+
/**
|
|
471
|
+
* The identifier of the ACH Transfer associated with this return.
|
|
472
|
+
*/
|
|
473
|
+
transfer_id: string;
|
|
474
|
+
}
|
|
475
|
+
/**
|
|
476
|
+
* After the transfer is submitted to FedACH, this will contain supplemental
|
|
477
|
+
* details. Increase batches transfers and submits a file to the Federal Reserve
|
|
478
|
+
* roughly every 30 minutes. The Federal Reserve processes ACH transfers during
|
|
479
|
+
* weekdays according to their
|
|
480
|
+
* [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
|
|
481
|
+
*/
|
|
482
|
+
interface Submission {
|
|
483
|
+
/**
|
|
484
|
+
* When the funds transfer is expected to settle in the recipient's account.
|
|
485
|
+
* Credits may be available sooner, at the receiving banks discretion. The FedACH
|
|
486
|
+
* schedule is published
|
|
487
|
+
* [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
|
|
488
|
+
*/
|
|
489
|
+
expected_funds_settlement_at: string;
|
|
490
|
+
/**
|
|
491
|
+
* When the ACH transfer was sent to FedACH.
|
|
492
|
+
*/
|
|
493
|
+
submitted_at: string;
|
|
494
|
+
/**
|
|
495
|
+
* A 15 digit number recorded in the Nacha file and transmitted to the receiving
|
|
496
|
+
* bank. Along with the amount, date, and originating routing number, this can be
|
|
497
|
+
* used to identify the ACH transfer at the receiving bank. ACH trace numbers are
|
|
498
|
+
* not unique, but are
|
|
499
|
+
* [used to correlate returns](https://increase.com/documentation/ach#returns).
|
|
500
|
+
*/
|
|
501
|
+
trace_number: string;
|
|
502
|
+
}
|
|
692
503
|
}
|
|
693
|
-
export
|
|
694
|
-
|
|
504
|
+
export interface ACHTransferCreateParams {
|
|
505
|
+
/**
|
|
506
|
+
* The Increase identifier for the account that will send the transfer.
|
|
507
|
+
*/
|
|
508
|
+
account_id: string;
|
|
509
|
+
/**
|
|
510
|
+
* The transfer amount in cents. A positive amount originates a credit transfer
|
|
511
|
+
* pushing funds to the receiving account. A negative amount originates a debit
|
|
512
|
+
* transfer pulling funds from the receiving account.
|
|
513
|
+
*/
|
|
514
|
+
amount: number;
|
|
515
|
+
/**
|
|
516
|
+
* A description you choose to give the transfer. This will be saved with the
|
|
517
|
+
* transfer details, displayed in the dashboard, and returned by the API. If
|
|
518
|
+
* `individual_name` and `company_name` are not explicitly set by this API, the
|
|
519
|
+
* `statement_descriptor` will be sent in those fields to the receiving bank to
|
|
520
|
+
* help the customer recognize the transfer. You are highly encouraged to pass
|
|
521
|
+
* `individual_name` and `company_name` instead of relying on this fallback.
|
|
522
|
+
*/
|
|
523
|
+
statement_descriptor: string;
|
|
524
|
+
/**
|
|
525
|
+
* The account number for the destination account.
|
|
526
|
+
*/
|
|
527
|
+
account_number?: string;
|
|
528
|
+
/**
|
|
529
|
+
* Additional information that will be sent to the recipient. This is included in
|
|
530
|
+
* the transfer data sent to the receiving bank.
|
|
531
|
+
*/
|
|
532
|
+
addendum?: string;
|
|
695
533
|
/**
|
|
696
|
-
*
|
|
697
|
-
*
|
|
534
|
+
* The description of the date of the transfer, usually in the format `YYMMDD`.
|
|
535
|
+
* This is included in the transfer data sent to the receiving bank.
|
|
698
536
|
*/
|
|
699
|
-
|
|
537
|
+
company_descriptive_date?: string;
|
|
700
538
|
/**
|
|
701
|
-
*
|
|
702
|
-
*
|
|
539
|
+
* The data you choose to associate with the transfer. This is included in the
|
|
540
|
+
* transfer data sent to the receiving bank.
|
|
703
541
|
*/
|
|
704
|
-
|
|
542
|
+
company_discretionary_data?: string;
|
|
705
543
|
/**
|
|
706
|
-
*
|
|
707
|
-
*
|
|
544
|
+
* A description of the transfer. This is included in the transfer data sent to the
|
|
545
|
+
* receiving bank.
|
|
708
546
|
*/
|
|
709
|
-
|
|
547
|
+
company_entry_description?: string;
|
|
710
548
|
/**
|
|
711
|
-
*
|
|
712
|
-
*
|
|
549
|
+
* The name by which the recipient knows you. This is included in the transfer data
|
|
550
|
+
* sent to the receiving bank.
|
|
713
551
|
*/
|
|
714
|
-
|
|
715
|
-
|
|
552
|
+
company_name?: string;
|
|
553
|
+
/**
|
|
554
|
+
* The transfer effective date in
|
|
555
|
+
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
|
556
|
+
*/
|
|
557
|
+
effective_date?: string;
|
|
558
|
+
/**
|
|
559
|
+
* The ID of an External Account to initiate a transfer to. If this parameter is
|
|
560
|
+
* provided, `account_number`, `routing_number`, and `funding` must be absent.
|
|
561
|
+
*/
|
|
562
|
+
external_account_id?: string;
|
|
563
|
+
/**
|
|
564
|
+
* The type of the account to which the transfer will be sent.
|
|
565
|
+
*
|
|
566
|
+
* - `checking` - A checking account.
|
|
567
|
+
* - `savings` - A savings account.
|
|
568
|
+
*/
|
|
569
|
+
funding?: 'checking' | 'savings';
|
|
570
|
+
/**
|
|
571
|
+
* Your identifier for the transfer recipient.
|
|
572
|
+
*/
|
|
573
|
+
individual_id?: string;
|
|
574
|
+
/**
|
|
575
|
+
* The name of the transfer recipient. This value is informational and not verified
|
|
576
|
+
* by the recipient's bank.
|
|
577
|
+
*/
|
|
578
|
+
individual_name?: string;
|
|
579
|
+
/**
|
|
580
|
+
* Whether the transfer requires explicit approval via the dashboard or API.
|
|
581
|
+
*/
|
|
582
|
+
require_approval?: boolean;
|
|
583
|
+
/**
|
|
584
|
+
* The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
|
|
585
|
+
* destination account.
|
|
586
|
+
*/
|
|
587
|
+
routing_number?: string;
|
|
588
|
+
/**
|
|
589
|
+
* The Standard Entry Class (SEC) code to use for the transfer.
|
|
590
|
+
*
|
|
591
|
+
* - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
|
|
592
|
+
* - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
|
|
593
|
+
* - `internet_initiated` - Internet Initiated (WEB).
|
|
594
|
+
*/
|
|
595
|
+
standard_entry_class_code?: 'corporate_credit_or_debit' | 'prearranged_payments_and_deposit' | 'internet_initiated';
|
|
596
|
+
/**
|
|
597
|
+
* A unique identifier you choose for the transfer. Reusing this identifier for
|
|
598
|
+
* another transfer will result in an error. You can query for the transfer
|
|
599
|
+
* associated with this identifier using the List endpoint.
|
|
600
|
+
*/
|
|
601
|
+
unique_identifier?: string;
|
|
602
|
+
}
|
|
603
|
+
export interface ACHTransferListParams extends PageParams {
|
|
604
|
+
/**
|
|
605
|
+
* Filter ACH Transfers to those that originated from the specified Account.
|
|
606
|
+
*/
|
|
607
|
+
account_id?: string;
|
|
608
|
+
created_at?: ACHTransferListParams.CreatedAt;
|
|
609
|
+
/**
|
|
610
|
+
* Filter ACH Transfers to those made to the specified External Account.
|
|
611
|
+
*/
|
|
612
|
+
external_account_id?: string;
|
|
613
|
+
/**
|
|
614
|
+
* Filter ACH Transfers to the one with the specified unique identifier.
|
|
615
|
+
*/
|
|
616
|
+
unique_identifier?: string;
|
|
617
|
+
}
|
|
618
|
+
export declare namespace ACHTransferListParams {
|
|
619
|
+
interface CreatedAt {
|
|
620
|
+
/**
|
|
621
|
+
* Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
622
|
+
* timestamp.
|
|
623
|
+
*/
|
|
624
|
+
after?: string;
|
|
625
|
+
/**
|
|
626
|
+
* Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
627
|
+
* timestamp.
|
|
628
|
+
*/
|
|
629
|
+
before?: string;
|
|
630
|
+
/**
|
|
631
|
+
* Return results on or after this
|
|
632
|
+
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
633
|
+
*/
|
|
634
|
+
on_or_after?: string;
|
|
635
|
+
/**
|
|
636
|
+
* Return results on or before this
|
|
637
|
+
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
638
|
+
*/
|
|
639
|
+
on_or_before?: string;
|
|
640
|
+
}
|
|
716
641
|
}
|
|
717
642
|
export declare namespace ACHTransfers {
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
643
|
+
export import ACHTransfer = API.ACHTransfer;
|
|
644
|
+
type ACHTransfersPage = _ACHTransfersPage;
|
|
645
|
+
export import ACHTransferCreateParams = API.ACHTransferCreateParams;
|
|
646
|
+
export import ACHTransferListParams = API.ACHTransferListParams;
|
|
722
647
|
}
|
|
723
648
|
export {};
|
|
724
|
-
//# sourceMappingURL=ach-transfers.d.ts.map
|
|
649
|
+
//# sourceMappingURL=ach-transfers.d.ts.map
|