@augustusbank/typescript-sdk 0.23.0 → 0.25.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 (122) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/client.d.mts +2 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +2 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/account-holders.d.mts +40 -0
  10. package/resources/account-holders.d.mts.map +1 -1
  11. package/resources/account-holders.d.ts +40 -0
  12. package/resources/account-holders.d.ts.map +1 -1
  13. package/resources/accounts.d.mts +58 -3
  14. package/resources/accounts.d.mts.map +1 -1
  15. package/resources/accounts.d.ts +58 -3
  16. package/resources/accounts.d.ts.map +1 -1
  17. package/resources/api-versions.d.mts +2 -0
  18. package/resources/api-versions.d.mts.map +1 -1
  19. package/resources/api-versions.d.ts +2 -0
  20. package/resources/api-versions.d.ts.map +1 -1
  21. package/resources/conversions.d.mts +12 -4
  22. package/resources/conversions.d.mts.map +1 -1
  23. package/resources/conversions.d.ts +12 -4
  24. package/resources/conversions.d.ts.map +1 -1
  25. package/resources/counterparties.d.mts +88 -0
  26. package/resources/counterparties.d.mts.map +1 -1
  27. package/resources/counterparties.d.ts +88 -0
  28. package/resources/counterparties.d.ts.map +1 -1
  29. package/resources/counterparties.js +40 -0
  30. package/resources/counterparties.js.map +1 -1
  31. package/resources/counterparties.mjs +40 -0
  32. package/resources/counterparties.mjs.map +1 -1
  33. package/resources/events.d.mts +3 -3
  34. package/resources/events.d.mts.map +1 -1
  35. package/resources/events.d.ts +3 -3
  36. package/resources/events.d.ts.map +1 -1
  37. package/resources/index.d.mts +1 -1
  38. package/resources/index.d.mts.map +1 -1
  39. package/resources/index.d.ts +1 -1
  40. package/resources/index.d.ts.map +1 -1
  41. package/resources/index.js.map +1 -1
  42. package/resources/index.mjs.map +1 -1
  43. package/resources/payouts.d.mts +12 -4
  44. package/resources/payouts.d.mts.map +1 -1
  45. package/resources/payouts.d.ts +12 -4
  46. package/resources/payouts.d.ts.map +1 -1
  47. package/resources/returns.d.mts +32 -0
  48. package/resources/returns.d.mts.map +1 -1
  49. package/resources/returns.d.ts +32 -0
  50. package/resources/returns.d.ts.map +1 -1
  51. package/resources/scopes.d.mts +2 -0
  52. package/resources/scopes.d.mts.map +1 -1
  53. package/resources/scopes.d.ts +2 -0
  54. package/resources/scopes.d.ts.map +1 -1
  55. package/resources/simulations/account-programs.d.mts +1 -1
  56. package/resources/simulations/account-programs.d.ts +1 -1
  57. package/resources/simulations/account-programs.js +1 -1
  58. package/resources/simulations/account-programs.mjs +1 -1
  59. package/resources/simulations/accounts.d.mts +1 -1
  60. package/resources/simulations/accounts.d.ts +1 -1
  61. package/resources/simulations/accounts.js +1 -1
  62. package/resources/simulations/accounts.mjs +1 -1
  63. package/resources/simulations/counterparties.d.mts +32 -0
  64. package/resources/simulations/counterparties.d.mts.map +1 -0
  65. package/resources/simulations/counterparties.d.ts +32 -0
  66. package/resources/simulations/counterparties.d.ts.map +1 -0
  67. package/resources/simulations/counterparties.js +25 -0
  68. package/resources/simulations/counterparties.js.map +1 -0
  69. package/resources/simulations/counterparties.mjs +21 -0
  70. package/resources/simulations/counterparties.mjs.map +1 -0
  71. package/resources/simulations/deposits.d.mts +1 -1
  72. package/resources/simulations/deposits.d.ts +1 -1
  73. package/resources/simulations/deposits.js +1 -1
  74. package/resources/simulations/deposits.mjs +1 -1
  75. package/resources/simulations/index.d.mts +1 -0
  76. package/resources/simulations/index.d.mts.map +1 -1
  77. package/resources/simulations/index.d.ts +1 -0
  78. package/resources/simulations/index.d.ts.map +1 -1
  79. package/resources/simulations/index.js +3 -1
  80. package/resources/simulations/index.js.map +1 -1
  81. package/resources/simulations/index.mjs +1 -0
  82. package/resources/simulations/index.mjs.map +1 -1
  83. package/resources/simulations/simulations.d.mts +4 -0
  84. package/resources/simulations/simulations.d.mts.map +1 -1
  85. package/resources/simulations/simulations.d.ts +4 -0
  86. package/resources/simulations/simulations.d.ts.map +1 -1
  87. package/resources/simulations/simulations.js +4 -0
  88. package/resources/simulations/simulations.js.map +1 -1
  89. package/resources/simulations/simulations.mjs +4 -0
  90. package/resources/simulations/simulations.mjs.map +1 -1
  91. package/resources/webhook-subscriptions.d.mts +56 -8
  92. package/resources/webhook-subscriptions.d.mts.map +1 -1
  93. package/resources/webhook-subscriptions.d.ts +56 -8
  94. package/resources/webhook-subscriptions.d.ts.map +1 -1
  95. package/resources/webhooks.d.mts +1258 -10
  96. package/resources/webhooks.d.mts.map +1 -1
  97. package/resources/webhooks.d.ts +1258 -10
  98. package/resources/webhooks.d.ts.map +1 -1
  99. package/src/client.ts +12 -0
  100. package/src/resources/account-holders.ts +35 -0
  101. package/src/resources/accounts.ts +51 -3
  102. package/src/resources/api-versions.ts +4 -0
  103. package/src/resources/conversions.ts +12 -4
  104. package/src/resources/counterparties.ts +82 -0
  105. package/src/resources/events.ts +18 -0
  106. package/src/resources/index.ts +6 -0
  107. package/src/resources/payouts.ts +12 -4
  108. package/src/resources/returns.ts +28 -0
  109. package/src/resources/scopes.ts +4 -0
  110. package/src/resources/simulations/account-programs.ts +1 -1
  111. package/src/resources/simulations/accounts.ts +1 -1
  112. package/src/resources/simulations/counterparties.ts +40 -0
  113. package/src/resources/simulations/deposits.ts +1 -1
  114. package/src/resources/simulations/index.ts +1 -0
  115. package/src/resources/simulations/simulations.ts +6 -0
  116. package/src/resources/webhook-subscriptions.ts +90 -0
  117. package/src/resources/webhooks.ts +3073 -8
  118. package/src/version.ts +1 -1
  119. package/version.d.mts +1 -1
  120. package/version.d.ts +1 -1
  121. package/version.js +1 -1
  122. package/version.mjs +1 -1
@@ -86,7 +86,9 @@ export namespace PayoutInitiatedWebhookEvent {
86
86
  initiated_at: string;
87
87
 
88
88
  /**
89
- * Key-value pairs stored with the payout.
89
+ * Set of up to 50 key-value string pairs you can attach to store structured
90
+ * information, such as correlating this resource with an object in your own
91
+ * system. Keys may be up to 40 characters and values up to 500 characters.
90
92
  */
91
93
  metadata: { [key: string]: string };
92
94
 
@@ -252,7 +254,9 @@ export namespace PayoutSubmittedWebhookEvent {
252
254
  initiated_at: string;
253
255
 
254
256
  /**
255
- * Key-value pairs stored with the payout.
257
+ * Set of up to 50 key-value string pairs you can attach to store structured
258
+ * information, such as correlating this resource with an object in your own
259
+ * system. Keys may be up to 40 characters and values up to 500 characters.
256
260
  */
257
261
  metadata: { [key: string]: string };
258
262
 
@@ -418,7 +422,9 @@ export namespace PayoutSentWebhookEvent {
418
422
  initiated_at: string;
419
423
 
420
424
  /**
421
- * Key-value pairs stored with the payout.
425
+ * Set of up to 50 key-value string pairs you can attach to store structured
426
+ * information, such as correlating this resource with an object in your own
427
+ * system. Keys may be up to 40 characters and values up to 500 characters.
422
428
  */
423
429
  metadata: { [key: string]: string };
424
430
 
@@ -584,7 +590,9 @@ export namespace PayoutFailedWebhookEvent {
584
590
  initiated_at: string;
585
591
 
586
592
  /**
587
- * Key-value pairs stored with the payout.
593
+ * Set of up to 50 key-value string pairs you can attach to store structured
594
+ * information, such as correlating this resource with an object in your own
595
+ * system. Keys may be up to 40 characters and values up to 500 characters.
588
596
  */
589
597
  metadata: { [key: string]: string };
590
598
 
@@ -750,7 +758,9 @@ export namespace PayoutReturnedWebhookEvent {
750
758
  initiated_at: string;
751
759
 
752
760
  /**
753
- * Key-value pairs stored with the payout.
761
+ * Set of up to 50 key-value string pairs you can attach to store structured
762
+ * information, such as correlating this resource with an object in your own
763
+ * system. Keys may be up to 40 characters and values up to 500 characters.
754
764
  */
755
765
  metadata: { [key: string]: string };
756
766
 
@@ -910,6 +920,13 @@ export namespace ReturnInitiatedWebhookEvent {
910
920
  */
911
921
  initiated_at: string;
912
922
 
923
+ /**
924
+ * Set of up to 50 key-value string pairs you can attach to store structured
925
+ * information, such as correlating this resource with an object in your own
926
+ * system. Keys may be up to 40 characters and values up to 500 characters.
927
+ */
928
+ metadata: { [key: string]: string };
929
+
913
930
  /**
914
931
  * Payment scheme or blockchain used for the return, or null when unknown.
915
932
  */
@@ -1054,6 +1071,13 @@ export namespace ReturnSubmittedWebhookEvent {
1054
1071
  */
1055
1072
  initiated_at: string;
1056
1073
 
1074
+ /**
1075
+ * Set of up to 50 key-value string pairs you can attach to store structured
1076
+ * information, such as correlating this resource with an object in your own
1077
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1078
+ */
1079
+ metadata: { [key: string]: string };
1080
+
1057
1081
  /**
1058
1082
  * Payment scheme or blockchain used for the return, or null when unknown.
1059
1083
  */
@@ -1198,6 +1222,13 @@ export namespace ReturnSentWebhookEvent {
1198
1222
  */
1199
1223
  initiated_at: string;
1200
1224
 
1225
+ /**
1226
+ * Set of up to 50 key-value string pairs you can attach to store structured
1227
+ * information, such as correlating this resource with an object in your own
1228
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1229
+ */
1230
+ metadata: { [key: string]: string };
1231
+
1201
1232
  /**
1202
1233
  * Payment scheme or blockchain used for the return, or null when unknown.
1203
1234
  */
@@ -1342,6 +1373,13 @@ export namespace ReturnFailedWebhookEvent {
1342
1373
  */
1343
1374
  initiated_at: string;
1344
1375
 
1376
+ /**
1377
+ * Set of up to 50 key-value string pairs you can attach to store structured
1378
+ * information, such as correlating this resource with an object in your own
1379
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1380
+ */
1381
+ metadata: { [key: string]: string };
1382
+
1345
1383
  /**
1346
1384
  * Payment scheme or blockchain used for the return, or null when unknown.
1347
1385
  */
@@ -1486,6 +1524,13 @@ export namespace ReturnReturnedWebhookEvent {
1486
1524
  */
1487
1525
  initiated_at: string;
1488
1526
 
1527
+ /**
1528
+ * Set of up to 50 key-value string pairs you can attach to store structured
1529
+ * information, such as correlating this resource with an object in your own
1530
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1531
+ */
1532
+ metadata: { [key: string]: string };
1533
+
1489
1534
  /**
1490
1535
  * Payment scheme or blockchain used for the return, or null when unknown.
1491
1536
  */
@@ -1735,7 +1780,9 @@ export namespace ConversionCreatedWebhookEvent {
1735
1780
  created_at: string;
1736
1781
 
1737
1782
  /**
1738
- * Key-value pairs stored with the conversion.
1783
+ * Set of up to 50 key-value string pairs you can attach to store structured
1784
+ * information, such as correlating this resource with an object in your own
1785
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1739
1786
  */
1740
1787
  metadata: { [key: string]: string };
1741
1788
 
@@ -1824,7 +1871,9 @@ export namespace ConversionCompletedWebhookEvent {
1824
1871
  created_at: string;
1825
1872
 
1826
1873
  /**
1827
- * Key-value pairs stored with the conversion.
1874
+ * Set of up to 50 key-value string pairs you can attach to store structured
1875
+ * information, such as correlating this resource with an object in your own
1876
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1828
1877
  */
1829
1878
  metadata: { [key: string]: string };
1830
1879
 
@@ -1913,7 +1962,9 @@ export namespace ConversionFailedWebhookEvent {
1913
1962
  created_at: string;
1914
1963
 
1915
1964
  /**
1916
- * Key-value pairs stored with the conversion.
1965
+ * Set of up to 50 key-value string pairs you can attach to store structured
1966
+ * information, such as correlating this resource with an object in your own
1967
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1917
1968
  */
1918
1969
  metadata: { [key: string]: string };
1919
1970
 
@@ -2012,6 +2063,13 @@ export namespace AccountHolderActiveWebhookEvent {
2012
2063
  */
2013
2064
  holder_type: 'natural_person' | 'business';
2014
2065
 
2066
+ /**
2067
+ * Set of up to 50 key-value string pairs you can attach to store structured
2068
+ * information, such as correlating this resource with an object in your own
2069
+ * system. Keys may be up to 40 characters and values up to 500 characters.
2070
+ */
2071
+ metadata: { [key: string]: string };
2072
+
2015
2073
  /**
2016
2074
  * Current account holder status.
2017
2075
  */
@@ -5945,6 +6003,13 @@ export namespace AccountHolderClosedWebhookEvent {
5945
6003
  */
5946
6004
  holder_type: 'natural_person' | 'business';
5947
6005
 
6006
+ /**
6007
+ * Set of up to 50 key-value string pairs you can attach to store structured
6008
+ * information, such as correlating this resource with an object in your own
6009
+ * system. Keys may be up to 40 characters and values up to 500 characters.
6010
+ */
6011
+ metadata: { [key: string]: string };
6012
+
5948
6013
  /**
5949
6014
  * Current account holder status.
5950
6015
  */
@@ -9820,6 +9885,2994 @@ export namespace AccountHolderClosedWebhookEvent {
9820
9885
  }
9821
9886
  }
9822
9887
 
9888
+ export interface CounterpartyCreatedWebhookEvent {
9889
+ /**
9890
+ * Unique identifier for the event. Stable across retries.
9891
+ */
9892
+ id: string;
9893
+
9894
+ /**
9895
+ * API version the payload was rendered at. Stable across retries and redeliveries.
9896
+ */
9897
+ api_version: string;
9898
+
9899
+ /**
9900
+ * ISO 8601 UTC timestamp when the event was created.
9901
+ */
9902
+ date: string;
9903
+
9904
+ /**
9905
+ * Full resource snapshot at the time of the event.
9906
+ */
9907
+ payload: CounterpartyCreatedWebhookEvent.Payload;
9908
+
9909
+ /**
9910
+ * Event type in resource.action format.
9911
+ */
9912
+ type: 'counterparty.created';
9913
+ }
9914
+
9915
+ export namespace CounterpartyCreatedWebhookEvent {
9916
+ /**
9917
+ * Full resource snapshot at the time of the event.
9918
+ */
9919
+ export interface Payload {
9920
+ /**
9921
+ * Unique identifier of the counterparty.
9922
+ */
9923
+ id: string;
9924
+
9925
+ /**
9926
+ * Whether payments to or from this counterparty are currently blocked.
9927
+ */
9928
+ blocked: boolean;
9929
+
9930
+ /**
9931
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
9932
+ */
9933
+ date_of_birth: string | null;
9934
+
9935
+ /**
9936
+ * Whether the counterparty is a business or an individual.
9937
+ */
9938
+ entity_type: 'business' | 'individual';
9939
+
9940
+ /**
9941
+ * Financial address of the counterparty.
9942
+ */
9943
+ financial_address:
9944
+ | Payload.IbanFinancialAddress
9945
+ | Payload.SortCodeFinancialAddress
9946
+ | Payload.AbaFinancialAddress
9947
+ | Payload.BicFinancialAddress
9948
+ | Payload.CryptoWalletFinancialAddress;
9949
+
9950
+ /**
9951
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
9952
+ * by you, `true` if it is.
9953
+ */
9954
+ is_self_owned: boolean;
9955
+
9956
+ /**
9957
+ * Set of up to 50 key-value string pairs you can attach to store structured
9958
+ * information, such as correlating this resource with an object in your own
9959
+ * system. Keys may be up to 40 characters and values up to 500 characters.
9960
+ */
9961
+ metadata: { [key: string]: string };
9962
+
9963
+ /**
9964
+ * Name of the counterparty, or null if not recorded.
9965
+ */
9966
+ name: string | null;
9967
+
9968
+ /**
9969
+ * Physical address of the counterparty, or null if not recorded.
9970
+ */
9971
+ physical_address: Payload.PhysicalAddress | null;
9972
+
9973
+ /**
9974
+ * Resource type discriminator.
9975
+ */
9976
+ type: 'counterparty';
9977
+ }
9978
+
9979
+ export namespace Payload {
9980
+ export interface IbanFinancialAddress {
9981
+ /**
9982
+ * Name of the account holder.
9983
+ */
9984
+ account_holder_name: string;
9985
+
9986
+ /**
9987
+ * Bank Identifier Code, or null if not provided.
9988
+ */
9989
+ bic: string | null;
9990
+
9991
+ /**
9992
+ * International Bank Account Number.
9993
+ */
9994
+ iban: string;
9995
+
9996
+ /**
9997
+ * Discriminator for IBAN financial address.
9998
+ */
9999
+ type: 'iban';
10000
+ }
10001
+
10002
+ export interface SortCodeFinancialAddress {
10003
+ /**
10004
+ * Name of the account holder.
10005
+ */
10006
+ account_holder_name: string;
10007
+
10008
+ /**
10009
+ * UK account number (8 digits).
10010
+ */
10011
+ account_number: string;
10012
+
10013
+ /**
10014
+ * UK sort code (6 digits).
10015
+ */
10016
+ sort_code: string;
10017
+
10018
+ /**
10019
+ * Discriminator for UK sort code financial address.
10020
+ */
10021
+ type: 'sort_code';
10022
+ }
10023
+
10024
+ export interface AbaFinancialAddress {
10025
+ /**
10026
+ * Name of the account holder.
10027
+ */
10028
+ account_holder_name: string;
10029
+
10030
+ /**
10031
+ * Bank account number.
10032
+ */
10033
+ account_number: string;
10034
+
10035
+ /**
10036
+ * ABA routing number (9 digits).
10037
+ */
10038
+ routing_number: string;
10039
+
10040
+ /**
10041
+ * Discriminator for ABA wire financial address.
10042
+ */
10043
+ type: 'aba';
10044
+ }
10045
+
10046
+ export interface BicFinancialAddress {
10047
+ /**
10048
+ * Name of the account holder.
10049
+ */
10050
+ account_holder_name: string;
10051
+
10052
+ /**
10053
+ * Local-format bank account number.
10054
+ */
10055
+ account_number: string;
10056
+
10057
+ /**
10058
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
10059
+ */
10060
+ bic: string;
10061
+
10062
+ /**
10063
+ * Domestic bank or branch code where the destination country uses one (for example
10064
+ * the BSB in Australia), or null.
10065
+ */
10066
+ local_bank_code: string | null;
10067
+
10068
+ /**
10069
+ * Discriminator for BIC + local account financial address.
10070
+ */
10071
+ type: 'bic';
10072
+ }
10073
+
10074
+ export interface CryptoWalletFinancialAddress {
10075
+ /**
10076
+ * Wallet address on the specified blockchain.
10077
+ */
10078
+ address: string;
10079
+
10080
+ /**
10081
+ * Blockchain network for the crypto wallet.
10082
+ */
10083
+ blockchain:
10084
+ | 'bitcoin'
10085
+ | 'ethereum'
10086
+ | 'solana'
10087
+ | 'polygon'
10088
+ | 'bitcoin_testnet4'
10089
+ | 'ethereum_sepolia'
10090
+ | 'solana_devnet'
10091
+ | 'polygon_amoy';
10092
+
10093
+ /**
10094
+ * Discriminator for crypto wallet financial address.
10095
+ */
10096
+ type: 'crypto_wallet';
10097
+ }
10098
+
10099
+ /**
10100
+ * Physical address of the counterparty, or null if not recorded.
10101
+ */
10102
+ export interface PhysicalAddress {
10103
+ /**
10104
+ * City or locality.
10105
+ */
10106
+ city: string;
10107
+
10108
+ /**
10109
+ * ISO 3166-1 alpha-2 country code.
10110
+ */
10111
+ country_code:
10112
+ | 'AF'
10113
+ | 'AL'
10114
+ | 'DZ'
10115
+ | 'AS'
10116
+ | 'AD'
10117
+ | 'AO'
10118
+ | 'AI'
10119
+ | 'AQ'
10120
+ | 'AG'
10121
+ | 'AR'
10122
+ | 'AM'
10123
+ | 'AW'
10124
+ | 'AU'
10125
+ | 'AT'
10126
+ | 'AZ'
10127
+ | 'BS'
10128
+ | 'BH'
10129
+ | 'BD'
10130
+ | 'BB'
10131
+ | 'BY'
10132
+ | 'BE'
10133
+ | 'BZ'
10134
+ | 'BJ'
10135
+ | 'BM'
10136
+ | 'BT'
10137
+ | 'BO'
10138
+ | 'BA'
10139
+ | 'BW'
10140
+ | 'BV'
10141
+ | 'BR'
10142
+ | 'IO'
10143
+ | 'BN'
10144
+ | 'BG'
10145
+ | 'BF'
10146
+ | 'BI'
10147
+ | 'KH'
10148
+ | 'CM'
10149
+ | 'CA'
10150
+ | 'CV'
10151
+ | 'KY'
10152
+ | 'CF'
10153
+ | 'TD'
10154
+ | 'CL'
10155
+ | 'CN'
10156
+ | 'CX'
10157
+ | 'CC'
10158
+ | 'CO'
10159
+ | 'KM'
10160
+ | 'CG'
10161
+ | 'CD'
10162
+ | 'CK'
10163
+ | 'CR'
10164
+ | 'CI'
10165
+ | 'HR'
10166
+ | 'CU'
10167
+ | 'CY'
10168
+ | 'CZ'
10169
+ | 'DK'
10170
+ | 'DJ'
10171
+ | 'DM'
10172
+ | 'DO'
10173
+ | 'EC'
10174
+ | 'EG'
10175
+ | 'SV'
10176
+ | 'GQ'
10177
+ | 'ER'
10178
+ | 'EE'
10179
+ | 'ET'
10180
+ | 'FK'
10181
+ | 'FO'
10182
+ | 'FJ'
10183
+ | 'FI'
10184
+ | 'FR'
10185
+ | 'GF'
10186
+ | 'PF'
10187
+ | 'TF'
10188
+ | 'GA'
10189
+ | 'GM'
10190
+ | 'GE'
10191
+ | 'DE'
10192
+ | 'GH'
10193
+ | 'GI'
10194
+ | 'GR'
10195
+ | 'GL'
10196
+ | 'GD'
10197
+ | 'GP'
10198
+ | 'GU'
10199
+ | 'GT'
10200
+ | 'GN'
10201
+ | 'GW'
10202
+ | 'GY'
10203
+ | 'HT'
10204
+ | 'HM'
10205
+ | 'VA'
10206
+ | 'HN'
10207
+ | 'HK'
10208
+ | 'HU'
10209
+ | 'IS'
10210
+ | 'IN'
10211
+ | 'ID'
10212
+ | 'IR'
10213
+ | 'IQ'
10214
+ | 'IE'
10215
+ | 'IL'
10216
+ | 'IT'
10217
+ | 'JM'
10218
+ | 'JP'
10219
+ | 'JO'
10220
+ | 'KZ'
10221
+ | 'KE'
10222
+ | 'KI'
10223
+ | 'KP'
10224
+ | 'KR'
10225
+ | 'KW'
10226
+ | 'KG'
10227
+ | 'LA'
10228
+ | 'LV'
10229
+ | 'LB'
10230
+ | 'LS'
10231
+ | 'LR'
10232
+ | 'LY'
10233
+ | 'LI'
10234
+ | 'LT'
10235
+ | 'LU'
10236
+ | 'MO'
10237
+ | 'MG'
10238
+ | 'MW'
10239
+ | 'MY'
10240
+ | 'MV'
10241
+ | 'ML'
10242
+ | 'MT'
10243
+ | 'MH'
10244
+ | 'MQ'
10245
+ | 'MR'
10246
+ | 'MU'
10247
+ | 'YT'
10248
+ | 'MX'
10249
+ | 'FM'
10250
+ | 'MD'
10251
+ | 'MC'
10252
+ | 'MN'
10253
+ | 'MS'
10254
+ | 'MA'
10255
+ | 'MZ'
10256
+ | 'MM'
10257
+ | 'NA'
10258
+ | 'NR'
10259
+ | 'NP'
10260
+ | 'NL'
10261
+ | 'NC'
10262
+ | 'NZ'
10263
+ | 'NI'
10264
+ | 'NE'
10265
+ | 'NG'
10266
+ | 'NU'
10267
+ | 'NF'
10268
+ | 'MP'
10269
+ | 'MK'
10270
+ | 'NO'
10271
+ | 'OM'
10272
+ | 'PK'
10273
+ | 'PW'
10274
+ | 'PS'
10275
+ | 'PA'
10276
+ | 'PG'
10277
+ | 'PY'
10278
+ | 'PE'
10279
+ | 'PH'
10280
+ | 'PN'
10281
+ | 'PL'
10282
+ | 'PT'
10283
+ | 'PR'
10284
+ | 'QA'
10285
+ | 'RE'
10286
+ | 'RO'
10287
+ | 'RU'
10288
+ | 'RW'
10289
+ | 'SH'
10290
+ | 'KN'
10291
+ | 'LC'
10292
+ | 'PM'
10293
+ | 'VC'
10294
+ | 'WS'
10295
+ | 'SM'
10296
+ | 'ST'
10297
+ | 'SA'
10298
+ | 'SN'
10299
+ | 'SC'
10300
+ | 'SL'
10301
+ | 'SG'
10302
+ | 'SK'
10303
+ | 'SI'
10304
+ | 'SB'
10305
+ | 'SO'
10306
+ | 'ZA'
10307
+ | 'GS'
10308
+ | 'ES'
10309
+ | 'LK'
10310
+ | 'SD'
10311
+ | 'SR'
10312
+ | 'SJ'
10313
+ | 'SZ'
10314
+ | 'SE'
10315
+ | 'CH'
10316
+ | 'SY'
10317
+ | 'TW'
10318
+ | 'TJ'
10319
+ | 'TZ'
10320
+ | 'TH'
10321
+ | 'TL'
10322
+ | 'TG'
10323
+ | 'TK'
10324
+ | 'TO'
10325
+ | 'TT'
10326
+ | 'TN'
10327
+ | 'TR'
10328
+ | 'TM'
10329
+ | 'TC'
10330
+ | 'TV'
10331
+ | 'UG'
10332
+ | 'UA'
10333
+ | 'AE'
10334
+ | 'GB'
10335
+ | 'US'
10336
+ | 'UM'
10337
+ | 'UY'
10338
+ | 'UZ'
10339
+ | 'VU'
10340
+ | 'VE'
10341
+ | 'VN'
10342
+ | 'VG'
10343
+ | 'VI'
10344
+ | 'WF'
10345
+ | 'EH'
10346
+ | 'YE'
10347
+ | 'ZM'
10348
+ | 'ZW'
10349
+ | 'AX'
10350
+ | 'BQ'
10351
+ | 'CW'
10352
+ | 'GG'
10353
+ | 'IM'
10354
+ | 'JE'
10355
+ | 'ME'
10356
+ | 'BL'
10357
+ | 'MF'
10358
+ | 'RS'
10359
+ | 'SX'
10360
+ | 'SS'
10361
+ | 'XK';
10362
+
10363
+ /**
10364
+ * Primary street address, or null if not recorded.
10365
+ */
10366
+ line_1: string | null;
10367
+
10368
+ /**
10369
+ * Secondary street address, or null if not recorded.
10370
+ */
10371
+ line_2: string | null;
10372
+
10373
+ /**
10374
+ * Postal or ZIP code, or null if not recorded.
10375
+ */
10376
+ postal_code: string | null;
10377
+
10378
+ /**
10379
+ * State, province, or region, or null if not recorded.
10380
+ */
10381
+ state: string | null;
10382
+ }
10383
+ }
10384
+ }
10385
+
10386
+ export interface CounterpartyVerifiedWebhookEvent {
10387
+ /**
10388
+ * Unique identifier for the event. Stable across retries.
10389
+ */
10390
+ id: string;
10391
+
10392
+ /**
10393
+ * API version the payload was rendered at. Stable across retries and redeliveries.
10394
+ */
10395
+ api_version: string;
10396
+
10397
+ /**
10398
+ * ISO 8601 UTC timestamp when the event was created.
10399
+ */
10400
+ date: string;
10401
+
10402
+ /**
10403
+ * Full resource snapshot at the time of the event.
10404
+ */
10405
+ payload: CounterpartyVerifiedWebhookEvent.Payload;
10406
+
10407
+ /**
10408
+ * Event type in resource.action format.
10409
+ */
10410
+ type: 'counterparty.verified';
10411
+ }
10412
+
10413
+ export namespace CounterpartyVerifiedWebhookEvent {
10414
+ /**
10415
+ * Full resource snapshot at the time of the event.
10416
+ */
10417
+ export interface Payload {
10418
+ /**
10419
+ * Unique identifier of the counterparty.
10420
+ */
10421
+ id: string;
10422
+
10423
+ /**
10424
+ * Whether payments to or from this counterparty are currently blocked.
10425
+ */
10426
+ blocked: boolean;
10427
+
10428
+ /**
10429
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
10430
+ */
10431
+ date_of_birth: string | null;
10432
+
10433
+ /**
10434
+ * Whether the counterparty is a business or an individual.
10435
+ */
10436
+ entity_type: 'business' | 'individual';
10437
+
10438
+ /**
10439
+ * Financial address of the counterparty.
10440
+ */
10441
+ financial_address:
10442
+ | Payload.IbanFinancialAddress
10443
+ | Payload.SortCodeFinancialAddress
10444
+ | Payload.AbaFinancialAddress
10445
+ | Payload.BicFinancialAddress
10446
+ | Payload.CryptoWalletFinancialAddress;
10447
+
10448
+ /**
10449
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
10450
+ * by you, `true` if it is.
10451
+ */
10452
+ is_self_owned: boolean;
10453
+
10454
+ /**
10455
+ * Set of up to 50 key-value string pairs you can attach to store structured
10456
+ * information, such as correlating this resource with an object in your own
10457
+ * system. Keys may be up to 40 characters and values up to 500 characters.
10458
+ */
10459
+ metadata: { [key: string]: string };
10460
+
10461
+ /**
10462
+ * Name of the counterparty, or null if not recorded.
10463
+ */
10464
+ name: string | null;
10465
+
10466
+ /**
10467
+ * Physical address of the counterparty, or null if not recorded.
10468
+ */
10469
+ physical_address: Payload.PhysicalAddress | null;
10470
+
10471
+ /**
10472
+ * Resource type discriminator.
10473
+ */
10474
+ type: 'counterparty';
10475
+ }
10476
+
10477
+ export namespace Payload {
10478
+ export interface IbanFinancialAddress {
10479
+ /**
10480
+ * Name of the account holder.
10481
+ */
10482
+ account_holder_name: string;
10483
+
10484
+ /**
10485
+ * Bank Identifier Code, or null if not provided.
10486
+ */
10487
+ bic: string | null;
10488
+
10489
+ /**
10490
+ * International Bank Account Number.
10491
+ */
10492
+ iban: string;
10493
+
10494
+ /**
10495
+ * Discriminator for IBAN financial address.
10496
+ */
10497
+ type: 'iban';
10498
+ }
10499
+
10500
+ export interface SortCodeFinancialAddress {
10501
+ /**
10502
+ * Name of the account holder.
10503
+ */
10504
+ account_holder_name: string;
10505
+
10506
+ /**
10507
+ * UK account number (8 digits).
10508
+ */
10509
+ account_number: string;
10510
+
10511
+ /**
10512
+ * UK sort code (6 digits).
10513
+ */
10514
+ sort_code: string;
10515
+
10516
+ /**
10517
+ * Discriminator for UK sort code financial address.
10518
+ */
10519
+ type: 'sort_code';
10520
+ }
10521
+
10522
+ export interface AbaFinancialAddress {
10523
+ /**
10524
+ * Name of the account holder.
10525
+ */
10526
+ account_holder_name: string;
10527
+
10528
+ /**
10529
+ * Bank account number.
10530
+ */
10531
+ account_number: string;
10532
+
10533
+ /**
10534
+ * ABA routing number (9 digits).
10535
+ */
10536
+ routing_number: string;
10537
+
10538
+ /**
10539
+ * Discriminator for ABA wire financial address.
10540
+ */
10541
+ type: 'aba';
10542
+ }
10543
+
10544
+ export interface BicFinancialAddress {
10545
+ /**
10546
+ * Name of the account holder.
10547
+ */
10548
+ account_holder_name: string;
10549
+
10550
+ /**
10551
+ * Local-format bank account number.
10552
+ */
10553
+ account_number: string;
10554
+
10555
+ /**
10556
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
10557
+ */
10558
+ bic: string;
10559
+
10560
+ /**
10561
+ * Domestic bank or branch code where the destination country uses one (for example
10562
+ * the BSB in Australia), or null.
10563
+ */
10564
+ local_bank_code: string | null;
10565
+
10566
+ /**
10567
+ * Discriminator for BIC + local account financial address.
10568
+ */
10569
+ type: 'bic';
10570
+ }
10571
+
10572
+ export interface CryptoWalletFinancialAddress {
10573
+ /**
10574
+ * Wallet address on the specified blockchain.
10575
+ */
10576
+ address: string;
10577
+
10578
+ /**
10579
+ * Blockchain network for the crypto wallet.
10580
+ */
10581
+ blockchain:
10582
+ | 'bitcoin'
10583
+ | 'ethereum'
10584
+ | 'solana'
10585
+ | 'polygon'
10586
+ | 'bitcoin_testnet4'
10587
+ | 'ethereum_sepolia'
10588
+ | 'solana_devnet'
10589
+ | 'polygon_amoy';
10590
+
10591
+ /**
10592
+ * Discriminator for crypto wallet financial address.
10593
+ */
10594
+ type: 'crypto_wallet';
10595
+ }
10596
+
10597
+ /**
10598
+ * Physical address of the counterparty, or null if not recorded.
10599
+ */
10600
+ export interface PhysicalAddress {
10601
+ /**
10602
+ * City or locality.
10603
+ */
10604
+ city: string;
10605
+
10606
+ /**
10607
+ * ISO 3166-1 alpha-2 country code.
10608
+ */
10609
+ country_code:
10610
+ | 'AF'
10611
+ | 'AL'
10612
+ | 'DZ'
10613
+ | 'AS'
10614
+ | 'AD'
10615
+ | 'AO'
10616
+ | 'AI'
10617
+ | 'AQ'
10618
+ | 'AG'
10619
+ | 'AR'
10620
+ | 'AM'
10621
+ | 'AW'
10622
+ | 'AU'
10623
+ | 'AT'
10624
+ | 'AZ'
10625
+ | 'BS'
10626
+ | 'BH'
10627
+ | 'BD'
10628
+ | 'BB'
10629
+ | 'BY'
10630
+ | 'BE'
10631
+ | 'BZ'
10632
+ | 'BJ'
10633
+ | 'BM'
10634
+ | 'BT'
10635
+ | 'BO'
10636
+ | 'BA'
10637
+ | 'BW'
10638
+ | 'BV'
10639
+ | 'BR'
10640
+ | 'IO'
10641
+ | 'BN'
10642
+ | 'BG'
10643
+ | 'BF'
10644
+ | 'BI'
10645
+ | 'KH'
10646
+ | 'CM'
10647
+ | 'CA'
10648
+ | 'CV'
10649
+ | 'KY'
10650
+ | 'CF'
10651
+ | 'TD'
10652
+ | 'CL'
10653
+ | 'CN'
10654
+ | 'CX'
10655
+ | 'CC'
10656
+ | 'CO'
10657
+ | 'KM'
10658
+ | 'CG'
10659
+ | 'CD'
10660
+ | 'CK'
10661
+ | 'CR'
10662
+ | 'CI'
10663
+ | 'HR'
10664
+ | 'CU'
10665
+ | 'CY'
10666
+ | 'CZ'
10667
+ | 'DK'
10668
+ | 'DJ'
10669
+ | 'DM'
10670
+ | 'DO'
10671
+ | 'EC'
10672
+ | 'EG'
10673
+ | 'SV'
10674
+ | 'GQ'
10675
+ | 'ER'
10676
+ | 'EE'
10677
+ | 'ET'
10678
+ | 'FK'
10679
+ | 'FO'
10680
+ | 'FJ'
10681
+ | 'FI'
10682
+ | 'FR'
10683
+ | 'GF'
10684
+ | 'PF'
10685
+ | 'TF'
10686
+ | 'GA'
10687
+ | 'GM'
10688
+ | 'GE'
10689
+ | 'DE'
10690
+ | 'GH'
10691
+ | 'GI'
10692
+ | 'GR'
10693
+ | 'GL'
10694
+ | 'GD'
10695
+ | 'GP'
10696
+ | 'GU'
10697
+ | 'GT'
10698
+ | 'GN'
10699
+ | 'GW'
10700
+ | 'GY'
10701
+ | 'HT'
10702
+ | 'HM'
10703
+ | 'VA'
10704
+ | 'HN'
10705
+ | 'HK'
10706
+ | 'HU'
10707
+ | 'IS'
10708
+ | 'IN'
10709
+ | 'ID'
10710
+ | 'IR'
10711
+ | 'IQ'
10712
+ | 'IE'
10713
+ | 'IL'
10714
+ | 'IT'
10715
+ | 'JM'
10716
+ | 'JP'
10717
+ | 'JO'
10718
+ | 'KZ'
10719
+ | 'KE'
10720
+ | 'KI'
10721
+ | 'KP'
10722
+ | 'KR'
10723
+ | 'KW'
10724
+ | 'KG'
10725
+ | 'LA'
10726
+ | 'LV'
10727
+ | 'LB'
10728
+ | 'LS'
10729
+ | 'LR'
10730
+ | 'LY'
10731
+ | 'LI'
10732
+ | 'LT'
10733
+ | 'LU'
10734
+ | 'MO'
10735
+ | 'MG'
10736
+ | 'MW'
10737
+ | 'MY'
10738
+ | 'MV'
10739
+ | 'ML'
10740
+ | 'MT'
10741
+ | 'MH'
10742
+ | 'MQ'
10743
+ | 'MR'
10744
+ | 'MU'
10745
+ | 'YT'
10746
+ | 'MX'
10747
+ | 'FM'
10748
+ | 'MD'
10749
+ | 'MC'
10750
+ | 'MN'
10751
+ | 'MS'
10752
+ | 'MA'
10753
+ | 'MZ'
10754
+ | 'MM'
10755
+ | 'NA'
10756
+ | 'NR'
10757
+ | 'NP'
10758
+ | 'NL'
10759
+ | 'NC'
10760
+ | 'NZ'
10761
+ | 'NI'
10762
+ | 'NE'
10763
+ | 'NG'
10764
+ | 'NU'
10765
+ | 'NF'
10766
+ | 'MP'
10767
+ | 'MK'
10768
+ | 'NO'
10769
+ | 'OM'
10770
+ | 'PK'
10771
+ | 'PW'
10772
+ | 'PS'
10773
+ | 'PA'
10774
+ | 'PG'
10775
+ | 'PY'
10776
+ | 'PE'
10777
+ | 'PH'
10778
+ | 'PN'
10779
+ | 'PL'
10780
+ | 'PT'
10781
+ | 'PR'
10782
+ | 'QA'
10783
+ | 'RE'
10784
+ | 'RO'
10785
+ | 'RU'
10786
+ | 'RW'
10787
+ | 'SH'
10788
+ | 'KN'
10789
+ | 'LC'
10790
+ | 'PM'
10791
+ | 'VC'
10792
+ | 'WS'
10793
+ | 'SM'
10794
+ | 'ST'
10795
+ | 'SA'
10796
+ | 'SN'
10797
+ | 'SC'
10798
+ | 'SL'
10799
+ | 'SG'
10800
+ | 'SK'
10801
+ | 'SI'
10802
+ | 'SB'
10803
+ | 'SO'
10804
+ | 'ZA'
10805
+ | 'GS'
10806
+ | 'ES'
10807
+ | 'LK'
10808
+ | 'SD'
10809
+ | 'SR'
10810
+ | 'SJ'
10811
+ | 'SZ'
10812
+ | 'SE'
10813
+ | 'CH'
10814
+ | 'SY'
10815
+ | 'TW'
10816
+ | 'TJ'
10817
+ | 'TZ'
10818
+ | 'TH'
10819
+ | 'TL'
10820
+ | 'TG'
10821
+ | 'TK'
10822
+ | 'TO'
10823
+ | 'TT'
10824
+ | 'TN'
10825
+ | 'TR'
10826
+ | 'TM'
10827
+ | 'TC'
10828
+ | 'TV'
10829
+ | 'UG'
10830
+ | 'UA'
10831
+ | 'AE'
10832
+ | 'GB'
10833
+ | 'US'
10834
+ | 'UM'
10835
+ | 'UY'
10836
+ | 'UZ'
10837
+ | 'VU'
10838
+ | 'VE'
10839
+ | 'VN'
10840
+ | 'VG'
10841
+ | 'VI'
10842
+ | 'WF'
10843
+ | 'EH'
10844
+ | 'YE'
10845
+ | 'ZM'
10846
+ | 'ZW'
10847
+ | 'AX'
10848
+ | 'BQ'
10849
+ | 'CW'
10850
+ | 'GG'
10851
+ | 'IM'
10852
+ | 'JE'
10853
+ | 'ME'
10854
+ | 'BL'
10855
+ | 'MF'
10856
+ | 'RS'
10857
+ | 'SX'
10858
+ | 'SS'
10859
+ | 'XK';
10860
+
10861
+ /**
10862
+ * Primary street address, or null if not recorded.
10863
+ */
10864
+ line_1: string | null;
10865
+
10866
+ /**
10867
+ * Secondary street address, or null if not recorded.
10868
+ */
10869
+ line_2: string | null;
10870
+
10871
+ /**
10872
+ * Postal or ZIP code, or null if not recorded.
10873
+ */
10874
+ postal_code: string | null;
10875
+
10876
+ /**
10877
+ * State, province, or region, or null if not recorded.
10878
+ */
10879
+ state: string | null;
10880
+ }
10881
+ }
10882
+ }
10883
+
10884
+ export interface CounterpartyRejectedWebhookEvent {
10885
+ /**
10886
+ * Unique identifier for the event. Stable across retries.
10887
+ */
10888
+ id: string;
10889
+
10890
+ /**
10891
+ * API version the payload was rendered at. Stable across retries and redeliveries.
10892
+ */
10893
+ api_version: string;
10894
+
10895
+ /**
10896
+ * ISO 8601 UTC timestamp when the event was created.
10897
+ */
10898
+ date: string;
10899
+
10900
+ /**
10901
+ * Full resource snapshot at the time of the event.
10902
+ */
10903
+ payload: CounterpartyRejectedWebhookEvent.Payload;
10904
+
10905
+ /**
10906
+ * Event type in resource.action format.
10907
+ */
10908
+ type: 'counterparty.rejected';
10909
+ }
10910
+
10911
+ export namespace CounterpartyRejectedWebhookEvent {
10912
+ /**
10913
+ * Full resource snapshot at the time of the event.
10914
+ */
10915
+ export interface Payload {
10916
+ /**
10917
+ * Unique identifier of the counterparty.
10918
+ */
10919
+ id: string;
10920
+
10921
+ /**
10922
+ * Whether payments to or from this counterparty are currently blocked.
10923
+ */
10924
+ blocked: boolean;
10925
+
10926
+ /**
10927
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
10928
+ */
10929
+ date_of_birth: string | null;
10930
+
10931
+ /**
10932
+ * Whether the counterparty is a business or an individual.
10933
+ */
10934
+ entity_type: 'business' | 'individual';
10935
+
10936
+ /**
10937
+ * Financial address of the counterparty.
10938
+ */
10939
+ financial_address:
10940
+ | Payload.IbanFinancialAddress
10941
+ | Payload.SortCodeFinancialAddress
10942
+ | Payload.AbaFinancialAddress
10943
+ | Payload.BicFinancialAddress
10944
+ | Payload.CryptoWalletFinancialAddress;
10945
+
10946
+ /**
10947
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
10948
+ * by you, `true` if it is.
10949
+ */
10950
+ is_self_owned: boolean;
10951
+
10952
+ /**
10953
+ * Set of up to 50 key-value string pairs you can attach to store structured
10954
+ * information, such as correlating this resource with an object in your own
10955
+ * system. Keys may be up to 40 characters and values up to 500 characters.
10956
+ */
10957
+ metadata: { [key: string]: string };
10958
+
10959
+ /**
10960
+ * Name of the counterparty, or null if not recorded.
10961
+ */
10962
+ name: string | null;
10963
+
10964
+ /**
10965
+ * Physical address of the counterparty, or null if not recorded.
10966
+ */
10967
+ physical_address: Payload.PhysicalAddress | null;
10968
+
10969
+ /**
10970
+ * Resource type discriminator.
10971
+ */
10972
+ type: 'counterparty';
10973
+ }
10974
+
10975
+ export namespace Payload {
10976
+ export interface IbanFinancialAddress {
10977
+ /**
10978
+ * Name of the account holder.
10979
+ */
10980
+ account_holder_name: string;
10981
+
10982
+ /**
10983
+ * Bank Identifier Code, or null if not provided.
10984
+ */
10985
+ bic: string | null;
10986
+
10987
+ /**
10988
+ * International Bank Account Number.
10989
+ */
10990
+ iban: string;
10991
+
10992
+ /**
10993
+ * Discriminator for IBAN financial address.
10994
+ */
10995
+ type: 'iban';
10996
+ }
10997
+
10998
+ export interface SortCodeFinancialAddress {
10999
+ /**
11000
+ * Name of the account holder.
11001
+ */
11002
+ account_holder_name: string;
11003
+
11004
+ /**
11005
+ * UK account number (8 digits).
11006
+ */
11007
+ account_number: string;
11008
+
11009
+ /**
11010
+ * UK sort code (6 digits).
11011
+ */
11012
+ sort_code: string;
11013
+
11014
+ /**
11015
+ * Discriminator for UK sort code financial address.
11016
+ */
11017
+ type: 'sort_code';
11018
+ }
11019
+
11020
+ export interface AbaFinancialAddress {
11021
+ /**
11022
+ * Name of the account holder.
11023
+ */
11024
+ account_holder_name: string;
11025
+
11026
+ /**
11027
+ * Bank account number.
11028
+ */
11029
+ account_number: string;
11030
+
11031
+ /**
11032
+ * ABA routing number (9 digits).
11033
+ */
11034
+ routing_number: string;
11035
+
11036
+ /**
11037
+ * Discriminator for ABA wire financial address.
11038
+ */
11039
+ type: 'aba';
11040
+ }
11041
+
11042
+ export interface BicFinancialAddress {
11043
+ /**
11044
+ * Name of the account holder.
11045
+ */
11046
+ account_holder_name: string;
11047
+
11048
+ /**
11049
+ * Local-format bank account number.
11050
+ */
11051
+ account_number: string;
11052
+
11053
+ /**
11054
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
11055
+ */
11056
+ bic: string;
11057
+
11058
+ /**
11059
+ * Domestic bank or branch code where the destination country uses one (for example
11060
+ * the BSB in Australia), or null.
11061
+ */
11062
+ local_bank_code: string | null;
11063
+
11064
+ /**
11065
+ * Discriminator for BIC + local account financial address.
11066
+ */
11067
+ type: 'bic';
11068
+ }
11069
+
11070
+ export interface CryptoWalletFinancialAddress {
11071
+ /**
11072
+ * Wallet address on the specified blockchain.
11073
+ */
11074
+ address: string;
11075
+
11076
+ /**
11077
+ * Blockchain network for the crypto wallet.
11078
+ */
11079
+ blockchain:
11080
+ | 'bitcoin'
11081
+ | 'ethereum'
11082
+ | 'solana'
11083
+ | 'polygon'
11084
+ | 'bitcoin_testnet4'
11085
+ | 'ethereum_sepolia'
11086
+ | 'solana_devnet'
11087
+ | 'polygon_amoy';
11088
+
11089
+ /**
11090
+ * Discriminator for crypto wallet financial address.
11091
+ */
11092
+ type: 'crypto_wallet';
11093
+ }
11094
+
11095
+ /**
11096
+ * Physical address of the counterparty, or null if not recorded.
11097
+ */
11098
+ export interface PhysicalAddress {
11099
+ /**
11100
+ * City or locality.
11101
+ */
11102
+ city: string;
11103
+
11104
+ /**
11105
+ * ISO 3166-1 alpha-2 country code.
11106
+ */
11107
+ country_code:
11108
+ | 'AF'
11109
+ | 'AL'
11110
+ | 'DZ'
11111
+ | 'AS'
11112
+ | 'AD'
11113
+ | 'AO'
11114
+ | 'AI'
11115
+ | 'AQ'
11116
+ | 'AG'
11117
+ | 'AR'
11118
+ | 'AM'
11119
+ | 'AW'
11120
+ | 'AU'
11121
+ | 'AT'
11122
+ | 'AZ'
11123
+ | 'BS'
11124
+ | 'BH'
11125
+ | 'BD'
11126
+ | 'BB'
11127
+ | 'BY'
11128
+ | 'BE'
11129
+ | 'BZ'
11130
+ | 'BJ'
11131
+ | 'BM'
11132
+ | 'BT'
11133
+ | 'BO'
11134
+ | 'BA'
11135
+ | 'BW'
11136
+ | 'BV'
11137
+ | 'BR'
11138
+ | 'IO'
11139
+ | 'BN'
11140
+ | 'BG'
11141
+ | 'BF'
11142
+ | 'BI'
11143
+ | 'KH'
11144
+ | 'CM'
11145
+ | 'CA'
11146
+ | 'CV'
11147
+ | 'KY'
11148
+ | 'CF'
11149
+ | 'TD'
11150
+ | 'CL'
11151
+ | 'CN'
11152
+ | 'CX'
11153
+ | 'CC'
11154
+ | 'CO'
11155
+ | 'KM'
11156
+ | 'CG'
11157
+ | 'CD'
11158
+ | 'CK'
11159
+ | 'CR'
11160
+ | 'CI'
11161
+ | 'HR'
11162
+ | 'CU'
11163
+ | 'CY'
11164
+ | 'CZ'
11165
+ | 'DK'
11166
+ | 'DJ'
11167
+ | 'DM'
11168
+ | 'DO'
11169
+ | 'EC'
11170
+ | 'EG'
11171
+ | 'SV'
11172
+ | 'GQ'
11173
+ | 'ER'
11174
+ | 'EE'
11175
+ | 'ET'
11176
+ | 'FK'
11177
+ | 'FO'
11178
+ | 'FJ'
11179
+ | 'FI'
11180
+ | 'FR'
11181
+ | 'GF'
11182
+ | 'PF'
11183
+ | 'TF'
11184
+ | 'GA'
11185
+ | 'GM'
11186
+ | 'GE'
11187
+ | 'DE'
11188
+ | 'GH'
11189
+ | 'GI'
11190
+ | 'GR'
11191
+ | 'GL'
11192
+ | 'GD'
11193
+ | 'GP'
11194
+ | 'GU'
11195
+ | 'GT'
11196
+ | 'GN'
11197
+ | 'GW'
11198
+ | 'GY'
11199
+ | 'HT'
11200
+ | 'HM'
11201
+ | 'VA'
11202
+ | 'HN'
11203
+ | 'HK'
11204
+ | 'HU'
11205
+ | 'IS'
11206
+ | 'IN'
11207
+ | 'ID'
11208
+ | 'IR'
11209
+ | 'IQ'
11210
+ | 'IE'
11211
+ | 'IL'
11212
+ | 'IT'
11213
+ | 'JM'
11214
+ | 'JP'
11215
+ | 'JO'
11216
+ | 'KZ'
11217
+ | 'KE'
11218
+ | 'KI'
11219
+ | 'KP'
11220
+ | 'KR'
11221
+ | 'KW'
11222
+ | 'KG'
11223
+ | 'LA'
11224
+ | 'LV'
11225
+ | 'LB'
11226
+ | 'LS'
11227
+ | 'LR'
11228
+ | 'LY'
11229
+ | 'LI'
11230
+ | 'LT'
11231
+ | 'LU'
11232
+ | 'MO'
11233
+ | 'MG'
11234
+ | 'MW'
11235
+ | 'MY'
11236
+ | 'MV'
11237
+ | 'ML'
11238
+ | 'MT'
11239
+ | 'MH'
11240
+ | 'MQ'
11241
+ | 'MR'
11242
+ | 'MU'
11243
+ | 'YT'
11244
+ | 'MX'
11245
+ | 'FM'
11246
+ | 'MD'
11247
+ | 'MC'
11248
+ | 'MN'
11249
+ | 'MS'
11250
+ | 'MA'
11251
+ | 'MZ'
11252
+ | 'MM'
11253
+ | 'NA'
11254
+ | 'NR'
11255
+ | 'NP'
11256
+ | 'NL'
11257
+ | 'NC'
11258
+ | 'NZ'
11259
+ | 'NI'
11260
+ | 'NE'
11261
+ | 'NG'
11262
+ | 'NU'
11263
+ | 'NF'
11264
+ | 'MP'
11265
+ | 'MK'
11266
+ | 'NO'
11267
+ | 'OM'
11268
+ | 'PK'
11269
+ | 'PW'
11270
+ | 'PS'
11271
+ | 'PA'
11272
+ | 'PG'
11273
+ | 'PY'
11274
+ | 'PE'
11275
+ | 'PH'
11276
+ | 'PN'
11277
+ | 'PL'
11278
+ | 'PT'
11279
+ | 'PR'
11280
+ | 'QA'
11281
+ | 'RE'
11282
+ | 'RO'
11283
+ | 'RU'
11284
+ | 'RW'
11285
+ | 'SH'
11286
+ | 'KN'
11287
+ | 'LC'
11288
+ | 'PM'
11289
+ | 'VC'
11290
+ | 'WS'
11291
+ | 'SM'
11292
+ | 'ST'
11293
+ | 'SA'
11294
+ | 'SN'
11295
+ | 'SC'
11296
+ | 'SL'
11297
+ | 'SG'
11298
+ | 'SK'
11299
+ | 'SI'
11300
+ | 'SB'
11301
+ | 'SO'
11302
+ | 'ZA'
11303
+ | 'GS'
11304
+ | 'ES'
11305
+ | 'LK'
11306
+ | 'SD'
11307
+ | 'SR'
11308
+ | 'SJ'
11309
+ | 'SZ'
11310
+ | 'SE'
11311
+ | 'CH'
11312
+ | 'SY'
11313
+ | 'TW'
11314
+ | 'TJ'
11315
+ | 'TZ'
11316
+ | 'TH'
11317
+ | 'TL'
11318
+ | 'TG'
11319
+ | 'TK'
11320
+ | 'TO'
11321
+ | 'TT'
11322
+ | 'TN'
11323
+ | 'TR'
11324
+ | 'TM'
11325
+ | 'TC'
11326
+ | 'TV'
11327
+ | 'UG'
11328
+ | 'UA'
11329
+ | 'AE'
11330
+ | 'GB'
11331
+ | 'US'
11332
+ | 'UM'
11333
+ | 'UY'
11334
+ | 'UZ'
11335
+ | 'VU'
11336
+ | 'VE'
11337
+ | 'VN'
11338
+ | 'VG'
11339
+ | 'VI'
11340
+ | 'WF'
11341
+ | 'EH'
11342
+ | 'YE'
11343
+ | 'ZM'
11344
+ | 'ZW'
11345
+ | 'AX'
11346
+ | 'BQ'
11347
+ | 'CW'
11348
+ | 'GG'
11349
+ | 'IM'
11350
+ | 'JE'
11351
+ | 'ME'
11352
+ | 'BL'
11353
+ | 'MF'
11354
+ | 'RS'
11355
+ | 'SX'
11356
+ | 'SS'
11357
+ | 'XK';
11358
+
11359
+ /**
11360
+ * Primary street address, or null if not recorded.
11361
+ */
11362
+ line_1: string | null;
11363
+
11364
+ /**
11365
+ * Secondary street address, or null if not recorded.
11366
+ */
11367
+ line_2: string | null;
11368
+
11369
+ /**
11370
+ * Postal or ZIP code, or null if not recorded.
11371
+ */
11372
+ postal_code: string | null;
11373
+
11374
+ /**
11375
+ * State, province, or region, or null if not recorded.
11376
+ */
11377
+ state: string | null;
11378
+ }
11379
+ }
11380
+ }
11381
+
11382
+ export interface CounterpartyBlockedWebhookEvent {
11383
+ /**
11384
+ * Unique identifier for the event. Stable across retries.
11385
+ */
11386
+ id: string;
11387
+
11388
+ /**
11389
+ * API version the payload was rendered at. Stable across retries and redeliveries.
11390
+ */
11391
+ api_version: string;
11392
+
11393
+ /**
11394
+ * ISO 8601 UTC timestamp when the event was created.
11395
+ */
11396
+ date: string;
11397
+
11398
+ /**
11399
+ * Full resource snapshot at the time of the event.
11400
+ */
11401
+ payload: CounterpartyBlockedWebhookEvent.Payload;
11402
+
11403
+ /**
11404
+ * Event type in resource.action format.
11405
+ */
11406
+ type: 'counterparty.blocked';
11407
+ }
11408
+
11409
+ export namespace CounterpartyBlockedWebhookEvent {
11410
+ /**
11411
+ * Full resource snapshot at the time of the event.
11412
+ */
11413
+ export interface Payload {
11414
+ /**
11415
+ * Unique identifier of the counterparty.
11416
+ */
11417
+ id: string;
11418
+
11419
+ /**
11420
+ * Whether payments to or from this counterparty are currently blocked.
11421
+ */
11422
+ blocked: boolean;
11423
+
11424
+ /**
11425
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
11426
+ */
11427
+ date_of_birth: string | null;
11428
+
11429
+ /**
11430
+ * Whether the counterparty is a business or an individual.
11431
+ */
11432
+ entity_type: 'business' | 'individual';
11433
+
11434
+ /**
11435
+ * Financial address of the counterparty.
11436
+ */
11437
+ financial_address:
11438
+ | Payload.IbanFinancialAddress
11439
+ | Payload.SortCodeFinancialAddress
11440
+ | Payload.AbaFinancialAddress
11441
+ | Payload.BicFinancialAddress
11442
+ | Payload.CryptoWalletFinancialAddress;
11443
+
11444
+ /**
11445
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
11446
+ * by you, `true` if it is.
11447
+ */
11448
+ is_self_owned: boolean;
11449
+
11450
+ /**
11451
+ * Set of up to 50 key-value string pairs you can attach to store structured
11452
+ * information, such as correlating this resource with an object in your own
11453
+ * system. Keys may be up to 40 characters and values up to 500 characters.
11454
+ */
11455
+ metadata: { [key: string]: string };
11456
+
11457
+ /**
11458
+ * Name of the counterparty, or null if not recorded.
11459
+ */
11460
+ name: string | null;
11461
+
11462
+ /**
11463
+ * Physical address of the counterparty, or null if not recorded.
11464
+ */
11465
+ physical_address: Payload.PhysicalAddress | null;
11466
+
11467
+ /**
11468
+ * Resource type discriminator.
11469
+ */
11470
+ type: 'counterparty';
11471
+ }
11472
+
11473
+ export namespace Payload {
11474
+ export interface IbanFinancialAddress {
11475
+ /**
11476
+ * Name of the account holder.
11477
+ */
11478
+ account_holder_name: string;
11479
+
11480
+ /**
11481
+ * Bank Identifier Code, or null if not provided.
11482
+ */
11483
+ bic: string | null;
11484
+
11485
+ /**
11486
+ * International Bank Account Number.
11487
+ */
11488
+ iban: string;
11489
+
11490
+ /**
11491
+ * Discriminator for IBAN financial address.
11492
+ */
11493
+ type: 'iban';
11494
+ }
11495
+
11496
+ export interface SortCodeFinancialAddress {
11497
+ /**
11498
+ * Name of the account holder.
11499
+ */
11500
+ account_holder_name: string;
11501
+
11502
+ /**
11503
+ * UK account number (8 digits).
11504
+ */
11505
+ account_number: string;
11506
+
11507
+ /**
11508
+ * UK sort code (6 digits).
11509
+ */
11510
+ sort_code: string;
11511
+
11512
+ /**
11513
+ * Discriminator for UK sort code financial address.
11514
+ */
11515
+ type: 'sort_code';
11516
+ }
11517
+
11518
+ export interface AbaFinancialAddress {
11519
+ /**
11520
+ * Name of the account holder.
11521
+ */
11522
+ account_holder_name: string;
11523
+
11524
+ /**
11525
+ * Bank account number.
11526
+ */
11527
+ account_number: string;
11528
+
11529
+ /**
11530
+ * ABA routing number (9 digits).
11531
+ */
11532
+ routing_number: string;
11533
+
11534
+ /**
11535
+ * Discriminator for ABA wire financial address.
11536
+ */
11537
+ type: 'aba';
11538
+ }
11539
+
11540
+ export interface BicFinancialAddress {
11541
+ /**
11542
+ * Name of the account holder.
11543
+ */
11544
+ account_holder_name: string;
11545
+
11546
+ /**
11547
+ * Local-format bank account number.
11548
+ */
11549
+ account_number: string;
11550
+
11551
+ /**
11552
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
11553
+ */
11554
+ bic: string;
11555
+
11556
+ /**
11557
+ * Domestic bank or branch code where the destination country uses one (for example
11558
+ * the BSB in Australia), or null.
11559
+ */
11560
+ local_bank_code: string | null;
11561
+
11562
+ /**
11563
+ * Discriminator for BIC + local account financial address.
11564
+ */
11565
+ type: 'bic';
11566
+ }
11567
+
11568
+ export interface CryptoWalletFinancialAddress {
11569
+ /**
11570
+ * Wallet address on the specified blockchain.
11571
+ */
11572
+ address: string;
11573
+
11574
+ /**
11575
+ * Blockchain network for the crypto wallet.
11576
+ */
11577
+ blockchain:
11578
+ | 'bitcoin'
11579
+ | 'ethereum'
11580
+ | 'solana'
11581
+ | 'polygon'
11582
+ | 'bitcoin_testnet4'
11583
+ | 'ethereum_sepolia'
11584
+ | 'solana_devnet'
11585
+ | 'polygon_amoy';
11586
+
11587
+ /**
11588
+ * Discriminator for crypto wallet financial address.
11589
+ */
11590
+ type: 'crypto_wallet';
11591
+ }
11592
+
11593
+ /**
11594
+ * Physical address of the counterparty, or null if not recorded.
11595
+ */
11596
+ export interface PhysicalAddress {
11597
+ /**
11598
+ * City or locality.
11599
+ */
11600
+ city: string;
11601
+
11602
+ /**
11603
+ * ISO 3166-1 alpha-2 country code.
11604
+ */
11605
+ country_code:
11606
+ | 'AF'
11607
+ | 'AL'
11608
+ | 'DZ'
11609
+ | 'AS'
11610
+ | 'AD'
11611
+ | 'AO'
11612
+ | 'AI'
11613
+ | 'AQ'
11614
+ | 'AG'
11615
+ | 'AR'
11616
+ | 'AM'
11617
+ | 'AW'
11618
+ | 'AU'
11619
+ | 'AT'
11620
+ | 'AZ'
11621
+ | 'BS'
11622
+ | 'BH'
11623
+ | 'BD'
11624
+ | 'BB'
11625
+ | 'BY'
11626
+ | 'BE'
11627
+ | 'BZ'
11628
+ | 'BJ'
11629
+ | 'BM'
11630
+ | 'BT'
11631
+ | 'BO'
11632
+ | 'BA'
11633
+ | 'BW'
11634
+ | 'BV'
11635
+ | 'BR'
11636
+ | 'IO'
11637
+ | 'BN'
11638
+ | 'BG'
11639
+ | 'BF'
11640
+ | 'BI'
11641
+ | 'KH'
11642
+ | 'CM'
11643
+ | 'CA'
11644
+ | 'CV'
11645
+ | 'KY'
11646
+ | 'CF'
11647
+ | 'TD'
11648
+ | 'CL'
11649
+ | 'CN'
11650
+ | 'CX'
11651
+ | 'CC'
11652
+ | 'CO'
11653
+ | 'KM'
11654
+ | 'CG'
11655
+ | 'CD'
11656
+ | 'CK'
11657
+ | 'CR'
11658
+ | 'CI'
11659
+ | 'HR'
11660
+ | 'CU'
11661
+ | 'CY'
11662
+ | 'CZ'
11663
+ | 'DK'
11664
+ | 'DJ'
11665
+ | 'DM'
11666
+ | 'DO'
11667
+ | 'EC'
11668
+ | 'EG'
11669
+ | 'SV'
11670
+ | 'GQ'
11671
+ | 'ER'
11672
+ | 'EE'
11673
+ | 'ET'
11674
+ | 'FK'
11675
+ | 'FO'
11676
+ | 'FJ'
11677
+ | 'FI'
11678
+ | 'FR'
11679
+ | 'GF'
11680
+ | 'PF'
11681
+ | 'TF'
11682
+ | 'GA'
11683
+ | 'GM'
11684
+ | 'GE'
11685
+ | 'DE'
11686
+ | 'GH'
11687
+ | 'GI'
11688
+ | 'GR'
11689
+ | 'GL'
11690
+ | 'GD'
11691
+ | 'GP'
11692
+ | 'GU'
11693
+ | 'GT'
11694
+ | 'GN'
11695
+ | 'GW'
11696
+ | 'GY'
11697
+ | 'HT'
11698
+ | 'HM'
11699
+ | 'VA'
11700
+ | 'HN'
11701
+ | 'HK'
11702
+ | 'HU'
11703
+ | 'IS'
11704
+ | 'IN'
11705
+ | 'ID'
11706
+ | 'IR'
11707
+ | 'IQ'
11708
+ | 'IE'
11709
+ | 'IL'
11710
+ | 'IT'
11711
+ | 'JM'
11712
+ | 'JP'
11713
+ | 'JO'
11714
+ | 'KZ'
11715
+ | 'KE'
11716
+ | 'KI'
11717
+ | 'KP'
11718
+ | 'KR'
11719
+ | 'KW'
11720
+ | 'KG'
11721
+ | 'LA'
11722
+ | 'LV'
11723
+ | 'LB'
11724
+ | 'LS'
11725
+ | 'LR'
11726
+ | 'LY'
11727
+ | 'LI'
11728
+ | 'LT'
11729
+ | 'LU'
11730
+ | 'MO'
11731
+ | 'MG'
11732
+ | 'MW'
11733
+ | 'MY'
11734
+ | 'MV'
11735
+ | 'ML'
11736
+ | 'MT'
11737
+ | 'MH'
11738
+ | 'MQ'
11739
+ | 'MR'
11740
+ | 'MU'
11741
+ | 'YT'
11742
+ | 'MX'
11743
+ | 'FM'
11744
+ | 'MD'
11745
+ | 'MC'
11746
+ | 'MN'
11747
+ | 'MS'
11748
+ | 'MA'
11749
+ | 'MZ'
11750
+ | 'MM'
11751
+ | 'NA'
11752
+ | 'NR'
11753
+ | 'NP'
11754
+ | 'NL'
11755
+ | 'NC'
11756
+ | 'NZ'
11757
+ | 'NI'
11758
+ | 'NE'
11759
+ | 'NG'
11760
+ | 'NU'
11761
+ | 'NF'
11762
+ | 'MP'
11763
+ | 'MK'
11764
+ | 'NO'
11765
+ | 'OM'
11766
+ | 'PK'
11767
+ | 'PW'
11768
+ | 'PS'
11769
+ | 'PA'
11770
+ | 'PG'
11771
+ | 'PY'
11772
+ | 'PE'
11773
+ | 'PH'
11774
+ | 'PN'
11775
+ | 'PL'
11776
+ | 'PT'
11777
+ | 'PR'
11778
+ | 'QA'
11779
+ | 'RE'
11780
+ | 'RO'
11781
+ | 'RU'
11782
+ | 'RW'
11783
+ | 'SH'
11784
+ | 'KN'
11785
+ | 'LC'
11786
+ | 'PM'
11787
+ | 'VC'
11788
+ | 'WS'
11789
+ | 'SM'
11790
+ | 'ST'
11791
+ | 'SA'
11792
+ | 'SN'
11793
+ | 'SC'
11794
+ | 'SL'
11795
+ | 'SG'
11796
+ | 'SK'
11797
+ | 'SI'
11798
+ | 'SB'
11799
+ | 'SO'
11800
+ | 'ZA'
11801
+ | 'GS'
11802
+ | 'ES'
11803
+ | 'LK'
11804
+ | 'SD'
11805
+ | 'SR'
11806
+ | 'SJ'
11807
+ | 'SZ'
11808
+ | 'SE'
11809
+ | 'CH'
11810
+ | 'SY'
11811
+ | 'TW'
11812
+ | 'TJ'
11813
+ | 'TZ'
11814
+ | 'TH'
11815
+ | 'TL'
11816
+ | 'TG'
11817
+ | 'TK'
11818
+ | 'TO'
11819
+ | 'TT'
11820
+ | 'TN'
11821
+ | 'TR'
11822
+ | 'TM'
11823
+ | 'TC'
11824
+ | 'TV'
11825
+ | 'UG'
11826
+ | 'UA'
11827
+ | 'AE'
11828
+ | 'GB'
11829
+ | 'US'
11830
+ | 'UM'
11831
+ | 'UY'
11832
+ | 'UZ'
11833
+ | 'VU'
11834
+ | 'VE'
11835
+ | 'VN'
11836
+ | 'VG'
11837
+ | 'VI'
11838
+ | 'WF'
11839
+ | 'EH'
11840
+ | 'YE'
11841
+ | 'ZM'
11842
+ | 'ZW'
11843
+ | 'AX'
11844
+ | 'BQ'
11845
+ | 'CW'
11846
+ | 'GG'
11847
+ | 'IM'
11848
+ | 'JE'
11849
+ | 'ME'
11850
+ | 'BL'
11851
+ | 'MF'
11852
+ | 'RS'
11853
+ | 'SX'
11854
+ | 'SS'
11855
+ | 'XK';
11856
+
11857
+ /**
11858
+ * Primary street address, or null if not recorded.
11859
+ */
11860
+ line_1: string | null;
11861
+
11862
+ /**
11863
+ * Secondary street address, or null if not recorded.
11864
+ */
11865
+ line_2: string | null;
11866
+
11867
+ /**
11868
+ * Postal or ZIP code, or null if not recorded.
11869
+ */
11870
+ postal_code: string | null;
11871
+
11872
+ /**
11873
+ * State, province, or region, or null if not recorded.
11874
+ */
11875
+ state: string | null;
11876
+ }
11877
+ }
11878
+ }
11879
+
11880
+ export interface CounterpartyUnblockedWebhookEvent {
11881
+ /**
11882
+ * Unique identifier for the event. Stable across retries.
11883
+ */
11884
+ id: string;
11885
+
11886
+ /**
11887
+ * API version the payload was rendered at. Stable across retries and redeliveries.
11888
+ */
11889
+ api_version: string;
11890
+
11891
+ /**
11892
+ * ISO 8601 UTC timestamp when the event was created.
11893
+ */
11894
+ date: string;
11895
+
11896
+ /**
11897
+ * Full resource snapshot at the time of the event.
11898
+ */
11899
+ payload: CounterpartyUnblockedWebhookEvent.Payload;
11900
+
11901
+ /**
11902
+ * Event type in resource.action format.
11903
+ */
11904
+ type: 'counterparty.unblocked';
11905
+ }
11906
+
11907
+ export namespace CounterpartyUnblockedWebhookEvent {
11908
+ /**
11909
+ * Full resource snapshot at the time of the event.
11910
+ */
11911
+ export interface Payload {
11912
+ /**
11913
+ * Unique identifier of the counterparty.
11914
+ */
11915
+ id: string;
11916
+
11917
+ /**
11918
+ * Whether payments to or from this counterparty are currently blocked.
11919
+ */
11920
+ blocked: boolean;
11921
+
11922
+ /**
11923
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
11924
+ */
11925
+ date_of_birth: string | null;
11926
+
11927
+ /**
11928
+ * Whether the counterparty is a business or an individual.
11929
+ */
11930
+ entity_type: 'business' | 'individual';
11931
+
11932
+ /**
11933
+ * Financial address of the counterparty.
11934
+ */
11935
+ financial_address:
11936
+ | Payload.IbanFinancialAddress
11937
+ | Payload.SortCodeFinancialAddress
11938
+ | Payload.AbaFinancialAddress
11939
+ | Payload.BicFinancialAddress
11940
+ | Payload.CryptoWalletFinancialAddress;
11941
+
11942
+ /**
11943
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
11944
+ * by you, `true` if it is.
11945
+ */
11946
+ is_self_owned: boolean;
11947
+
11948
+ /**
11949
+ * Set of up to 50 key-value string pairs you can attach to store structured
11950
+ * information, such as correlating this resource with an object in your own
11951
+ * system. Keys may be up to 40 characters and values up to 500 characters.
11952
+ */
11953
+ metadata: { [key: string]: string };
11954
+
11955
+ /**
11956
+ * Name of the counterparty, or null if not recorded.
11957
+ */
11958
+ name: string | null;
11959
+
11960
+ /**
11961
+ * Physical address of the counterparty, or null if not recorded.
11962
+ */
11963
+ physical_address: Payload.PhysicalAddress | null;
11964
+
11965
+ /**
11966
+ * Resource type discriminator.
11967
+ */
11968
+ type: 'counterparty';
11969
+ }
11970
+
11971
+ export namespace Payload {
11972
+ export interface IbanFinancialAddress {
11973
+ /**
11974
+ * Name of the account holder.
11975
+ */
11976
+ account_holder_name: string;
11977
+
11978
+ /**
11979
+ * Bank Identifier Code, or null if not provided.
11980
+ */
11981
+ bic: string | null;
11982
+
11983
+ /**
11984
+ * International Bank Account Number.
11985
+ */
11986
+ iban: string;
11987
+
11988
+ /**
11989
+ * Discriminator for IBAN financial address.
11990
+ */
11991
+ type: 'iban';
11992
+ }
11993
+
11994
+ export interface SortCodeFinancialAddress {
11995
+ /**
11996
+ * Name of the account holder.
11997
+ */
11998
+ account_holder_name: string;
11999
+
12000
+ /**
12001
+ * UK account number (8 digits).
12002
+ */
12003
+ account_number: string;
12004
+
12005
+ /**
12006
+ * UK sort code (6 digits).
12007
+ */
12008
+ sort_code: string;
12009
+
12010
+ /**
12011
+ * Discriminator for UK sort code financial address.
12012
+ */
12013
+ type: 'sort_code';
12014
+ }
12015
+
12016
+ export interface AbaFinancialAddress {
12017
+ /**
12018
+ * Name of the account holder.
12019
+ */
12020
+ account_holder_name: string;
12021
+
12022
+ /**
12023
+ * Bank account number.
12024
+ */
12025
+ account_number: string;
12026
+
12027
+ /**
12028
+ * ABA routing number (9 digits).
12029
+ */
12030
+ routing_number: string;
12031
+
12032
+ /**
12033
+ * Discriminator for ABA wire financial address.
12034
+ */
12035
+ type: 'aba';
12036
+ }
12037
+
12038
+ export interface BicFinancialAddress {
12039
+ /**
12040
+ * Name of the account holder.
12041
+ */
12042
+ account_holder_name: string;
12043
+
12044
+ /**
12045
+ * Local-format bank account number.
12046
+ */
12047
+ account_number: string;
12048
+
12049
+ /**
12050
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
12051
+ */
12052
+ bic: string;
12053
+
12054
+ /**
12055
+ * Domestic bank or branch code where the destination country uses one (for example
12056
+ * the BSB in Australia), or null.
12057
+ */
12058
+ local_bank_code: string | null;
12059
+
12060
+ /**
12061
+ * Discriminator for BIC + local account financial address.
12062
+ */
12063
+ type: 'bic';
12064
+ }
12065
+
12066
+ export interface CryptoWalletFinancialAddress {
12067
+ /**
12068
+ * Wallet address on the specified blockchain.
12069
+ */
12070
+ address: string;
12071
+
12072
+ /**
12073
+ * Blockchain network for the crypto wallet.
12074
+ */
12075
+ blockchain:
12076
+ | 'bitcoin'
12077
+ | 'ethereum'
12078
+ | 'solana'
12079
+ | 'polygon'
12080
+ | 'bitcoin_testnet4'
12081
+ | 'ethereum_sepolia'
12082
+ | 'solana_devnet'
12083
+ | 'polygon_amoy';
12084
+
12085
+ /**
12086
+ * Discriminator for crypto wallet financial address.
12087
+ */
12088
+ type: 'crypto_wallet';
12089
+ }
12090
+
12091
+ /**
12092
+ * Physical address of the counterparty, or null if not recorded.
12093
+ */
12094
+ export interface PhysicalAddress {
12095
+ /**
12096
+ * City or locality.
12097
+ */
12098
+ city: string;
12099
+
12100
+ /**
12101
+ * ISO 3166-1 alpha-2 country code.
12102
+ */
12103
+ country_code:
12104
+ | 'AF'
12105
+ | 'AL'
12106
+ | 'DZ'
12107
+ | 'AS'
12108
+ | 'AD'
12109
+ | 'AO'
12110
+ | 'AI'
12111
+ | 'AQ'
12112
+ | 'AG'
12113
+ | 'AR'
12114
+ | 'AM'
12115
+ | 'AW'
12116
+ | 'AU'
12117
+ | 'AT'
12118
+ | 'AZ'
12119
+ | 'BS'
12120
+ | 'BH'
12121
+ | 'BD'
12122
+ | 'BB'
12123
+ | 'BY'
12124
+ | 'BE'
12125
+ | 'BZ'
12126
+ | 'BJ'
12127
+ | 'BM'
12128
+ | 'BT'
12129
+ | 'BO'
12130
+ | 'BA'
12131
+ | 'BW'
12132
+ | 'BV'
12133
+ | 'BR'
12134
+ | 'IO'
12135
+ | 'BN'
12136
+ | 'BG'
12137
+ | 'BF'
12138
+ | 'BI'
12139
+ | 'KH'
12140
+ | 'CM'
12141
+ | 'CA'
12142
+ | 'CV'
12143
+ | 'KY'
12144
+ | 'CF'
12145
+ | 'TD'
12146
+ | 'CL'
12147
+ | 'CN'
12148
+ | 'CX'
12149
+ | 'CC'
12150
+ | 'CO'
12151
+ | 'KM'
12152
+ | 'CG'
12153
+ | 'CD'
12154
+ | 'CK'
12155
+ | 'CR'
12156
+ | 'CI'
12157
+ | 'HR'
12158
+ | 'CU'
12159
+ | 'CY'
12160
+ | 'CZ'
12161
+ | 'DK'
12162
+ | 'DJ'
12163
+ | 'DM'
12164
+ | 'DO'
12165
+ | 'EC'
12166
+ | 'EG'
12167
+ | 'SV'
12168
+ | 'GQ'
12169
+ | 'ER'
12170
+ | 'EE'
12171
+ | 'ET'
12172
+ | 'FK'
12173
+ | 'FO'
12174
+ | 'FJ'
12175
+ | 'FI'
12176
+ | 'FR'
12177
+ | 'GF'
12178
+ | 'PF'
12179
+ | 'TF'
12180
+ | 'GA'
12181
+ | 'GM'
12182
+ | 'GE'
12183
+ | 'DE'
12184
+ | 'GH'
12185
+ | 'GI'
12186
+ | 'GR'
12187
+ | 'GL'
12188
+ | 'GD'
12189
+ | 'GP'
12190
+ | 'GU'
12191
+ | 'GT'
12192
+ | 'GN'
12193
+ | 'GW'
12194
+ | 'GY'
12195
+ | 'HT'
12196
+ | 'HM'
12197
+ | 'VA'
12198
+ | 'HN'
12199
+ | 'HK'
12200
+ | 'HU'
12201
+ | 'IS'
12202
+ | 'IN'
12203
+ | 'ID'
12204
+ | 'IR'
12205
+ | 'IQ'
12206
+ | 'IE'
12207
+ | 'IL'
12208
+ | 'IT'
12209
+ | 'JM'
12210
+ | 'JP'
12211
+ | 'JO'
12212
+ | 'KZ'
12213
+ | 'KE'
12214
+ | 'KI'
12215
+ | 'KP'
12216
+ | 'KR'
12217
+ | 'KW'
12218
+ | 'KG'
12219
+ | 'LA'
12220
+ | 'LV'
12221
+ | 'LB'
12222
+ | 'LS'
12223
+ | 'LR'
12224
+ | 'LY'
12225
+ | 'LI'
12226
+ | 'LT'
12227
+ | 'LU'
12228
+ | 'MO'
12229
+ | 'MG'
12230
+ | 'MW'
12231
+ | 'MY'
12232
+ | 'MV'
12233
+ | 'ML'
12234
+ | 'MT'
12235
+ | 'MH'
12236
+ | 'MQ'
12237
+ | 'MR'
12238
+ | 'MU'
12239
+ | 'YT'
12240
+ | 'MX'
12241
+ | 'FM'
12242
+ | 'MD'
12243
+ | 'MC'
12244
+ | 'MN'
12245
+ | 'MS'
12246
+ | 'MA'
12247
+ | 'MZ'
12248
+ | 'MM'
12249
+ | 'NA'
12250
+ | 'NR'
12251
+ | 'NP'
12252
+ | 'NL'
12253
+ | 'NC'
12254
+ | 'NZ'
12255
+ | 'NI'
12256
+ | 'NE'
12257
+ | 'NG'
12258
+ | 'NU'
12259
+ | 'NF'
12260
+ | 'MP'
12261
+ | 'MK'
12262
+ | 'NO'
12263
+ | 'OM'
12264
+ | 'PK'
12265
+ | 'PW'
12266
+ | 'PS'
12267
+ | 'PA'
12268
+ | 'PG'
12269
+ | 'PY'
12270
+ | 'PE'
12271
+ | 'PH'
12272
+ | 'PN'
12273
+ | 'PL'
12274
+ | 'PT'
12275
+ | 'PR'
12276
+ | 'QA'
12277
+ | 'RE'
12278
+ | 'RO'
12279
+ | 'RU'
12280
+ | 'RW'
12281
+ | 'SH'
12282
+ | 'KN'
12283
+ | 'LC'
12284
+ | 'PM'
12285
+ | 'VC'
12286
+ | 'WS'
12287
+ | 'SM'
12288
+ | 'ST'
12289
+ | 'SA'
12290
+ | 'SN'
12291
+ | 'SC'
12292
+ | 'SL'
12293
+ | 'SG'
12294
+ | 'SK'
12295
+ | 'SI'
12296
+ | 'SB'
12297
+ | 'SO'
12298
+ | 'ZA'
12299
+ | 'GS'
12300
+ | 'ES'
12301
+ | 'LK'
12302
+ | 'SD'
12303
+ | 'SR'
12304
+ | 'SJ'
12305
+ | 'SZ'
12306
+ | 'SE'
12307
+ | 'CH'
12308
+ | 'SY'
12309
+ | 'TW'
12310
+ | 'TJ'
12311
+ | 'TZ'
12312
+ | 'TH'
12313
+ | 'TL'
12314
+ | 'TG'
12315
+ | 'TK'
12316
+ | 'TO'
12317
+ | 'TT'
12318
+ | 'TN'
12319
+ | 'TR'
12320
+ | 'TM'
12321
+ | 'TC'
12322
+ | 'TV'
12323
+ | 'UG'
12324
+ | 'UA'
12325
+ | 'AE'
12326
+ | 'GB'
12327
+ | 'US'
12328
+ | 'UM'
12329
+ | 'UY'
12330
+ | 'UZ'
12331
+ | 'VU'
12332
+ | 'VE'
12333
+ | 'VN'
12334
+ | 'VG'
12335
+ | 'VI'
12336
+ | 'WF'
12337
+ | 'EH'
12338
+ | 'YE'
12339
+ | 'ZM'
12340
+ | 'ZW'
12341
+ | 'AX'
12342
+ | 'BQ'
12343
+ | 'CW'
12344
+ | 'GG'
12345
+ | 'IM'
12346
+ | 'JE'
12347
+ | 'ME'
12348
+ | 'BL'
12349
+ | 'MF'
12350
+ | 'RS'
12351
+ | 'SX'
12352
+ | 'SS'
12353
+ | 'XK';
12354
+
12355
+ /**
12356
+ * Primary street address, or null if not recorded.
12357
+ */
12358
+ line_1: string | null;
12359
+
12360
+ /**
12361
+ * Secondary street address, or null if not recorded.
12362
+ */
12363
+ line_2: string | null;
12364
+
12365
+ /**
12366
+ * Postal or ZIP code, or null if not recorded.
12367
+ */
12368
+ postal_code: string | null;
12369
+
12370
+ /**
12371
+ * State, province, or region, or null if not recorded.
12372
+ */
12373
+ state: string | null;
12374
+ }
12375
+ }
12376
+ }
12377
+
12378
+ export interface CounterpartyUpdatedWebhookEvent {
12379
+ /**
12380
+ * Unique identifier for the event. Stable across retries.
12381
+ */
12382
+ id: string;
12383
+
12384
+ /**
12385
+ * API version the payload was rendered at. Stable across retries and redeliveries.
12386
+ */
12387
+ api_version: string;
12388
+
12389
+ /**
12390
+ * ISO 8601 UTC timestamp when the event was created.
12391
+ */
12392
+ date: string;
12393
+
12394
+ /**
12395
+ * Full resource snapshot at the time of the event.
12396
+ */
12397
+ payload: CounterpartyUpdatedWebhookEvent.Payload;
12398
+
12399
+ /**
12400
+ * Event type in resource.action format.
12401
+ */
12402
+ type: 'counterparty.updated';
12403
+ }
12404
+
12405
+ export namespace CounterpartyUpdatedWebhookEvent {
12406
+ /**
12407
+ * Full resource snapshot at the time of the event.
12408
+ */
12409
+ export interface Payload {
12410
+ /**
12411
+ * Unique identifier of the counterparty.
12412
+ */
12413
+ id: string;
12414
+
12415
+ /**
12416
+ * Whether payments to or from this counterparty are currently blocked.
12417
+ */
12418
+ blocked: boolean;
12419
+
12420
+ /**
12421
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
12422
+ */
12423
+ date_of_birth: string | null;
12424
+
12425
+ /**
12426
+ * Whether the counterparty is a business or an individual.
12427
+ */
12428
+ entity_type: 'business' | 'individual';
12429
+
12430
+ /**
12431
+ * Financial address of the counterparty.
12432
+ */
12433
+ financial_address:
12434
+ | Payload.IbanFinancialAddress
12435
+ | Payload.SortCodeFinancialAddress
12436
+ | Payload.AbaFinancialAddress
12437
+ | Payload.BicFinancialAddress
12438
+ | Payload.CryptoWalletFinancialAddress;
12439
+
12440
+ /**
12441
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
12442
+ * by you, `true` if it is.
12443
+ */
12444
+ is_self_owned: boolean;
12445
+
12446
+ /**
12447
+ * Set of up to 50 key-value string pairs you can attach to store structured
12448
+ * information, such as correlating this resource with an object in your own
12449
+ * system. Keys may be up to 40 characters and values up to 500 characters.
12450
+ */
12451
+ metadata: { [key: string]: string };
12452
+
12453
+ /**
12454
+ * Name of the counterparty, or null if not recorded.
12455
+ */
12456
+ name: string | null;
12457
+
12458
+ /**
12459
+ * Physical address of the counterparty, or null if not recorded.
12460
+ */
12461
+ physical_address: Payload.PhysicalAddress | null;
12462
+
12463
+ /**
12464
+ * Resource type discriminator.
12465
+ */
12466
+ type: 'counterparty';
12467
+ }
12468
+
12469
+ export namespace Payload {
12470
+ export interface IbanFinancialAddress {
12471
+ /**
12472
+ * Name of the account holder.
12473
+ */
12474
+ account_holder_name: string;
12475
+
12476
+ /**
12477
+ * Bank Identifier Code, or null if not provided.
12478
+ */
12479
+ bic: string | null;
12480
+
12481
+ /**
12482
+ * International Bank Account Number.
12483
+ */
12484
+ iban: string;
12485
+
12486
+ /**
12487
+ * Discriminator for IBAN financial address.
12488
+ */
12489
+ type: 'iban';
12490
+ }
12491
+
12492
+ export interface SortCodeFinancialAddress {
12493
+ /**
12494
+ * Name of the account holder.
12495
+ */
12496
+ account_holder_name: string;
12497
+
12498
+ /**
12499
+ * UK account number (8 digits).
12500
+ */
12501
+ account_number: string;
12502
+
12503
+ /**
12504
+ * UK sort code (6 digits).
12505
+ */
12506
+ sort_code: string;
12507
+
12508
+ /**
12509
+ * Discriminator for UK sort code financial address.
12510
+ */
12511
+ type: 'sort_code';
12512
+ }
12513
+
12514
+ export interface AbaFinancialAddress {
12515
+ /**
12516
+ * Name of the account holder.
12517
+ */
12518
+ account_holder_name: string;
12519
+
12520
+ /**
12521
+ * Bank account number.
12522
+ */
12523
+ account_number: string;
12524
+
12525
+ /**
12526
+ * ABA routing number (9 digits).
12527
+ */
12528
+ routing_number: string;
12529
+
12530
+ /**
12531
+ * Discriminator for ABA wire financial address.
12532
+ */
12533
+ type: 'aba';
12534
+ }
12535
+
12536
+ export interface BicFinancialAddress {
12537
+ /**
12538
+ * Name of the account holder.
12539
+ */
12540
+ account_holder_name: string;
12541
+
12542
+ /**
12543
+ * Local-format bank account number.
12544
+ */
12545
+ account_number: string;
12546
+
12547
+ /**
12548
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
12549
+ */
12550
+ bic: string;
12551
+
12552
+ /**
12553
+ * Domestic bank or branch code where the destination country uses one (for example
12554
+ * the BSB in Australia), or null.
12555
+ */
12556
+ local_bank_code: string | null;
12557
+
12558
+ /**
12559
+ * Discriminator for BIC + local account financial address.
12560
+ */
12561
+ type: 'bic';
12562
+ }
12563
+
12564
+ export interface CryptoWalletFinancialAddress {
12565
+ /**
12566
+ * Wallet address on the specified blockchain.
12567
+ */
12568
+ address: string;
12569
+
12570
+ /**
12571
+ * Blockchain network for the crypto wallet.
12572
+ */
12573
+ blockchain:
12574
+ | 'bitcoin'
12575
+ | 'ethereum'
12576
+ | 'solana'
12577
+ | 'polygon'
12578
+ | 'bitcoin_testnet4'
12579
+ | 'ethereum_sepolia'
12580
+ | 'solana_devnet'
12581
+ | 'polygon_amoy';
12582
+
12583
+ /**
12584
+ * Discriminator for crypto wallet financial address.
12585
+ */
12586
+ type: 'crypto_wallet';
12587
+ }
12588
+
12589
+ /**
12590
+ * Physical address of the counterparty, or null if not recorded.
12591
+ */
12592
+ export interface PhysicalAddress {
12593
+ /**
12594
+ * City or locality.
12595
+ */
12596
+ city: string;
12597
+
12598
+ /**
12599
+ * ISO 3166-1 alpha-2 country code.
12600
+ */
12601
+ country_code:
12602
+ | 'AF'
12603
+ | 'AL'
12604
+ | 'DZ'
12605
+ | 'AS'
12606
+ | 'AD'
12607
+ | 'AO'
12608
+ | 'AI'
12609
+ | 'AQ'
12610
+ | 'AG'
12611
+ | 'AR'
12612
+ | 'AM'
12613
+ | 'AW'
12614
+ | 'AU'
12615
+ | 'AT'
12616
+ | 'AZ'
12617
+ | 'BS'
12618
+ | 'BH'
12619
+ | 'BD'
12620
+ | 'BB'
12621
+ | 'BY'
12622
+ | 'BE'
12623
+ | 'BZ'
12624
+ | 'BJ'
12625
+ | 'BM'
12626
+ | 'BT'
12627
+ | 'BO'
12628
+ | 'BA'
12629
+ | 'BW'
12630
+ | 'BV'
12631
+ | 'BR'
12632
+ | 'IO'
12633
+ | 'BN'
12634
+ | 'BG'
12635
+ | 'BF'
12636
+ | 'BI'
12637
+ | 'KH'
12638
+ | 'CM'
12639
+ | 'CA'
12640
+ | 'CV'
12641
+ | 'KY'
12642
+ | 'CF'
12643
+ | 'TD'
12644
+ | 'CL'
12645
+ | 'CN'
12646
+ | 'CX'
12647
+ | 'CC'
12648
+ | 'CO'
12649
+ | 'KM'
12650
+ | 'CG'
12651
+ | 'CD'
12652
+ | 'CK'
12653
+ | 'CR'
12654
+ | 'CI'
12655
+ | 'HR'
12656
+ | 'CU'
12657
+ | 'CY'
12658
+ | 'CZ'
12659
+ | 'DK'
12660
+ | 'DJ'
12661
+ | 'DM'
12662
+ | 'DO'
12663
+ | 'EC'
12664
+ | 'EG'
12665
+ | 'SV'
12666
+ | 'GQ'
12667
+ | 'ER'
12668
+ | 'EE'
12669
+ | 'ET'
12670
+ | 'FK'
12671
+ | 'FO'
12672
+ | 'FJ'
12673
+ | 'FI'
12674
+ | 'FR'
12675
+ | 'GF'
12676
+ | 'PF'
12677
+ | 'TF'
12678
+ | 'GA'
12679
+ | 'GM'
12680
+ | 'GE'
12681
+ | 'DE'
12682
+ | 'GH'
12683
+ | 'GI'
12684
+ | 'GR'
12685
+ | 'GL'
12686
+ | 'GD'
12687
+ | 'GP'
12688
+ | 'GU'
12689
+ | 'GT'
12690
+ | 'GN'
12691
+ | 'GW'
12692
+ | 'GY'
12693
+ | 'HT'
12694
+ | 'HM'
12695
+ | 'VA'
12696
+ | 'HN'
12697
+ | 'HK'
12698
+ | 'HU'
12699
+ | 'IS'
12700
+ | 'IN'
12701
+ | 'ID'
12702
+ | 'IR'
12703
+ | 'IQ'
12704
+ | 'IE'
12705
+ | 'IL'
12706
+ | 'IT'
12707
+ | 'JM'
12708
+ | 'JP'
12709
+ | 'JO'
12710
+ | 'KZ'
12711
+ | 'KE'
12712
+ | 'KI'
12713
+ | 'KP'
12714
+ | 'KR'
12715
+ | 'KW'
12716
+ | 'KG'
12717
+ | 'LA'
12718
+ | 'LV'
12719
+ | 'LB'
12720
+ | 'LS'
12721
+ | 'LR'
12722
+ | 'LY'
12723
+ | 'LI'
12724
+ | 'LT'
12725
+ | 'LU'
12726
+ | 'MO'
12727
+ | 'MG'
12728
+ | 'MW'
12729
+ | 'MY'
12730
+ | 'MV'
12731
+ | 'ML'
12732
+ | 'MT'
12733
+ | 'MH'
12734
+ | 'MQ'
12735
+ | 'MR'
12736
+ | 'MU'
12737
+ | 'YT'
12738
+ | 'MX'
12739
+ | 'FM'
12740
+ | 'MD'
12741
+ | 'MC'
12742
+ | 'MN'
12743
+ | 'MS'
12744
+ | 'MA'
12745
+ | 'MZ'
12746
+ | 'MM'
12747
+ | 'NA'
12748
+ | 'NR'
12749
+ | 'NP'
12750
+ | 'NL'
12751
+ | 'NC'
12752
+ | 'NZ'
12753
+ | 'NI'
12754
+ | 'NE'
12755
+ | 'NG'
12756
+ | 'NU'
12757
+ | 'NF'
12758
+ | 'MP'
12759
+ | 'MK'
12760
+ | 'NO'
12761
+ | 'OM'
12762
+ | 'PK'
12763
+ | 'PW'
12764
+ | 'PS'
12765
+ | 'PA'
12766
+ | 'PG'
12767
+ | 'PY'
12768
+ | 'PE'
12769
+ | 'PH'
12770
+ | 'PN'
12771
+ | 'PL'
12772
+ | 'PT'
12773
+ | 'PR'
12774
+ | 'QA'
12775
+ | 'RE'
12776
+ | 'RO'
12777
+ | 'RU'
12778
+ | 'RW'
12779
+ | 'SH'
12780
+ | 'KN'
12781
+ | 'LC'
12782
+ | 'PM'
12783
+ | 'VC'
12784
+ | 'WS'
12785
+ | 'SM'
12786
+ | 'ST'
12787
+ | 'SA'
12788
+ | 'SN'
12789
+ | 'SC'
12790
+ | 'SL'
12791
+ | 'SG'
12792
+ | 'SK'
12793
+ | 'SI'
12794
+ | 'SB'
12795
+ | 'SO'
12796
+ | 'ZA'
12797
+ | 'GS'
12798
+ | 'ES'
12799
+ | 'LK'
12800
+ | 'SD'
12801
+ | 'SR'
12802
+ | 'SJ'
12803
+ | 'SZ'
12804
+ | 'SE'
12805
+ | 'CH'
12806
+ | 'SY'
12807
+ | 'TW'
12808
+ | 'TJ'
12809
+ | 'TZ'
12810
+ | 'TH'
12811
+ | 'TL'
12812
+ | 'TG'
12813
+ | 'TK'
12814
+ | 'TO'
12815
+ | 'TT'
12816
+ | 'TN'
12817
+ | 'TR'
12818
+ | 'TM'
12819
+ | 'TC'
12820
+ | 'TV'
12821
+ | 'UG'
12822
+ | 'UA'
12823
+ | 'AE'
12824
+ | 'GB'
12825
+ | 'US'
12826
+ | 'UM'
12827
+ | 'UY'
12828
+ | 'UZ'
12829
+ | 'VU'
12830
+ | 'VE'
12831
+ | 'VN'
12832
+ | 'VG'
12833
+ | 'VI'
12834
+ | 'WF'
12835
+ | 'EH'
12836
+ | 'YE'
12837
+ | 'ZM'
12838
+ | 'ZW'
12839
+ | 'AX'
12840
+ | 'BQ'
12841
+ | 'CW'
12842
+ | 'GG'
12843
+ | 'IM'
12844
+ | 'JE'
12845
+ | 'ME'
12846
+ | 'BL'
12847
+ | 'MF'
12848
+ | 'RS'
12849
+ | 'SX'
12850
+ | 'SS'
12851
+ | 'XK';
12852
+
12853
+ /**
12854
+ * Primary street address, or null if not recorded.
12855
+ */
12856
+ line_1: string | null;
12857
+
12858
+ /**
12859
+ * Secondary street address, or null if not recorded.
12860
+ */
12861
+ line_2: string | null;
12862
+
12863
+ /**
12864
+ * Postal or ZIP code, or null if not recorded.
12865
+ */
12866
+ postal_code: string | null;
12867
+
12868
+ /**
12869
+ * State, province, or region, or null if not recorded.
12870
+ */
12871
+ state: string | null;
12872
+ }
12873
+ }
12874
+ }
12875
+
9823
12876
  export interface PingTestWebhookEvent {
9824
12877
  /**
9825
12878
  * Unique identifier for the event. Stable across retries.
@@ -9897,6 +12950,12 @@ export type UnwrapWebhookEvent =
9897
12950
  | ConversionFailedWebhookEvent
9898
12951
  | AccountHolderActiveWebhookEvent
9899
12952
  | AccountHolderClosedWebhookEvent
12953
+ | CounterpartyCreatedWebhookEvent
12954
+ | CounterpartyVerifiedWebhookEvent
12955
+ | CounterpartyRejectedWebhookEvent
12956
+ | CounterpartyBlockedWebhookEvent
12957
+ | CounterpartyUnblockedWebhookEvent
12958
+ | CounterpartyUpdatedWebhookEvent
9900
12959
  | PingTestWebhookEvent;
9901
12960
 
9902
12961
  export declare namespace Webhooks {
@@ -9917,6 +12976,12 @@ export declare namespace Webhooks {
9917
12976
  type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent,
9918
12977
  type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent,
9919
12978
  type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent,
12979
+ type CounterpartyCreatedWebhookEvent as CounterpartyCreatedWebhookEvent,
12980
+ type CounterpartyVerifiedWebhookEvent as CounterpartyVerifiedWebhookEvent,
12981
+ type CounterpartyRejectedWebhookEvent as CounterpartyRejectedWebhookEvent,
12982
+ type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent,
12983
+ type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent,
12984
+ type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent,
9920
12985
  type PingTestWebhookEvent as PingTestWebhookEvent,
9921
12986
  type UnwrapWebhookEvent as UnwrapWebhookEvent,
9922
12987
  };