@augustusbank/typescript-sdk 0.31.0 → 0.33.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/client.d.mts +7 -4
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +7 -4
  5. package/client.d.ts.map +1 -1
  6. package/client.js +3 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +3 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/accounts.d.mts +24 -6
  12. package/resources/accounts.d.mts.map +1 -1
  13. package/resources/accounts.d.ts +24 -6
  14. package/resources/accounts.d.ts.map +1 -1
  15. package/resources/api-keys.d.mts +1 -1
  16. package/resources/api-keys.d.mts.map +1 -1
  17. package/resources/api-keys.d.ts +1 -1
  18. package/resources/api-keys.d.ts.map +1 -1
  19. package/resources/counterparties.d.mts +227 -12
  20. package/resources/counterparties.d.mts.map +1 -1
  21. package/resources/counterparties.d.ts +227 -12
  22. package/resources/counterparties.d.ts.map +1 -1
  23. package/resources/counterparties.js +16 -0
  24. package/resources/counterparties.js.map +1 -1
  25. package/resources/counterparties.mjs +16 -0
  26. package/resources/counterparties.mjs.map +1 -1
  27. package/resources/events.d.mts +3 -3
  28. package/resources/events.d.mts.map +1 -1
  29. package/resources/events.d.ts +3 -3
  30. package/resources/events.d.ts.map +1 -1
  31. package/resources/index.d.mts +3 -2
  32. package/resources/index.d.mts.map +1 -1
  33. package/resources/index.d.ts +3 -2
  34. package/resources/index.d.ts.map +1 -1
  35. package/resources/index.js +3 -1
  36. package/resources/index.js.map +1 -1
  37. package/resources/index.mjs +1 -0
  38. package/resources/index.mjs.map +1 -1
  39. package/resources/payout-tracking-events.d.mts +358 -0
  40. package/resources/payout-tracking-events.d.mts.map +1 -0
  41. package/resources/payout-tracking-events.d.ts +358 -0
  42. package/resources/payout-tracking-events.d.ts.map +1 -0
  43. package/resources/payout-tracking-events.js +23 -0
  44. package/resources/payout-tracking-events.js.map +1 -0
  45. package/resources/payout-tracking-events.mjs +19 -0
  46. package/resources/payout-tracking-events.mjs.map +1 -0
  47. package/resources/payouts.d.mts +24 -0
  48. package/resources/payouts.d.mts.map +1 -1
  49. package/resources/payouts.d.ts +24 -0
  50. package/resources/payouts.d.ts.map +1 -1
  51. package/resources/scopes.d.mts +1 -1
  52. package/resources/scopes.d.mts.map +1 -1
  53. package/resources/scopes.d.ts +1 -1
  54. package/resources/scopes.d.ts.map +1 -1
  55. package/resources/transactions.d.mts +4 -4
  56. package/resources/transactions.d.ts +4 -4
  57. package/resources/webhook-subscriptions.d.mts +8 -8
  58. package/resources/webhook-subscriptions.d.mts.map +1 -1
  59. package/resources/webhook-subscriptions.d.ts +8 -8
  60. package/resources/webhook-subscriptions.d.ts.map +1 -1
  61. package/resources/webhooks.d.mts +226 -14
  62. package/resources/webhooks.d.mts.map +1 -1
  63. package/resources/webhooks.d.ts +226 -14
  64. package/resources/webhooks.d.ts.map +1 -1
  65. package/src/client.ts +21 -0
  66. package/src/resources/accounts.ts +24 -6
  67. package/src/resources/api-keys.ts +1 -0
  68. package/src/resources/counterparties.ts +536 -12
  69. package/src/resources/events.ts +3 -0
  70. package/src/resources/index.ts +9 -0
  71. package/src/resources/payout-tracking-events.ts +479 -0
  72. package/src/resources/payouts.ts +1368 -0
  73. package/src/resources/scopes.ts +2 -1
  74. package/src/resources/transactions.ts +4 -4
  75. package/src/resources/webhook-subscriptions.ts +8 -0
  76. package/src/resources/webhooks.ts +1951 -12
  77. package/src/version.ts +1 -1
  78. package/version.d.mts +1 -1
  79. package/version.d.ts +1 -1
  80. package/version.js +1 -1
  81. package/version.mjs +1 -1
@@ -92,6 +92,348 @@ export namespace PayoutInitiatedWebhookEvent {
92
92
  */
93
93
  metadata: { [key: string]: string };
94
94
 
95
+ /**
96
+ * Purpose of the payout. Use an ISO 20022 external purpose code unless the
97
+ * beneficiary bank country requires a national code. Only supported on fedwire and
98
+ * swift payouts.
99
+ */
100
+ purpose_code:
101
+ | 'BKDF'
102
+ | 'BKFE'
103
+ | 'BKFM'
104
+ | 'BKIP'
105
+ | 'BKPP'
106
+ | 'CBLK'
107
+ | 'CDCB'
108
+ | 'CDCD'
109
+ | 'CDCS'
110
+ | 'CDDP'
111
+ | 'CDOC'
112
+ | 'CDQC'
113
+ | 'ETUP'
114
+ | 'FCOL'
115
+ | 'MTUP'
116
+ | 'ACCT'
117
+ | 'CASH'
118
+ | 'COLL'
119
+ | 'CSDB'
120
+ | 'DEPT'
121
+ | 'INTC'
122
+ | 'INTP'
123
+ | 'LIMA'
124
+ | 'NETT'
125
+ | 'BFWD'
126
+ | 'CCIR'
127
+ | 'CCPC'
128
+ | 'CCPM'
129
+ | 'CCSM'
130
+ | 'CRDS'
131
+ | 'CRPR'
132
+ | 'CRSP'
133
+ | 'CRTL'
134
+ | 'EQPT'
135
+ | 'EQUS'
136
+ | 'EXPT'
137
+ | 'EXTD'
138
+ | 'FIXI'
139
+ | 'FWBC'
140
+ | 'FWCC'
141
+ | 'FWSB'
142
+ | 'FWSC'
143
+ | 'MARG'
144
+ | 'MBSB'
145
+ | 'MBSC'
146
+ | 'MGCC'
147
+ | 'MGSC'
148
+ | 'OCCC'
149
+ | 'OPBC'
150
+ | 'OPCC'
151
+ | 'OPSB'
152
+ | 'OPSC'
153
+ | 'OPTN'
154
+ | 'OTCD'
155
+ | 'REPO'
156
+ | 'RPBC'
157
+ | 'RPCC'
158
+ | 'RPSB'
159
+ | 'RPSC'
160
+ | 'RVPO'
161
+ | 'SBSC'
162
+ | 'SCIE'
163
+ | 'SCIR'
164
+ | 'SCRP'
165
+ | 'SHBC'
166
+ | 'SHCC'
167
+ | 'SHSL'
168
+ | 'SLEB'
169
+ | 'SLOA'
170
+ | 'SWBC'
171
+ | 'SWCC'
172
+ | 'SWPT'
173
+ | 'SWSB'
174
+ | 'SWSC'
175
+ | 'TBAS'
176
+ | 'TBBC'
177
+ | 'TBCC'
178
+ | 'TRCP'
179
+ | 'AGRT'
180
+ | 'AREN'
181
+ | 'BEXP'
182
+ | 'BOCE'
183
+ | 'COMC'
184
+ | 'CPYR'
185
+ | 'GDDS'
186
+ | 'GDSV'
187
+ | 'GSCB'
188
+ | 'LICF'
189
+ | 'MP2B'
190
+ | 'POPE'
191
+ | 'ROYA'
192
+ | 'SCVE'
193
+ | 'SERV'
194
+ | 'SUBS'
195
+ | 'SUPP'
196
+ | 'TRAD'
197
+ | 'CHAR'
198
+ | 'COMT'
199
+ | 'MP2P'
200
+ | 'ECPG'
201
+ | 'ECPR'
202
+ | 'ECPU'
203
+ | 'EPAY'
204
+ | 'CLPR'
205
+ | 'COMP'
206
+ | 'DBTC'
207
+ | 'GOVI'
208
+ | 'HLRP'
209
+ | 'HLST'
210
+ | 'INPC'
211
+ | 'INPR'
212
+ | 'INSC'
213
+ | 'INSU'
214
+ | 'INTE'
215
+ | 'LBRI'
216
+ | 'LIFI'
217
+ | 'LOAN'
218
+ | 'LOAR'
219
+ | 'PENO'
220
+ | 'PPTI'
221
+ | 'RELG'
222
+ | 'RINP'
223
+ | 'TRFD'
224
+ | 'FORW'
225
+ | 'FXNT'
226
+ | 'ADMG'
227
+ | 'ADVA'
228
+ | 'BCDM'
229
+ | 'BCFG'
230
+ | 'BLDM'
231
+ | 'BNET'
232
+ | 'CBFF'
233
+ | 'CBFR'
234
+ | 'CCRD'
235
+ | 'CDBL'
236
+ | 'CFEE'
237
+ | 'CGDD'
238
+ | 'CORT'
239
+ | 'COST'
240
+ | 'CPKC'
241
+ | 'DCRD'
242
+ | 'DSMT'
243
+ | 'DVPM'
244
+ | 'EDUC'
245
+ | 'FACT'
246
+ | 'FAND'
247
+ | 'FCPM'
248
+ | 'FEES'
249
+ | 'GIFT'
250
+ | 'GOVT'
251
+ | 'ICCP'
252
+ | 'IDCP'
253
+ | 'IHRP'
254
+ | 'INSM'
255
+ | 'IVPT'
256
+ | 'MCDM'
257
+ | 'MCFG'
258
+ | 'MSVC'
259
+ | 'NOWS'
260
+ | 'OCDM'
261
+ | 'OCFG'
262
+ | 'OFEE'
263
+ | 'OTHR'
264
+ | 'PADD'
265
+ | 'PTSP'
266
+ | 'RCKE'
267
+ | 'RCPT'
268
+ | 'REBT'
269
+ | 'REFU'
270
+ | 'RENT'
271
+ | 'REOD'
272
+ | 'RIMB'
273
+ | 'RPNT'
274
+ | 'RRBN'
275
+ | 'RRCT'
276
+ | 'RRTP'
277
+ | 'RVPM'
278
+ | 'SLPI'
279
+ | 'SPLT'
280
+ | 'STDY'
281
+ | 'TBAN'
282
+ | 'TBIL'
283
+ | 'TCSC'
284
+ | 'TELI'
285
+ | 'TMPG'
286
+ | 'TPRI'
287
+ | 'TPRP'
288
+ | 'TRNC'
289
+ | 'TRVC'
290
+ | 'WEBI'
291
+ | 'IPAY'
292
+ | 'IPCA'
293
+ | 'IPDO'
294
+ | 'IPEA'
295
+ | 'IPEC'
296
+ | 'IPEW'
297
+ | 'IPPS'
298
+ | 'IPRT'
299
+ | 'IPU2'
300
+ | 'IPUW'
301
+ | 'ANNI'
302
+ | 'CAFI'
303
+ | 'CFDI'
304
+ | 'CMDT'
305
+ | 'DERI'
306
+ | 'DIVD'
307
+ | 'FREX'
308
+ | 'HEDG'
309
+ | 'INVS'
310
+ | 'PRME'
311
+ | 'SAVG'
312
+ | 'SECU'
313
+ | 'SEPI'
314
+ | 'TREA'
315
+ | 'UNIT'
316
+ | 'FNET'
317
+ | 'FUTR'
318
+ | 'ANTS'
319
+ | 'CVCF'
320
+ | 'DMEQ'
321
+ | 'DNTS'
322
+ | 'HLTC'
323
+ | 'HLTI'
324
+ | 'HSPC'
325
+ | 'ICRF'
326
+ | 'LTCF'
327
+ | 'MAFC'
328
+ | 'MARF'
329
+ | 'MDCS'
330
+ | 'VIEW'
331
+ | 'CDEP'
332
+ | 'SWFP'
333
+ | 'SWPP'
334
+ | 'SWRS'
335
+ | 'SWUF'
336
+ | 'ADCS'
337
+ | 'AEMP'
338
+ | 'ALLW'
339
+ | 'ALMY'
340
+ | 'BBSC'
341
+ | 'BECH'
342
+ | 'BENE'
343
+ | 'BONU'
344
+ | 'CCHD'
345
+ | 'COMM'
346
+ | 'CSLP'
347
+ | 'GFRP'
348
+ | 'GVEA'
349
+ | 'GVEB'
350
+ | 'GVEC'
351
+ | 'GVED'
352
+ | 'GWLT'
353
+ | 'HREC'
354
+ | 'PAYR'
355
+ | 'PEFC'
356
+ | 'PENS'
357
+ | 'PRCP'
358
+ | 'RHBS'
359
+ | 'SALA'
360
+ | 'SPSP'
361
+ | 'SSBE'
362
+ | 'LBIN'
363
+ | 'LCOL'
364
+ | 'LFEE'
365
+ | 'LMEQ'
366
+ | 'LMFI'
367
+ | 'LMRK'
368
+ | 'LREB'
369
+ | 'LREV'
370
+ | 'LSFL'
371
+ | 'ESTX'
372
+ | 'FWLV'
373
+ | 'GSTX'
374
+ | 'HSTX'
375
+ | 'INTX'
376
+ | 'NITX'
377
+ | 'PTXP'
378
+ | 'RDTX'
379
+ | 'TAXS'
380
+ | 'VATX'
381
+ | 'WHLD'
382
+ | 'TAXR'
383
+ | 'B112'
384
+ | 'BR12'
385
+ | 'TLRF'
386
+ | 'TLRR'
387
+ | 'AIRB'
388
+ | 'BUSB'
389
+ | 'FERB'
390
+ | 'RLWY'
391
+ | 'TRPT'
392
+ | 'CBTV'
393
+ | 'ELEC'
394
+ | 'ENRG'
395
+ | 'GASB'
396
+ | 'NWCH'
397
+ | 'NWCM'
398
+ | 'OTLC'
399
+ | 'PHON'
400
+ | 'UBIL'
401
+ | 'WTER'
402
+ | 'BOND'
403
+ | 'CABD'
404
+ | 'CAEQ'
405
+ | 'CBCR'
406
+ | 'DBCR'
407
+ | 'DICL'
408
+ | 'EQTS'
409
+ | 'FLCR'
410
+ | 'EFTC'
411
+ | 'EFTD'
412
+ | 'MOMA'
413
+ | 'RAPI'
414
+ | 'GAMB'
415
+ | 'LOTT'
416
+ | 'AMEX'
417
+ | 'SASW'
418
+ | 'AUCO'
419
+ | 'PCOM'
420
+ | 'PDEP'
421
+ | 'PLDS'
422
+ | 'PLRF'
423
+ | 'GAFA'
424
+ | 'GAHO'
425
+ | 'CPEN'
426
+ | 'DEPD'
427
+ | 'RETL'
428
+ | 'DEBT'
429
+ | 'CAP'
430
+ | 'GDS'
431
+ | 'SRV'
432
+ | 'CAC'
433
+ | 'FTF'
434
+ | (string & {})
435
+ | null;
436
+
95
437
  /**
96
438
  * Payment scheme or blockchain used for the payout, or null when unknown.
97
439
  */
@@ -276,6 +618,348 @@ export namespace PayoutSubmittedWebhookEvent {
276
618
  */
277
619
  metadata: { [key: string]: string };
278
620
 
621
+ /**
622
+ * Purpose of the payout. Use an ISO 20022 external purpose code unless the
623
+ * beneficiary bank country requires a national code. Only supported on fedwire and
624
+ * swift payouts.
625
+ */
626
+ purpose_code:
627
+ | 'BKDF'
628
+ | 'BKFE'
629
+ | 'BKFM'
630
+ | 'BKIP'
631
+ | 'BKPP'
632
+ | 'CBLK'
633
+ | 'CDCB'
634
+ | 'CDCD'
635
+ | 'CDCS'
636
+ | 'CDDP'
637
+ | 'CDOC'
638
+ | 'CDQC'
639
+ | 'ETUP'
640
+ | 'FCOL'
641
+ | 'MTUP'
642
+ | 'ACCT'
643
+ | 'CASH'
644
+ | 'COLL'
645
+ | 'CSDB'
646
+ | 'DEPT'
647
+ | 'INTC'
648
+ | 'INTP'
649
+ | 'LIMA'
650
+ | 'NETT'
651
+ | 'BFWD'
652
+ | 'CCIR'
653
+ | 'CCPC'
654
+ | 'CCPM'
655
+ | 'CCSM'
656
+ | 'CRDS'
657
+ | 'CRPR'
658
+ | 'CRSP'
659
+ | 'CRTL'
660
+ | 'EQPT'
661
+ | 'EQUS'
662
+ | 'EXPT'
663
+ | 'EXTD'
664
+ | 'FIXI'
665
+ | 'FWBC'
666
+ | 'FWCC'
667
+ | 'FWSB'
668
+ | 'FWSC'
669
+ | 'MARG'
670
+ | 'MBSB'
671
+ | 'MBSC'
672
+ | 'MGCC'
673
+ | 'MGSC'
674
+ | 'OCCC'
675
+ | 'OPBC'
676
+ | 'OPCC'
677
+ | 'OPSB'
678
+ | 'OPSC'
679
+ | 'OPTN'
680
+ | 'OTCD'
681
+ | 'REPO'
682
+ | 'RPBC'
683
+ | 'RPCC'
684
+ | 'RPSB'
685
+ | 'RPSC'
686
+ | 'RVPO'
687
+ | 'SBSC'
688
+ | 'SCIE'
689
+ | 'SCIR'
690
+ | 'SCRP'
691
+ | 'SHBC'
692
+ | 'SHCC'
693
+ | 'SHSL'
694
+ | 'SLEB'
695
+ | 'SLOA'
696
+ | 'SWBC'
697
+ | 'SWCC'
698
+ | 'SWPT'
699
+ | 'SWSB'
700
+ | 'SWSC'
701
+ | 'TBAS'
702
+ | 'TBBC'
703
+ | 'TBCC'
704
+ | 'TRCP'
705
+ | 'AGRT'
706
+ | 'AREN'
707
+ | 'BEXP'
708
+ | 'BOCE'
709
+ | 'COMC'
710
+ | 'CPYR'
711
+ | 'GDDS'
712
+ | 'GDSV'
713
+ | 'GSCB'
714
+ | 'LICF'
715
+ | 'MP2B'
716
+ | 'POPE'
717
+ | 'ROYA'
718
+ | 'SCVE'
719
+ | 'SERV'
720
+ | 'SUBS'
721
+ | 'SUPP'
722
+ | 'TRAD'
723
+ | 'CHAR'
724
+ | 'COMT'
725
+ | 'MP2P'
726
+ | 'ECPG'
727
+ | 'ECPR'
728
+ | 'ECPU'
729
+ | 'EPAY'
730
+ | 'CLPR'
731
+ | 'COMP'
732
+ | 'DBTC'
733
+ | 'GOVI'
734
+ | 'HLRP'
735
+ | 'HLST'
736
+ | 'INPC'
737
+ | 'INPR'
738
+ | 'INSC'
739
+ | 'INSU'
740
+ | 'INTE'
741
+ | 'LBRI'
742
+ | 'LIFI'
743
+ | 'LOAN'
744
+ | 'LOAR'
745
+ | 'PENO'
746
+ | 'PPTI'
747
+ | 'RELG'
748
+ | 'RINP'
749
+ | 'TRFD'
750
+ | 'FORW'
751
+ | 'FXNT'
752
+ | 'ADMG'
753
+ | 'ADVA'
754
+ | 'BCDM'
755
+ | 'BCFG'
756
+ | 'BLDM'
757
+ | 'BNET'
758
+ | 'CBFF'
759
+ | 'CBFR'
760
+ | 'CCRD'
761
+ | 'CDBL'
762
+ | 'CFEE'
763
+ | 'CGDD'
764
+ | 'CORT'
765
+ | 'COST'
766
+ | 'CPKC'
767
+ | 'DCRD'
768
+ | 'DSMT'
769
+ | 'DVPM'
770
+ | 'EDUC'
771
+ | 'FACT'
772
+ | 'FAND'
773
+ | 'FCPM'
774
+ | 'FEES'
775
+ | 'GIFT'
776
+ | 'GOVT'
777
+ | 'ICCP'
778
+ | 'IDCP'
779
+ | 'IHRP'
780
+ | 'INSM'
781
+ | 'IVPT'
782
+ | 'MCDM'
783
+ | 'MCFG'
784
+ | 'MSVC'
785
+ | 'NOWS'
786
+ | 'OCDM'
787
+ | 'OCFG'
788
+ | 'OFEE'
789
+ | 'OTHR'
790
+ | 'PADD'
791
+ | 'PTSP'
792
+ | 'RCKE'
793
+ | 'RCPT'
794
+ | 'REBT'
795
+ | 'REFU'
796
+ | 'RENT'
797
+ | 'REOD'
798
+ | 'RIMB'
799
+ | 'RPNT'
800
+ | 'RRBN'
801
+ | 'RRCT'
802
+ | 'RRTP'
803
+ | 'RVPM'
804
+ | 'SLPI'
805
+ | 'SPLT'
806
+ | 'STDY'
807
+ | 'TBAN'
808
+ | 'TBIL'
809
+ | 'TCSC'
810
+ | 'TELI'
811
+ | 'TMPG'
812
+ | 'TPRI'
813
+ | 'TPRP'
814
+ | 'TRNC'
815
+ | 'TRVC'
816
+ | 'WEBI'
817
+ | 'IPAY'
818
+ | 'IPCA'
819
+ | 'IPDO'
820
+ | 'IPEA'
821
+ | 'IPEC'
822
+ | 'IPEW'
823
+ | 'IPPS'
824
+ | 'IPRT'
825
+ | 'IPU2'
826
+ | 'IPUW'
827
+ | 'ANNI'
828
+ | 'CAFI'
829
+ | 'CFDI'
830
+ | 'CMDT'
831
+ | 'DERI'
832
+ | 'DIVD'
833
+ | 'FREX'
834
+ | 'HEDG'
835
+ | 'INVS'
836
+ | 'PRME'
837
+ | 'SAVG'
838
+ | 'SECU'
839
+ | 'SEPI'
840
+ | 'TREA'
841
+ | 'UNIT'
842
+ | 'FNET'
843
+ | 'FUTR'
844
+ | 'ANTS'
845
+ | 'CVCF'
846
+ | 'DMEQ'
847
+ | 'DNTS'
848
+ | 'HLTC'
849
+ | 'HLTI'
850
+ | 'HSPC'
851
+ | 'ICRF'
852
+ | 'LTCF'
853
+ | 'MAFC'
854
+ | 'MARF'
855
+ | 'MDCS'
856
+ | 'VIEW'
857
+ | 'CDEP'
858
+ | 'SWFP'
859
+ | 'SWPP'
860
+ | 'SWRS'
861
+ | 'SWUF'
862
+ | 'ADCS'
863
+ | 'AEMP'
864
+ | 'ALLW'
865
+ | 'ALMY'
866
+ | 'BBSC'
867
+ | 'BECH'
868
+ | 'BENE'
869
+ | 'BONU'
870
+ | 'CCHD'
871
+ | 'COMM'
872
+ | 'CSLP'
873
+ | 'GFRP'
874
+ | 'GVEA'
875
+ | 'GVEB'
876
+ | 'GVEC'
877
+ | 'GVED'
878
+ | 'GWLT'
879
+ | 'HREC'
880
+ | 'PAYR'
881
+ | 'PEFC'
882
+ | 'PENS'
883
+ | 'PRCP'
884
+ | 'RHBS'
885
+ | 'SALA'
886
+ | 'SPSP'
887
+ | 'SSBE'
888
+ | 'LBIN'
889
+ | 'LCOL'
890
+ | 'LFEE'
891
+ | 'LMEQ'
892
+ | 'LMFI'
893
+ | 'LMRK'
894
+ | 'LREB'
895
+ | 'LREV'
896
+ | 'LSFL'
897
+ | 'ESTX'
898
+ | 'FWLV'
899
+ | 'GSTX'
900
+ | 'HSTX'
901
+ | 'INTX'
902
+ | 'NITX'
903
+ | 'PTXP'
904
+ | 'RDTX'
905
+ | 'TAXS'
906
+ | 'VATX'
907
+ | 'WHLD'
908
+ | 'TAXR'
909
+ | 'B112'
910
+ | 'BR12'
911
+ | 'TLRF'
912
+ | 'TLRR'
913
+ | 'AIRB'
914
+ | 'BUSB'
915
+ | 'FERB'
916
+ | 'RLWY'
917
+ | 'TRPT'
918
+ | 'CBTV'
919
+ | 'ELEC'
920
+ | 'ENRG'
921
+ | 'GASB'
922
+ | 'NWCH'
923
+ | 'NWCM'
924
+ | 'OTLC'
925
+ | 'PHON'
926
+ | 'UBIL'
927
+ | 'WTER'
928
+ | 'BOND'
929
+ | 'CABD'
930
+ | 'CAEQ'
931
+ | 'CBCR'
932
+ | 'DBCR'
933
+ | 'DICL'
934
+ | 'EQTS'
935
+ | 'FLCR'
936
+ | 'EFTC'
937
+ | 'EFTD'
938
+ | 'MOMA'
939
+ | 'RAPI'
940
+ | 'GAMB'
941
+ | 'LOTT'
942
+ | 'AMEX'
943
+ | 'SASW'
944
+ | 'AUCO'
945
+ | 'PCOM'
946
+ | 'PDEP'
947
+ | 'PLDS'
948
+ | 'PLRF'
949
+ | 'GAFA'
950
+ | 'GAHO'
951
+ | 'CPEN'
952
+ | 'DEPD'
953
+ | 'RETL'
954
+ | 'DEBT'
955
+ | 'CAP'
956
+ | 'GDS'
957
+ | 'SRV'
958
+ | 'CAC'
959
+ | 'FTF'
960
+ | (string & {})
961
+ | null;
962
+
279
963
  /**
280
964
  * Payment scheme or blockchain used for the payout, or null when unknown.
281
965
  */
@@ -460,6 +1144,348 @@ export namespace PayoutSentWebhookEvent {
460
1144
  */
461
1145
  metadata: { [key: string]: string };
462
1146
 
1147
+ /**
1148
+ * Purpose of the payout. Use an ISO 20022 external purpose code unless the
1149
+ * beneficiary bank country requires a national code. Only supported on fedwire and
1150
+ * swift payouts.
1151
+ */
1152
+ purpose_code:
1153
+ | 'BKDF'
1154
+ | 'BKFE'
1155
+ | 'BKFM'
1156
+ | 'BKIP'
1157
+ | 'BKPP'
1158
+ | 'CBLK'
1159
+ | 'CDCB'
1160
+ | 'CDCD'
1161
+ | 'CDCS'
1162
+ | 'CDDP'
1163
+ | 'CDOC'
1164
+ | 'CDQC'
1165
+ | 'ETUP'
1166
+ | 'FCOL'
1167
+ | 'MTUP'
1168
+ | 'ACCT'
1169
+ | 'CASH'
1170
+ | 'COLL'
1171
+ | 'CSDB'
1172
+ | 'DEPT'
1173
+ | 'INTC'
1174
+ | 'INTP'
1175
+ | 'LIMA'
1176
+ | 'NETT'
1177
+ | 'BFWD'
1178
+ | 'CCIR'
1179
+ | 'CCPC'
1180
+ | 'CCPM'
1181
+ | 'CCSM'
1182
+ | 'CRDS'
1183
+ | 'CRPR'
1184
+ | 'CRSP'
1185
+ | 'CRTL'
1186
+ | 'EQPT'
1187
+ | 'EQUS'
1188
+ | 'EXPT'
1189
+ | 'EXTD'
1190
+ | 'FIXI'
1191
+ | 'FWBC'
1192
+ | 'FWCC'
1193
+ | 'FWSB'
1194
+ | 'FWSC'
1195
+ | 'MARG'
1196
+ | 'MBSB'
1197
+ | 'MBSC'
1198
+ | 'MGCC'
1199
+ | 'MGSC'
1200
+ | 'OCCC'
1201
+ | 'OPBC'
1202
+ | 'OPCC'
1203
+ | 'OPSB'
1204
+ | 'OPSC'
1205
+ | 'OPTN'
1206
+ | 'OTCD'
1207
+ | 'REPO'
1208
+ | 'RPBC'
1209
+ | 'RPCC'
1210
+ | 'RPSB'
1211
+ | 'RPSC'
1212
+ | 'RVPO'
1213
+ | 'SBSC'
1214
+ | 'SCIE'
1215
+ | 'SCIR'
1216
+ | 'SCRP'
1217
+ | 'SHBC'
1218
+ | 'SHCC'
1219
+ | 'SHSL'
1220
+ | 'SLEB'
1221
+ | 'SLOA'
1222
+ | 'SWBC'
1223
+ | 'SWCC'
1224
+ | 'SWPT'
1225
+ | 'SWSB'
1226
+ | 'SWSC'
1227
+ | 'TBAS'
1228
+ | 'TBBC'
1229
+ | 'TBCC'
1230
+ | 'TRCP'
1231
+ | 'AGRT'
1232
+ | 'AREN'
1233
+ | 'BEXP'
1234
+ | 'BOCE'
1235
+ | 'COMC'
1236
+ | 'CPYR'
1237
+ | 'GDDS'
1238
+ | 'GDSV'
1239
+ | 'GSCB'
1240
+ | 'LICF'
1241
+ | 'MP2B'
1242
+ | 'POPE'
1243
+ | 'ROYA'
1244
+ | 'SCVE'
1245
+ | 'SERV'
1246
+ | 'SUBS'
1247
+ | 'SUPP'
1248
+ | 'TRAD'
1249
+ | 'CHAR'
1250
+ | 'COMT'
1251
+ | 'MP2P'
1252
+ | 'ECPG'
1253
+ | 'ECPR'
1254
+ | 'ECPU'
1255
+ | 'EPAY'
1256
+ | 'CLPR'
1257
+ | 'COMP'
1258
+ | 'DBTC'
1259
+ | 'GOVI'
1260
+ | 'HLRP'
1261
+ | 'HLST'
1262
+ | 'INPC'
1263
+ | 'INPR'
1264
+ | 'INSC'
1265
+ | 'INSU'
1266
+ | 'INTE'
1267
+ | 'LBRI'
1268
+ | 'LIFI'
1269
+ | 'LOAN'
1270
+ | 'LOAR'
1271
+ | 'PENO'
1272
+ | 'PPTI'
1273
+ | 'RELG'
1274
+ | 'RINP'
1275
+ | 'TRFD'
1276
+ | 'FORW'
1277
+ | 'FXNT'
1278
+ | 'ADMG'
1279
+ | 'ADVA'
1280
+ | 'BCDM'
1281
+ | 'BCFG'
1282
+ | 'BLDM'
1283
+ | 'BNET'
1284
+ | 'CBFF'
1285
+ | 'CBFR'
1286
+ | 'CCRD'
1287
+ | 'CDBL'
1288
+ | 'CFEE'
1289
+ | 'CGDD'
1290
+ | 'CORT'
1291
+ | 'COST'
1292
+ | 'CPKC'
1293
+ | 'DCRD'
1294
+ | 'DSMT'
1295
+ | 'DVPM'
1296
+ | 'EDUC'
1297
+ | 'FACT'
1298
+ | 'FAND'
1299
+ | 'FCPM'
1300
+ | 'FEES'
1301
+ | 'GIFT'
1302
+ | 'GOVT'
1303
+ | 'ICCP'
1304
+ | 'IDCP'
1305
+ | 'IHRP'
1306
+ | 'INSM'
1307
+ | 'IVPT'
1308
+ | 'MCDM'
1309
+ | 'MCFG'
1310
+ | 'MSVC'
1311
+ | 'NOWS'
1312
+ | 'OCDM'
1313
+ | 'OCFG'
1314
+ | 'OFEE'
1315
+ | 'OTHR'
1316
+ | 'PADD'
1317
+ | 'PTSP'
1318
+ | 'RCKE'
1319
+ | 'RCPT'
1320
+ | 'REBT'
1321
+ | 'REFU'
1322
+ | 'RENT'
1323
+ | 'REOD'
1324
+ | 'RIMB'
1325
+ | 'RPNT'
1326
+ | 'RRBN'
1327
+ | 'RRCT'
1328
+ | 'RRTP'
1329
+ | 'RVPM'
1330
+ | 'SLPI'
1331
+ | 'SPLT'
1332
+ | 'STDY'
1333
+ | 'TBAN'
1334
+ | 'TBIL'
1335
+ | 'TCSC'
1336
+ | 'TELI'
1337
+ | 'TMPG'
1338
+ | 'TPRI'
1339
+ | 'TPRP'
1340
+ | 'TRNC'
1341
+ | 'TRVC'
1342
+ | 'WEBI'
1343
+ | 'IPAY'
1344
+ | 'IPCA'
1345
+ | 'IPDO'
1346
+ | 'IPEA'
1347
+ | 'IPEC'
1348
+ | 'IPEW'
1349
+ | 'IPPS'
1350
+ | 'IPRT'
1351
+ | 'IPU2'
1352
+ | 'IPUW'
1353
+ | 'ANNI'
1354
+ | 'CAFI'
1355
+ | 'CFDI'
1356
+ | 'CMDT'
1357
+ | 'DERI'
1358
+ | 'DIVD'
1359
+ | 'FREX'
1360
+ | 'HEDG'
1361
+ | 'INVS'
1362
+ | 'PRME'
1363
+ | 'SAVG'
1364
+ | 'SECU'
1365
+ | 'SEPI'
1366
+ | 'TREA'
1367
+ | 'UNIT'
1368
+ | 'FNET'
1369
+ | 'FUTR'
1370
+ | 'ANTS'
1371
+ | 'CVCF'
1372
+ | 'DMEQ'
1373
+ | 'DNTS'
1374
+ | 'HLTC'
1375
+ | 'HLTI'
1376
+ | 'HSPC'
1377
+ | 'ICRF'
1378
+ | 'LTCF'
1379
+ | 'MAFC'
1380
+ | 'MARF'
1381
+ | 'MDCS'
1382
+ | 'VIEW'
1383
+ | 'CDEP'
1384
+ | 'SWFP'
1385
+ | 'SWPP'
1386
+ | 'SWRS'
1387
+ | 'SWUF'
1388
+ | 'ADCS'
1389
+ | 'AEMP'
1390
+ | 'ALLW'
1391
+ | 'ALMY'
1392
+ | 'BBSC'
1393
+ | 'BECH'
1394
+ | 'BENE'
1395
+ | 'BONU'
1396
+ | 'CCHD'
1397
+ | 'COMM'
1398
+ | 'CSLP'
1399
+ | 'GFRP'
1400
+ | 'GVEA'
1401
+ | 'GVEB'
1402
+ | 'GVEC'
1403
+ | 'GVED'
1404
+ | 'GWLT'
1405
+ | 'HREC'
1406
+ | 'PAYR'
1407
+ | 'PEFC'
1408
+ | 'PENS'
1409
+ | 'PRCP'
1410
+ | 'RHBS'
1411
+ | 'SALA'
1412
+ | 'SPSP'
1413
+ | 'SSBE'
1414
+ | 'LBIN'
1415
+ | 'LCOL'
1416
+ | 'LFEE'
1417
+ | 'LMEQ'
1418
+ | 'LMFI'
1419
+ | 'LMRK'
1420
+ | 'LREB'
1421
+ | 'LREV'
1422
+ | 'LSFL'
1423
+ | 'ESTX'
1424
+ | 'FWLV'
1425
+ | 'GSTX'
1426
+ | 'HSTX'
1427
+ | 'INTX'
1428
+ | 'NITX'
1429
+ | 'PTXP'
1430
+ | 'RDTX'
1431
+ | 'TAXS'
1432
+ | 'VATX'
1433
+ | 'WHLD'
1434
+ | 'TAXR'
1435
+ | 'B112'
1436
+ | 'BR12'
1437
+ | 'TLRF'
1438
+ | 'TLRR'
1439
+ | 'AIRB'
1440
+ | 'BUSB'
1441
+ | 'FERB'
1442
+ | 'RLWY'
1443
+ | 'TRPT'
1444
+ | 'CBTV'
1445
+ | 'ELEC'
1446
+ | 'ENRG'
1447
+ | 'GASB'
1448
+ | 'NWCH'
1449
+ | 'NWCM'
1450
+ | 'OTLC'
1451
+ | 'PHON'
1452
+ | 'UBIL'
1453
+ | 'WTER'
1454
+ | 'BOND'
1455
+ | 'CABD'
1456
+ | 'CAEQ'
1457
+ | 'CBCR'
1458
+ | 'DBCR'
1459
+ | 'DICL'
1460
+ | 'EQTS'
1461
+ | 'FLCR'
1462
+ | 'EFTC'
1463
+ | 'EFTD'
1464
+ | 'MOMA'
1465
+ | 'RAPI'
1466
+ | 'GAMB'
1467
+ | 'LOTT'
1468
+ | 'AMEX'
1469
+ | 'SASW'
1470
+ | 'AUCO'
1471
+ | 'PCOM'
1472
+ | 'PDEP'
1473
+ | 'PLDS'
1474
+ | 'PLRF'
1475
+ | 'GAFA'
1476
+ | 'GAHO'
1477
+ | 'CPEN'
1478
+ | 'DEPD'
1479
+ | 'RETL'
1480
+ | 'DEBT'
1481
+ | 'CAP'
1482
+ | 'GDS'
1483
+ | 'SRV'
1484
+ | 'CAC'
1485
+ | 'FTF'
1486
+ | (string & {})
1487
+ | null;
1488
+
463
1489
  /**
464
1490
  * Payment scheme or blockchain used for the payout, or null when unknown.
465
1491
  */
@@ -644,6 +1670,348 @@ export namespace PayoutFailedWebhookEvent {
644
1670
  */
645
1671
  metadata: { [key: string]: string };
646
1672
 
1673
+ /**
1674
+ * Purpose of the payout. Use an ISO 20022 external purpose code unless the
1675
+ * beneficiary bank country requires a national code. Only supported on fedwire and
1676
+ * swift payouts.
1677
+ */
1678
+ purpose_code:
1679
+ | 'BKDF'
1680
+ | 'BKFE'
1681
+ | 'BKFM'
1682
+ | 'BKIP'
1683
+ | 'BKPP'
1684
+ | 'CBLK'
1685
+ | 'CDCB'
1686
+ | 'CDCD'
1687
+ | 'CDCS'
1688
+ | 'CDDP'
1689
+ | 'CDOC'
1690
+ | 'CDQC'
1691
+ | 'ETUP'
1692
+ | 'FCOL'
1693
+ | 'MTUP'
1694
+ | 'ACCT'
1695
+ | 'CASH'
1696
+ | 'COLL'
1697
+ | 'CSDB'
1698
+ | 'DEPT'
1699
+ | 'INTC'
1700
+ | 'INTP'
1701
+ | 'LIMA'
1702
+ | 'NETT'
1703
+ | 'BFWD'
1704
+ | 'CCIR'
1705
+ | 'CCPC'
1706
+ | 'CCPM'
1707
+ | 'CCSM'
1708
+ | 'CRDS'
1709
+ | 'CRPR'
1710
+ | 'CRSP'
1711
+ | 'CRTL'
1712
+ | 'EQPT'
1713
+ | 'EQUS'
1714
+ | 'EXPT'
1715
+ | 'EXTD'
1716
+ | 'FIXI'
1717
+ | 'FWBC'
1718
+ | 'FWCC'
1719
+ | 'FWSB'
1720
+ | 'FWSC'
1721
+ | 'MARG'
1722
+ | 'MBSB'
1723
+ | 'MBSC'
1724
+ | 'MGCC'
1725
+ | 'MGSC'
1726
+ | 'OCCC'
1727
+ | 'OPBC'
1728
+ | 'OPCC'
1729
+ | 'OPSB'
1730
+ | 'OPSC'
1731
+ | 'OPTN'
1732
+ | 'OTCD'
1733
+ | 'REPO'
1734
+ | 'RPBC'
1735
+ | 'RPCC'
1736
+ | 'RPSB'
1737
+ | 'RPSC'
1738
+ | 'RVPO'
1739
+ | 'SBSC'
1740
+ | 'SCIE'
1741
+ | 'SCIR'
1742
+ | 'SCRP'
1743
+ | 'SHBC'
1744
+ | 'SHCC'
1745
+ | 'SHSL'
1746
+ | 'SLEB'
1747
+ | 'SLOA'
1748
+ | 'SWBC'
1749
+ | 'SWCC'
1750
+ | 'SWPT'
1751
+ | 'SWSB'
1752
+ | 'SWSC'
1753
+ | 'TBAS'
1754
+ | 'TBBC'
1755
+ | 'TBCC'
1756
+ | 'TRCP'
1757
+ | 'AGRT'
1758
+ | 'AREN'
1759
+ | 'BEXP'
1760
+ | 'BOCE'
1761
+ | 'COMC'
1762
+ | 'CPYR'
1763
+ | 'GDDS'
1764
+ | 'GDSV'
1765
+ | 'GSCB'
1766
+ | 'LICF'
1767
+ | 'MP2B'
1768
+ | 'POPE'
1769
+ | 'ROYA'
1770
+ | 'SCVE'
1771
+ | 'SERV'
1772
+ | 'SUBS'
1773
+ | 'SUPP'
1774
+ | 'TRAD'
1775
+ | 'CHAR'
1776
+ | 'COMT'
1777
+ | 'MP2P'
1778
+ | 'ECPG'
1779
+ | 'ECPR'
1780
+ | 'ECPU'
1781
+ | 'EPAY'
1782
+ | 'CLPR'
1783
+ | 'COMP'
1784
+ | 'DBTC'
1785
+ | 'GOVI'
1786
+ | 'HLRP'
1787
+ | 'HLST'
1788
+ | 'INPC'
1789
+ | 'INPR'
1790
+ | 'INSC'
1791
+ | 'INSU'
1792
+ | 'INTE'
1793
+ | 'LBRI'
1794
+ | 'LIFI'
1795
+ | 'LOAN'
1796
+ | 'LOAR'
1797
+ | 'PENO'
1798
+ | 'PPTI'
1799
+ | 'RELG'
1800
+ | 'RINP'
1801
+ | 'TRFD'
1802
+ | 'FORW'
1803
+ | 'FXNT'
1804
+ | 'ADMG'
1805
+ | 'ADVA'
1806
+ | 'BCDM'
1807
+ | 'BCFG'
1808
+ | 'BLDM'
1809
+ | 'BNET'
1810
+ | 'CBFF'
1811
+ | 'CBFR'
1812
+ | 'CCRD'
1813
+ | 'CDBL'
1814
+ | 'CFEE'
1815
+ | 'CGDD'
1816
+ | 'CORT'
1817
+ | 'COST'
1818
+ | 'CPKC'
1819
+ | 'DCRD'
1820
+ | 'DSMT'
1821
+ | 'DVPM'
1822
+ | 'EDUC'
1823
+ | 'FACT'
1824
+ | 'FAND'
1825
+ | 'FCPM'
1826
+ | 'FEES'
1827
+ | 'GIFT'
1828
+ | 'GOVT'
1829
+ | 'ICCP'
1830
+ | 'IDCP'
1831
+ | 'IHRP'
1832
+ | 'INSM'
1833
+ | 'IVPT'
1834
+ | 'MCDM'
1835
+ | 'MCFG'
1836
+ | 'MSVC'
1837
+ | 'NOWS'
1838
+ | 'OCDM'
1839
+ | 'OCFG'
1840
+ | 'OFEE'
1841
+ | 'OTHR'
1842
+ | 'PADD'
1843
+ | 'PTSP'
1844
+ | 'RCKE'
1845
+ | 'RCPT'
1846
+ | 'REBT'
1847
+ | 'REFU'
1848
+ | 'RENT'
1849
+ | 'REOD'
1850
+ | 'RIMB'
1851
+ | 'RPNT'
1852
+ | 'RRBN'
1853
+ | 'RRCT'
1854
+ | 'RRTP'
1855
+ | 'RVPM'
1856
+ | 'SLPI'
1857
+ | 'SPLT'
1858
+ | 'STDY'
1859
+ | 'TBAN'
1860
+ | 'TBIL'
1861
+ | 'TCSC'
1862
+ | 'TELI'
1863
+ | 'TMPG'
1864
+ | 'TPRI'
1865
+ | 'TPRP'
1866
+ | 'TRNC'
1867
+ | 'TRVC'
1868
+ | 'WEBI'
1869
+ | 'IPAY'
1870
+ | 'IPCA'
1871
+ | 'IPDO'
1872
+ | 'IPEA'
1873
+ | 'IPEC'
1874
+ | 'IPEW'
1875
+ | 'IPPS'
1876
+ | 'IPRT'
1877
+ | 'IPU2'
1878
+ | 'IPUW'
1879
+ | 'ANNI'
1880
+ | 'CAFI'
1881
+ | 'CFDI'
1882
+ | 'CMDT'
1883
+ | 'DERI'
1884
+ | 'DIVD'
1885
+ | 'FREX'
1886
+ | 'HEDG'
1887
+ | 'INVS'
1888
+ | 'PRME'
1889
+ | 'SAVG'
1890
+ | 'SECU'
1891
+ | 'SEPI'
1892
+ | 'TREA'
1893
+ | 'UNIT'
1894
+ | 'FNET'
1895
+ | 'FUTR'
1896
+ | 'ANTS'
1897
+ | 'CVCF'
1898
+ | 'DMEQ'
1899
+ | 'DNTS'
1900
+ | 'HLTC'
1901
+ | 'HLTI'
1902
+ | 'HSPC'
1903
+ | 'ICRF'
1904
+ | 'LTCF'
1905
+ | 'MAFC'
1906
+ | 'MARF'
1907
+ | 'MDCS'
1908
+ | 'VIEW'
1909
+ | 'CDEP'
1910
+ | 'SWFP'
1911
+ | 'SWPP'
1912
+ | 'SWRS'
1913
+ | 'SWUF'
1914
+ | 'ADCS'
1915
+ | 'AEMP'
1916
+ | 'ALLW'
1917
+ | 'ALMY'
1918
+ | 'BBSC'
1919
+ | 'BECH'
1920
+ | 'BENE'
1921
+ | 'BONU'
1922
+ | 'CCHD'
1923
+ | 'COMM'
1924
+ | 'CSLP'
1925
+ | 'GFRP'
1926
+ | 'GVEA'
1927
+ | 'GVEB'
1928
+ | 'GVEC'
1929
+ | 'GVED'
1930
+ | 'GWLT'
1931
+ | 'HREC'
1932
+ | 'PAYR'
1933
+ | 'PEFC'
1934
+ | 'PENS'
1935
+ | 'PRCP'
1936
+ | 'RHBS'
1937
+ | 'SALA'
1938
+ | 'SPSP'
1939
+ | 'SSBE'
1940
+ | 'LBIN'
1941
+ | 'LCOL'
1942
+ | 'LFEE'
1943
+ | 'LMEQ'
1944
+ | 'LMFI'
1945
+ | 'LMRK'
1946
+ | 'LREB'
1947
+ | 'LREV'
1948
+ | 'LSFL'
1949
+ | 'ESTX'
1950
+ | 'FWLV'
1951
+ | 'GSTX'
1952
+ | 'HSTX'
1953
+ | 'INTX'
1954
+ | 'NITX'
1955
+ | 'PTXP'
1956
+ | 'RDTX'
1957
+ | 'TAXS'
1958
+ | 'VATX'
1959
+ | 'WHLD'
1960
+ | 'TAXR'
1961
+ | 'B112'
1962
+ | 'BR12'
1963
+ | 'TLRF'
1964
+ | 'TLRR'
1965
+ | 'AIRB'
1966
+ | 'BUSB'
1967
+ | 'FERB'
1968
+ | 'RLWY'
1969
+ | 'TRPT'
1970
+ | 'CBTV'
1971
+ | 'ELEC'
1972
+ | 'ENRG'
1973
+ | 'GASB'
1974
+ | 'NWCH'
1975
+ | 'NWCM'
1976
+ | 'OTLC'
1977
+ | 'PHON'
1978
+ | 'UBIL'
1979
+ | 'WTER'
1980
+ | 'BOND'
1981
+ | 'CABD'
1982
+ | 'CAEQ'
1983
+ | 'CBCR'
1984
+ | 'DBCR'
1985
+ | 'DICL'
1986
+ | 'EQTS'
1987
+ | 'FLCR'
1988
+ | 'EFTC'
1989
+ | 'EFTD'
1990
+ | 'MOMA'
1991
+ | 'RAPI'
1992
+ | 'GAMB'
1993
+ | 'LOTT'
1994
+ | 'AMEX'
1995
+ | 'SASW'
1996
+ | 'AUCO'
1997
+ | 'PCOM'
1998
+ | 'PDEP'
1999
+ | 'PLDS'
2000
+ | 'PLRF'
2001
+ | 'GAFA'
2002
+ | 'GAHO'
2003
+ | 'CPEN'
2004
+ | 'DEPD'
2005
+ | 'RETL'
2006
+ | 'DEBT'
2007
+ | 'CAP'
2008
+ | 'GDS'
2009
+ | 'SRV'
2010
+ | 'CAC'
2011
+ | 'FTF'
2012
+ | (string & {})
2013
+ | null;
2014
+
647
2015
  /**
648
2016
  * Payment scheme or blockchain used for the payout, or null when unknown.
649
2017
  */
@@ -828,6 +2196,348 @@ export namespace PayoutReturnedWebhookEvent {
828
2196
  */
829
2197
  metadata: { [key: string]: string };
830
2198
 
2199
+ /**
2200
+ * Purpose of the payout. Use an ISO 20022 external purpose code unless the
2201
+ * beneficiary bank country requires a national code. Only supported on fedwire and
2202
+ * swift payouts.
2203
+ */
2204
+ purpose_code:
2205
+ | 'BKDF'
2206
+ | 'BKFE'
2207
+ | 'BKFM'
2208
+ | 'BKIP'
2209
+ | 'BKPP'
2210
+ | 'CBLK'
2211
+ | 'CDCB'
2212
+ | 'CDCD'
2213
+ | 'CDCS'
2214
+ | 'CDDP'
2215
+ | 'CDOC'
2216
+ | 'CDQC'
2217
+ | 'ETUP'
2218
+ | 'FCOL'
2219
+ | 'MTUP'
2220
+ | 'ACCT'
2221
+ | 'CASH'
2222
+ | 'COLL'
2223
+ | 'CSDB'
2224
+ | 'DEPT'
2225
+ | 'INTC'
2226
+ | 'INTP'
2227
+ | 'LIMA'
2228
+ | 'NETT'
2229
+ | 'BFWD'
2230
+ | 'CCIR'
2231
+ | 'CCPC'
2232
+ | 'CCPM'
2233
+ | 'CCSM'
2234
+ | 'CRDS'
2235
+ | 'CRPR'
2236
+ | 'CRSP'
2237
+ | 'CRTL'
2238
+ | 'EQPT'
2239
+ | 'EQUS'
2240
+ | 'EXPT'
2241
+ | 'EXTD'
2242
+ | 'FIXI'
2243
+ | 'FWBC'
2244
+ | 'FWCC'
2245
+ | 'FWSB'
2246
+ | 'FWSC'
2247
+ | 'MARG'
2248
+ | 'MBSB'
2249
+ | 'MBSC'
2250
+ | 'MGCC'
2251
+ | 'MGSC'
2252
+ | 'OCCC'
2253
+ | 'OPBC'
2254
+ | 'OPCC'
2255
+ | 'OPSB'
2256
+ | 'OPSC'
2257
+ | 'OPTN'
2258
+ | 'OTCD'
2259
+ | 'REPO'
2260
+ | 'RPBC'
2261
+ | 'RPCC'
2262
+ | 'RPSB'
2263
+ | 'RPSC'
2264
+ | 'RVPO'
2265
+ | 'SBSC'
2266
+ | 'SCIE'
2267
+ | 'SCIR'
2268
+ | 'SCRP'
2269
+ | 'SHBC'
2270
+ | 'SHCC'
2271
+ | 'SHSL'
2272
+ | 'SLEB'
2273
+ | 'SLOA'
2274
+ | 'SWBC'
2275
+ | 'SWCC'
2276
+ | 'SWPT'
2277
+ | 'SWSB'
2278
+ | 'SWSC'
2279
+ | 'TBAS'
2280
+ | 'TBBC'
2281
+ | 'TBCC'
2282
+ | 'TRCP'
2283
+ | 'AGRT'
2284
+ | 'AREN'
2285
+ | 'BEXP'
2286
+ | 'BOCE'
2287
+ | 'COMC'
2288
+ | 'CPYR'
2289
+ | 'GDDS'
2290
+ | 'GDSV'
2291
+ | 'GSCB'
2292
+ | 'LICF'
2293
+ | 'MP2B'
2294
+ | 'POPE'
2295
+ | 'ROYA'
2296
+ | 'SCVE'
2297
+ | 'SERV'
2298
+ | 'SUBS'
2299
+ | 'SUPP'
2300
+ | 'TRAD'
2301
+ | 'CHAR'
2302
+ | 'COMT'
2303
+ | 'MP2P'
2304
+ | 'ECPG'
2305
+ | 'ECPR'
2306
+ | 'ECPU'
2307
+ | 'EPAY'
2308
+ | 'CLPR'
2309
+ | 'COMP'
2310
+ | 'DBTC'
2311
+ | 'GOVI'
2312
+ | 'HLRP'
2313
+ | 'HLST'
2314
+ | 'INPC'
2315
+ | 'INPR'
2316
+ | 'INSC'
2317
+ | 'INSU'
2318
+ | 'INTE'
2319
+ | 'LBRI'
2320
+ | 'LIFI'
2321
+ | 'LOAN'
2322
+ | 'LOAR'
2323
+ | 'PENO'
2324
+ | 'PPTI'
2325
+ | 'RELG'
2326
+ | 'RINP'
2327
+ | 'TRFD'
2328
+ | 'FORW'
2329
+ | 'FXNT'
2330
+ | 'ADMG'
2331
+ | 'ADVA'
2332
+ | 'BCDM'
2333
+ | 'BCFG'
2334
+ | 'BLDM'
2335
+ | 'BNET'
2336
+ | 'CBFF'
2337
+ | 'CBFR'
2338
+ | 'CCRD'
2339
+ | 'CDBL'
2340
+ | 'CFEE'
2341
+ | 'CGDD'
2342
+ | 'CORT'
2343
+ | 'COST'
2344
+ | 'CPKC'
2345
+ | 'DCRD'
2346
+ | 'DSMT'
2347
+ | 'DVPM'
2348
+ | 'EDUC'
2349
+ | 'FACT'
2350
+ | 'FAND'
2351
+ | 'FCPM'
2352
+ | 'FEES'
2353
+ | 'GIFT'
2354
+ | 'GOVT'
2355
+ | 'ICCP'
2356
+ | 'IDCP'
2357
+ | 'IHRP'
2358
+ | 'INSM'
2359
+ | 'IVPT'
2360
+ | 'MCDM'
2361
+ | 'MCFG'
2362
+ | 'MSVC'
2363
+ | 'NOWS'
2364
+ | 'OCDM'
2365
+ | 'OCFG'
2366
+ | 'OFEE'
2367
+ | 'OTHR'
2368
+ | 'PADD'
2369
+ | 'PTSP'
2370
+ | 'RCKE'
2371
+ | 'RCPT'
2372
+ | 'REBT'
2373
+ | 'REFU'
2374
+ | 'RENT'
2375
+ | 'REOD'
2376
+ | 'RIMB'
2377
+ | 'RPNT'
2378
+ | 'RRBN'
2379
+ | 'RRCT'
2380
+ | 'RRTP'
2381
+ | 'RVPM'
2382
+ | 'SLPI'
2383
+ | 'SPLT'
2384
+ | 'STDY'
2385
+ | 'TBAN'
2386
+ | 'TBIL'
2387
+ | 'TCSC'
2388
+ | 'TELI'
2389
+ | 'TMPG'
2390
+ | 'TPRI'
2391
+ | 'TPRP'
2392
+ | 'TRNC'
2393
+ | 'TRVC'
2394
+ | 'WEBI'
2395
+ | 'IPAY'
2396
+ | 'IPCA'
2397
+ | 'IPDO'
2398
+ | 'IPEA'
2399
+ | 'IPEC'
2400
+ | 'IPEW'
2401
+ | 'IPPS'
2402
+ | 'IPRT'
2403
+ | 'IPU2'
2404
+ | 'IPUW'
2405
+ | 'ANNI'
2406
+ | 'CAFI'
2407
+ | 'CFDI'
2408
+ | 'CMDT'
2409
+ | 'DERI'
2410
+ | 'DIVD'
2411
+ | 'FREX'
2412
+ | 'HEDG'
2413
+ | 'INVS'
2414
+ | 'PRME'
2415
+ | 'SAVG'
2416
+ | 'SECU'
2417
+ | 'SEPI'
2418
+ | 'TREA'
2419
+ | 'UNIT'
2420
+ | 'FNET'
2421
+ | 'FUTR'
2422
+ | 'ANTS'
2423
+ | 'CVCF'
2424
+ | 'DMEQ'
2425
+ | 'DNTS'
2426
+ | 'HLTC'
2427
+ | 'HLTI'
2428
+ | 'HSPC'
2429
+ | 'ICRF'
2430
+ | 'LTCF'
2431
+ | 'MAFC'
2432
+ | 'MARF'
2433
+ | 'MDCS'
2434
+ | 'VIEW'
2435
+ | 'CDEP'
2436
+ | 'SWFP'
2437
+ | 'SWPP'
2438
+ | 'SWRS'
2439
+ | 'SWUF'
2440
+ | 'ADCS'
2441
+ | 'AEMP'
2442
+ | 'ALLW'
2443
+ | 'ALMY'
2444
+ | 'BBSC'
2445
+ | 'BECH'
2446
+ | 'BENE'
2447
+ | 'BONU'
2448
+ | 'CCHD'
2449
+ | 'COMM'
2450
+ | 'CSLP'
2451
+ | 'GFRP'
2452
+ | 'GVEA'
2453
+ | 'GVEB'
2454
+ | 'GVEC'
2455
+ | 'GVED'
2456
+ | 'GWLT'
2457
+ | 'HREC'
2458
+ | 'PAYR'
2459
+ | 'PEFC'
2460
+ | 'PENS'
2461
+ | 'PRCP'
2462
+ | 'RHBS'
2463
+ | 'SALA'
2464
+ | 'SPSP'
2465
+ | 'SSBE'
2466
+ | 'LBIN'
2467
+ | 'LCOL'
2468
+ | 'LFEE'
2469
+ | 'LMEQ'
2470
+ | 'LMFI'
2471
+ | 'LMRK'
2472
+ | 'LREB'
2473
+ | 'LREV'
2474
+ | 'LSFL'
2475
+ | 'ESTX'
2476
+ | 'FWLV'
2477
+ | 'GSTX'
2478
+ | 'HSTX'
2479
+ | 'INTX'
2480
+ | 'NITX'
2481
+ | 'PTXP'
2482
+ | 'RDTX'
2483
+ | 'TAXS'
2484
+ | 'VATX'
2485
+ | 'WHLD'
2486
+ | 'TAXR'
2487
+ | 'B112'
2488
+ | 'BR12'
2489
+ | 'TLRF'
2490
+ | 'TLRR'
2491
+ | 'AIRB'
2492
+ | 'BUSB'
2493
+ | 'FERB'
2494
+ | 'RLWY'
2495
+ | 'TRPT'
2496
+ | 'CBTV'
2497
+ | 'ELEC'
2498
+ | 'ENRG'
2499
+ | 'GASB'
2500
+ | 'NWCH'
2501
+ | 'NWCM'
2502
+ | 'OTLC'
2503
+ | 'PHON'
2504
+ | 'UBIL'
2505
+ | 'WTER'
2506
+ | 'BOND'
2507
+ | 'CABD'
2508
+ | 'CAEQ'
2509
+ | 'CBCR'
2510
+ | 'DBCR'
2511
+ | 'DICL'
2512
+ | 'EQTS'
2513
+ | 'FLCR'
2514
+ | 'EFTC'
2515
+ | 'EFTD'
2516
+ | 'MOMA'
2517
+ | 'RAPI'
2518
+ | 'GAMB'
2519
+ | 'LOTT'
2520
+ | 'AMEX'
2521
+ | 'SASW'
2522
+ | 'AUCO'
2523
+ | 'PCOM'
2524
+ | 'PDEP'
2525
+ | 'PLDS'
2526
+ | 'PLRF'
2527
+ | 'GAFA'
2528
+ | 'GAHO'
2529
+ | 'CPEN'
2530
+ | 'DEPD'
2531
+ | 'RETL'
2532
+ | 'DEBT'
2533
+ | 'CAP'
2534
+ | 'GDS'
2535
+ | 'SRV'
2536
+ | 'CAC'
2537
+ | 'FTF'
2538
+ | (string & {})
2539
+ | null;
2540
+
831
2541
  /**
832
2542
  * Payment scheme or blockchain used for the payout, or null when unknown.
833
2543
  */
@@ -10036,9 +11746,9 @@ export namespace CounterpartyPendingWebhookEvent {
10036
11746
  email: string | null;
10037
11747
 
10038
11748
  /**
10039
- * Whether the counterparty is a business or an individual.
11749
+ * Classification of the counterparty.
10040
11750
  */
10041
- entity_type: 'business' | 'individual';
11751
+ entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
10042
11752
 
10043
11753
  /**
10044
11754
  * Financial address of the counterparty.
@@ -10569,9 +12279,9 @@ export namespace CounterpartyActiveWebhookEvent {
10569
12279
  email: string | null;
10570
12280
 
10571
12281
  /**
10572
- * Whether the counterparty is a business or an individual.
12282
+ * Classification of the counterparty.
10573
12283
  */
10574
- entity_type: 'business' | 'individual';
12284
+ entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
10575
12285
 
10576
12286
  /**
10577
12287
  * Financial address of the counterparty.
@@ -11102,9 +12812,9 @@ export namespace CounterpartyRejectedWebhookEvent {
11102
12812
  email: string | null;
11103
12813
 
11104
12814
  /**
11105
- * Whether the counterparty is a business or an individual.
12815
+ * Classification of the counterparty.
11106
12816
  */
11107
- entity_type: 'business' | 'individual';
12817
+ entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
11108
12818
 
11109
12819
  /**
11110
12820
  * Financial address of the counterparty.
@@ -11635,9 +13345,9 @@ export namespace CounterpartyBlockedWebhookEvent {
11635
13345
  email: string | null;
11636
13346
 
11637
13347
  /**
11638
- * Whether the counterparty is a business or an individual.
13348
+ * Classification of the counterparty.
11639
13349
  */
11640
- entity_type: 'business' | 'individual';
13350
+ entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
11641
13351
 
11642
13352
  /**
11643
13353
  * Financial address of the counterparty.
@@ -12168,9 +13878,9 @@ export namespace CounterpartyUnblockedWebhookEvent {
12168
13878
  email: string | null;
12169
13879
 
12170
13880
  /**
12171
- * Whether the counterparty is a business or an individual.
13881
+ * Classification of the counterparty.
12172
13882
  */
12173
- entity_type: 'business' | 'individual';
13883
+ entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
12174
13884
 
12175
13885
  /**
12176
13886
  * Financial address of the counterparty.
@@ -12701,9 +14411,9 @@ export namespace CounterpartyUpdatedWebhookEvent {
12701
14411
  email: string | null;
12702
14412
 
12703
14413
  /**
12704
- * Whether the counterparty is a business or an individual.
14414
+ * Classification of the counterparty.
12705
14415
  */
12706
- entity_type: 'business' | 'individual';
14416
+ entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
12707
14417
 
12708
14418
  /**
12709
14419
  * Financial address of the counterparty.
@@ -13181,6 +14891,233 @@ export namespace CounterpartyUpdatedWebhookEvent {
13181
14891
  }
13182
14892
  }
13183
14893
 
14894
+ export interface PayoutTrackingEventCreatedWebhookEvent {
14895
+ /**
14896
+ * Unique identifier for the event. Stable across retries.
14897
+ */
14898
+ id: string;
14899
+
14900
+ /**
14901
+ * API version the payload was rendered at. Stable across retries and redeliveries.
14902
+ */
14903
+ api_version: string;
14904
+
14905
+ /**
14906
+ * ISO 8601 UTC timestamp when the event was created.
14907
+ */
14908
+ date: string;
14909
+
14910
+ /**
14911
+ * Full resource snapshot at the time of the event.
14912
+ */
14913
+ payload: PayoutTrackingEventCreatedWebhookEvent.Payload;
14914
+
14915
+ /**
14916
+ * Event type in resource.action format.
14917
+ */
14918
+ type: 'payout_tracking_event.created';
14919
+ }
14920
+
14921
+ export namespace PayoutTrackingEventCreatedWebhookEvent {
14922
+ /**
14923
+ * Full resource snapshot at the time of the event.
14924
+ */
14925
+ export interface Payload {
14926
+ /**
14927
+ * Unique identifier of the tracking event.
14928
+ */
14929
+ id: string;
14930
+
14931
+ /**
14932
+ * Amount credited to the beneficiary. Set only on a credited event, otherwise
14933
+ * null.
14934
+ */
14935
+ beneficiary_amount: Payload.BeneficiaryAmount | null;
14936
+
14937
+ /**
14938
+ * ISO 8601 UTC timestamp when Augustus recorded the event.
14939
+ */
14940
+ created_at: string;
14941
+
14942
+ /**
14943
+ * Fee deducted at this step. Null when none was reported.
14944
+ */
14945
+ fee: Payload.Fee | null;
14946
+
14947
+ /**
14948
+ * Institution that acted on or reported this step. Null when unknown.
14949
+ */
14950
+ institution: Payload.Institution | null;
14951
+
14952
+ /**
14953
+ * Whether Augustus considers delivery finished. A later event, such as returned,
14954
+ * can still follow.
14955
+ */
14956
+ is_terminal: boolean;
14957
+
14958
+ /**
14959
+ * Normalized point in the payout journey. New values may be added.
14960
+ */
14961
+ milestone:
14962
+ | 'initiated'
14963
+ | 'submitted'
14964
+ | 'sent'
14965
+ | 'failed'
14966
+ | 'returned'
14967
+ | 'accepted'
14968
+ | 'settled'
14969
+ | 'forwarded'
14970
+ | 'credited'
14971
+ | 'rejected'
14972
+ | 'returning'
14973
+ | 'visibility_lost'
14974
+ | 'other';
14975
+
14976
+ /**
14977
+ * Raw network status. Null when the step has none.
14978
+ */
14979
+ network_status: Payload.NetworkStatus | null;
14980
+
14981
+ /**
14982
+ * ISO 8601 UTC timestamp when the step happened. Null when the source has no
14983
+ * timestamp. Can be out of order with sequence.
14984
+ */
14985
+ occurred_at: string | null;
14986
+
14987
+ /**
14988
+ * ID of the payout this event belongs to.
14989
+ */
14990
+ payout_id: string;
14991
+
14992
+ /**
14993
+ * How far Augustus can follow the payout: end_to_end when the rail confirms the
14994
+ * beneficiary credit, network when it only confirms settlement. New values may be
14995
+ * added.
14996
+ */
14997
+ scope: 'network' | 'end_to_end';
14998
+
14999
+ /**
15000
+ * Gap-free counter per payout, in the order Augustus recorded the events. A gap
15001
+ * means you missed a recorded event, such as a dropped webhook. A sequence without
15002
+ * gaps does not mean every network step was observed.
15003
+ */
15004
+ sequence: number;
15005
+
15006
+ /**
15007
+ * Where Augustus learned this step: augustus for steps Augustus records itself,
15008
+ * swift_gpi for SWIFT gpi statuses, other for any other source. New values may be
15009
+ * added.
15010
+ */
15011
+ source: 'augustus' | 'swift_gpi' | 'other';
15012
+
15013
+ /**
15014
+ * Reason for the current state. Null when none applies.
15015
+ */
15016
+ status_reason: Payload.StatusReason | null;
15017
+
15018
+ /**
15019
+ * Resource type discriminator.
15020
+ */
15021
+ type: 'payout_tracking_event';
15022
+ }
15023
+
15024
+ export namespace Payload {
15025
+ /**
15026
+ * Amount credited to the beneficiary. Set only on a credited event, otherwise
15027
+ * null.
15028
+ */
15029
+ export interface BeneficiaryAmount {
15030
+ /**
15031
+ * Credited amount as a string decimal (e.g. "100.50").
15032
+ */
15033
+ amount: string;
15034
+
15035
+ /**
15036
+ * ISO 4217 currency code of the credited amount.
15037
+ */
15038
+ currency: string;
15039
+ }
15040
+
15041
+ /**
15042
+ * Fee deducted at this step. Null when none was reported.
15043
+ */
15044
+ export interface Fee {
15045
+ /**
15046
+ * Fee amount as a string decimal (e.g. "10.00").
15047
+ */
15048
+ amount: string;
15049
+
15050
+ /**
15051
+ * Who bears the charges under the payment charge agreement: debtor (OUR), creditor
15052
+ * (BEN), shared (SHA), or other for any other agreement. New values may be added.
15053
+ */
15054
+ borne_by: 'debtor' | 'creditor' | 'shared' | 'other';
15055
+
15056
+ /**
15057
+ * ISO 4217 currency code of the fee.
15058
+ */
15059
+ currency: string;
15060
+ }
15061
+
15062
+ /**
15063
+ * Institution that acted on or reported this step. Null when unknown.
15064
+ */
15065
+ export interface Institution {
15066
+ /**
15067
+ * Identifier of the institution, typed by scheme.
15068
+ */
15069
+ identifier: Institution.Identifier;
15070
+ }
15071
+
15072
+ export namespace Institution {
15073
+ /**
15074
+ * Identifier of the institution, typed by scheme.
15075
+ */
15076
+ export interface Identifier {
15077
+ /**
15078
+ * Identifier scheme. Only bic today.
15079
+ */
15080
+ type: 'bic';
15081
+
15082
+ /**
15083
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
15084
+ */
15085
+ value: string;
15086
+ }
15087
+ }
15088
+
15089
+ /**
15090
+ * Raw network status. Null when the step has none.
15091
+ */
15092
+ export interface NetworkStatus {
15093
+ /**
15094
+ * Status code reported by the network, such as ACSP, ACSC, ACCC or RJCT.
15095
+ */
15096
+ code: string;
15097
+
15098
+ /**
15099
+ * Reason code for the status, such as G000. Null when the network reports none.
15100
+ */
15101
+ reason_code: string | null;
15102
+ }
15103
+
15104
+ /**
15105
+ * Reason for the current state. Null when none applies.
15106
+ */
15107
+ export interface StatusReason {
15108
+ /**
15109
+ * Normalized reason code assigned by Augustus. New codes may be added.
15110
+ */
15111
+ code: string;
15112
+
15113
+ /**
15114
+ * Explanation of the reason code, written by Augustus.
15115
+ */
15116
+ description: string;
15117
+ }
15118
+ }
15119
+ }
15120
+
13184
15121
  export interface PingTestWebhookEvent {
13185
15122
  /**
13186
15123
  * Unique identifier for the event. Stable across retries.
@@ -13264,6 +15201,7 @@ export type UnwrapWebhookEvent =
13264
15201
  | CounterpartyBlockedWebhookEvent
13265
15202
  | CounterpartyUnblockedWebhookEvent
13266
15203
  | CounterpartyUpdatedWebhookEvent
15204
+ | PayoutTrackingEventCreatedWebhookEvent
13267
15205
  | PingTestWebhookEvent;
13268
15206
 
13269
15207
  export declare namespace Webhooks {
@@ -13290,6 +15228,7 @@ export declare namespace Webhooks {
13290
15228
  type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent,
13291
15229
  type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent,
13292
15230
  type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent,
15231
+ type PayoutTrackingEventCreatedWebhookEvent as PayoutTrackingEventCreatedWebhookEvent,
13293
15232
  type PingTestWebhookEvent as PingTestWebhookEvent,
13294
15233
  type UnwrapWebhookEvent as UnwrapWebhookEvent,
13295
15234
  };