@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
@@ -61,7 +61,9 @@ export declare namespace PayoutInitiatedWebhookEvent {
61
61
  */
62
62
  initiated_at: string;
63
63
  /**
64
- * Key-value pairs stored with the payout.
64
+ * Set of up to 50 key-value string pairs you can attach to store structured
65
+ * information, such as correlating this resource with an object in your own
66
+ * system. Keys may be up to 40 characters and values up to 500 characters.
65
67
  */
66
68
  metadata: {
67
69
  [key: string]: string;
@@ -174,7 +176,9 @@ export declare namespace PayoutSubmittedWebhookEvent {
174
176
  */
175
177
  initiated_at: string;
176
178
  /**
177
- * Key-value pairs stored with the payout.
179
+ * Set of up to 50 key-value string pairs you can attach to store structured
180
+ * information, such as correlating this resource with an object in your own
181
+ * system. Keys may be up to 40 characters and values up to 500 characters.
178
182
  */
179
183
  metadata: {
180
184
  [key: string]: string;
@@ -287,7 +291,9 @@ export declare namespace PayoutSentWebhookEvent {
287
291
  */
288
292
  initiated_at: string;
289
293
  /**
290
- * Key-value pairs stored with the payout.
294
+ * Set of up to 50 key-value string pairs you can attach to store structured
295
+ * information, such as correlating this resource with an object in your own
296
+ * system. Keys may be up to 40 characters and values up to 500 characters.
291
297
  */
292
298
  metadata: {
293
299
  [key: string]: string;
@@ -400,7 +406,9 @@ export declare namespace PayoutFailedWebhookEvent {
400
406
  */
401
407
  initiated_at: string;
402
408
  /**
403
- * Key-value pairs stored with the payout.
409
+ * Set of up to 50 key-value string pairs you can attach to store structured
410
+ * information, such as correlating this resource with an object in your own
411
+ * system. Keys may be up to 40 characters and values up to 500 characters.
404
412
  */
405
413
  metadata: {
406
414
  [key: string]: string;
@@ -513,7 +521,9 @@ export declare namespace PayoutReturnedWebhookEvent {
513
521
  */
514
522
  initiated_at: string;
515
523
  /**
516
- * Key-value pairs stored with the payout.
524
+ * Set of up to 50 key-value string pairs you can attach to store structured
525
+ * information, such as correlating this resource with an object in your own
526
+ * system. Keys may be up to 40 characters and values up to 500 characters.
517
527
  */
518
528
  metadata: {
519
529
  [key: string]: string;
@@ -621,6 +631,14 @@ export declare namespace ReturnInitiatedWebhookEvent {
621
631
  * ISO 8601 UTC timestamp when the return was initiated.
622
632
  */
623
633
  initiated_at: string;
634
+ /**
635
+ * Set of up to 50 key-value string pairs you can attach to store structured
636
+ * information, such as correlating this resource with an object in your own
637
+ * system. Keys may be up to 40 characters and values up to 500 characters.
638
+ */
639
+ metadata: {
640
+ [key: string]: string;
641
+ };
624
642
  /**
625
643
  * Payment scheme or blockchain used for the return, or null when unknown.
626
644
  */
@@ -714,6 +732,14 @@ export declare namespace ReturnSubmittedWebhookEvent {
714
732
  * ISO 8601 UTC timestamp when the return was initiated.
715
733
  */
716
734
  initiated_at: string;
735
+ /**
736
+ * Set of up to 50 key-value string pairs you can attach to store structured
737
+ * information, such as correlating this resource with an object in your own
738
+ * system. Keys may be up to 40 characters and values up to 500 characters.
739
+ */
740
+ metadata: {
741
+ [key: string]: string;
742
+ };
717
743
  /**
718
744
  * Payment scheme or blockchain used for the return, or null when unknown.
719
745
  */
@@ -807,6 +833,14 @@ export declare namespace ReturnSentWebhookEvent {
807
833
  * ISO 8601 UTC timestamp when the return was initiated.
808
834
  */
809
835
  initiated_at: string;
836
+ /**
837
+ * Set of up to 50 key-value string pairs you can attach to store structured
838
+ * information, such as correlating this resource with an object in your own
839
+ * system. Keys may be up to 40 characters and values up to 500 characters.
840
+ */
841
+ metadata: {
842
+ [key: string]: string;
843
+ };
810
844
  /**
811
845
  * Payment scheme or blockchain used for the return, or null when unknown.
812
846
  */
@@ -900,6 +934,14 @@ export declare namespace ReturnFailedWebhookEvent {
900
934
  * ISO 8601 UTC timestamp when the return was initiated.
901
935
  */
902
936
  initiated_at: string;
937
+ /**
938
+ * Set of up to 50 key-value string pairs you can attach to store structured
939
+ * information, such as correlating this resource with an object in your own
940
+ * system. Keys may be up to 40 characters and values up to 500 characters.
941
+ */
942
+ metadata: {
943
+ [key: string]: string;
944
+ };
903
945
  /**
904
946
  * Payment scheme or blockchain used for the return, or null when unknown.
905
947
  */
@@ -993,6 +1035,14 @@ export declare namespace ReturnReturnedWebhookEvent {
993
1035
  * ISO 8601 UTC timestamp when the return was initiated.
994
1036
  */
995
1037
  initiated_at: string;
1038
+ /**
1039
+ * Set of up to 50 key-value string pairs you can attach to store structured
1040
+ * information, such as correlating this resource with an object in your own
1041
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1042
+ */
1043
+ metadata: {
1044
+ [key: string]: string;
1045
+ };
996
1046
  /**
997
1047
  * Payment scheme or blockchain used for the return, or null when unknown.
998
1048
  */
@@ -1159,7 +1209,9 @@ export declare namespace ConversionCreatedWebhookEvent {
1159
1209
  */
1160
1210
  created_at: string;
1161
1211
  /**
1162
- * Key-value pairs stored with the conversion.
1212
+ * Set of up to 50 key-value string pairs you can attach to store structured
1213
+ * information, such as correlating this resource with an object in your own
1214
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1163
1215
  */
1164
1216
  metadata: {
1165
1217
  [key: string]: string;
@@ -1234,7 +1286,9 @@ export declare namespace ConversionCompletedWebhookEvent {
1234
1286
  */
1235
1287
  created_at: string;
1236
1288
  /**
1237
- * Key-value pairs stored with the conversion.
1289
+ * Set of up to 50 key-value string pairs you can attach to store structured
1290
+ * information, such as correlating this resource with an object in your own
1291
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1238
1292
  */
1239
1293
  metadata: {
1240
1294
  [key: string]: string;
@@ -1309,7 +1363,9 @@ export declare namespace ConversionFailedWebhookEvent {
1309
1363
  */
1310
1364
  created_at: string;
1311
1365
  /**
1312
- * Key-value pairs stored with the conversion.
1366
+ * Set of up to 50 key-value string pairs you can attach to store structured
1367
+ * information, such as correlating this resource with an object in your own
1368
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1313
1369
  */
1314
1370
  metadata: {
1315
1371
  [key: string]: string;
@@ -1390,6 +1446,14 @@ export declare namespace AccountHolderActiveWebhookEvent {
1390
1446
  * Type of the account holder.
1391
1447
  */
1392
1448
  holder_type: 'natural_person' | 'business';
1449
+ /**
1450
+ * Set of up to 50 key-value string pairs you can attach to store structured
1451
+ * information, such as correlating this resource with an object in your own
1452
+ * system. Keys may be up to 40 characters and values up to 500 characters.
1453
+ */
1454
+ metadata: {
1455
+ [key: string]: string;
1456
+ };
1393
1457
  /**
1394
1458
  * Current account holder status.
1395
1459
  */
@@ -2137,6 +2201,14 @@ export declare namespace AccountHolderClosedWebhookEvent {
2137
2201
  * Type of the account holder.
2138
2202
  */
2139
2203
  holder_type: 'natural_person' | 'business';
2204
+ /**
2205
+ * Set of up to 50 key-value string pairs you can attach to store structured
2206
+ * information, such as correlating this resource with an object in your own
2207
+ * system. Keys may be up to 40 characters and values up to 500 characters.
2208
+ */
2209
+ metadata: {
2210
+ [key: string]: string;
2211
+ };
2140
2212
  /**
2141
2213
  * Current account holder status.
2142
2214
  */
@@ -2838,6 +2910,1182 @@ export declare namespace AccountHolderClosedWebhookEvent {
2838
2910
  }
2839
2911
  }
2840
2912
  }
2913
+ export interface CounterpartyCreatedWebhookEvent {
2914
+ /**
2915
+ * Unique identifier for the event. Stable across retries.
2916
+ */
2917
+ id: string;
2918
+ /**
2919
+ * API version the payload was rendered at. Stable across retries and redeliveries.
2920
+ */
2921
+ api_version: string;
2922
+ /**
2923
+ * ISO 8601 UTC timestamp when the event was created.
2924
+ */
2925
+ date: string;
2926
+ /**
2927
+ * Full resource snapshot at the time of the event.
2928
+ */
2929
+ payload: CounterpartyCreatedWebhookEvent.Payload;
2930
+ /**
2931
+ * Event type in resource.action format.
2932
+ */
2933
+ type: 'counterparty.created';
2934
+ }
2935
+ export declare namespace CounterpartyCreatedWebhookEvent {
2936
+ /**
2937
+ * Full resource snapshot at the time of the event.
2938
+ */
2939
+ interface Payload {
2940
+ /**
2941
+ * Unique identifier of the counterparty.
2942
+ */
2943
+ id: string;
2944
+ /**
2945
+ * Whether payments to or from this counterparty are currently blocked.
2946
+ */
2947
+ blocked: boolean;
2948
+ /**
2949
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
2950
+ */
2951
+ date_of_birth: string | null;
2952
+ /**
2953
+ * Whether the counterparty is a business or an individual.
2954
+ */
2955
+ entity_type: 'business' | 'individual';
2956
+ /**
2957
+ * Financial address of the counterparty.
2958
+ */
2959
+ financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
2960
+ /**
2961
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
2962
+ * by you, `true` if it is.
2963
+ */
2964
+ is_self_owned: boolean;
2965
+ /**
2966
+ * Set of up to 50 key-value string pairs you can attach to store structured
2967
+ * information, such as correlating this resource with an object in your own
2968
+ * system. Keys may be up to 40 characters and values up to 500 characters.
2969
+ */
2970
+ metadata: {
2971
+ [key: string]: string;
2972
+ };
2973
+ /**
2974
+ * Name of the counterparty, or null if not recorded.
2975
+ */
2976
+ name: string | null;
2977
+ /**
2978
+ * Physical address of the counterparty, or null if not recorded.
2979
+ */
2980
+ physical_address: Payload.PhysicalAddress | null;
2981
+ /**
2982
+ * Resource type discriminator.
2983
+ */
2984
+ type: 'counterparty';
2985
+ }
2986
+ namespace Payload {
2987
+ interface IbanFinancialAddress {
2988
+ /**
2989
+ * Name of the account holder.
2990
+ */
2991
+ account_holder_name: string;
2992
+ /**
2993
+ * Bank Identifier Code, or null if not provided.
2994
+ */
2995
+ bic: string | null;
2996
+ /**
2997
+ * International Bank Account Number.
2998
+ */
2999
+ iban: string;
3000
+ /**
3001
+ * Discriminator for IBAN financial address.
3002
+ */
3003
+ type: 'iban';
3004
+ }
3005
+ interface SortCodeFinancialAddress {
3006
+ /**
3007
+ * Name of the account holder.
3008
+ */
3009
+ account_holder_name: string;
3010
+ /**
3011
+ * UK account number (8 digits).
3012
+ */
3013
+ account_number: string;
3014
+ /**
3015
+ * UK sort code (6 digits).
3016
+ */
3017
+ sort_code: string;
3018
+ /**
3019
+ * Discriminator for UK sort code financial address.
3020
+ */
3021
+ type: 'sort_code';
3022
+ }
3023
+ interface AbaFinancialAddress {
3024
+ /**
3025
+ * Name of the account holder.
3026
+ */
3027
+ account_holder_name: string;
3028
+ /**
3029
+ * Bank account number.
3030
+ */
3031
+ account_number: string;
3032
+ /**
3033
+ * ABA routing number (9 digits).
3034
+ */
3035
+ routing_number: string;
3036
+ /**
3037
+ * Discriminator for ABA wire financial address.
3038
+ */
3039
+ type: 'aba';
3040
+ }
3041
+ interface BicFinancialAddress {
3042
+ /**
3043
+ * Name of the account holder.
3044
+ */
3045
+ account_holder_name: string;
3046
+ /**
3047
+ * Local-format bank account number.
3048
+ */
3049
+ account_number: string;
3050
+ /**
3051
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
3052
+ */
3053
+ bic: string;
3054
+ /**
3055
+ * Domestic bank or branch code where the destination country uses one (for example
3056
+ * the BSB in Australia), or null.
3057
+ */
3058
+ local_bank_code: string | null;
3059
+ /**
3060
+ * Discriminator for BIC + local account financial address.
3061
+ */
3062
+ type: 'bic';
3063
+ }
3064
+ interface CryptoWalletFinancialAddress {
3065
+ /**
3066
+ * Wallet address on the specified blockchain.
3067
+ */
3068
+ address: string;
3069
+ /**
3070
+ * Blockchain network for the crypto wallet.
3071
+ */
3072
+ blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
3073
+ /**
3074
+ * Discriminator for crypto wallet financial address.
3075
+ */
3076
+ type: 'crypto_wallet';
3077
+ }
3078
+ /**
3079
+ * Physical address of the counterparty, or null if not recorded.
3080
+ */
3081
+ interface PhysicalAddress {
3082
+ /**
3083
+ * City or locality.
3084
+ */
3085
+ city: string;
3086
+ /**
3087
+ * ISO 3166-1 alpha-2 country code.
3088
+ */
3089
+ country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
3090
+ /**
3091
+ * Primary street address, or null if not recorded.
3092
+ */
3093
+ line_1: string | null;
3094
+ /**
3095
+ * Secondary street address, or null if not recorded.
3096
+ */
3097
+ line_2: string | null;
3098
+ /**
3099
+ * Postal or ZIP code, or null if not recorded.
3100
+ */
3101
+ postal_code: string | null;
3102
+ /**
3103
+ * State, province, or region, or null if not recorded.
3104
+ */
3105
+ state: string | null;
3106
+ }
3107
+ }
3108
+ }
3109
+ export interface CounterpartyVerifiedWebhookEvent {
3110
+ /**
3111
+ * Unique identifier for the event. Stable across retries.
3112
+ */
3113
+ id: string;
3114
+ /**
3115
+ * API version the payload was rendered at. Stable across retries and redeliveries.
3116
+ */
3117
+ api_version: string;
3118
+ /**
3119
+ * ISO 8601 UTC timestamp when the event was created.
3120
+ */
3121
+ date: string;
3122
+ /**
3123
+ * Full resource snapshot at the time of the event.
3124
+ */
3125
+ payload: CounterpartyVerifiedWebhookEvent.Payload;
3126
+ /**
3127
+ * Event type in resource.action format.
3128
+ */
3129
+ type: 'counterparty.verified';
3130
+ }
3131
+ export declare namespace CounterpartyVerifiedWebhookEvent {
3132
+ /**
3133
+ * Full resource snapshot at the time of the event.
3134
+ */
3135
+ interface Payload {
3136
+ /**
3137
+ * Unique identifier of the counterparty.
3138
+ */
3139
+ id: string;
3140
+ /**
3141
+ * Whether payments to or from this counterparty are currently blocked.
3142
+ */
3143
+ blocked: boolean;
3144
+ /**
3145
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
3146
+ */
3147
+ date_of_birth: string | null;
3148
+ /**
3149
+ * Whether the counterparty is a business or an individual.
3150
+ */
3151
+ entity_type: 'business' | 'individual';
3152
+ /**
3153
+ * Financial address of the counterparty.
3154
+ */
3155
+ financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
3156
+ /**
3157
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
3158
+ * by you, `true` if it is.
3159
+ */
3160
+ is_self_owned: boolean;
3161
+ /**
3162
+ * Set of up to 50 key-value string pairs you can attach to store structured
3163
+ * information, such as correlating this resource with an object in your own
3164
+ * system. Keys may be up to 40 characters and values up to 500 characters.
3165
+ */
3166
+ metadata: {
3167
+ [key: string]: string;
3168
+ };
3169
+ /**
3170
+ * Name of the counterparty, or null if not recorded.
3171
+ */
3172
+ name: string | null;
3173
+ /**
3174
+ * Physical address of the counterparty, or null if not recorded.
3175
+ */
3176
+ physical_address: Payload.PhysicalAddress | null;
3177
+ /**
3178
+ * Resource type discriminator.
3179
+ */
3180
+ type: 'counterparty';
3181
+ }
3182
+ namespace Payload {
3183
+ interface IbanFinancialAddress {
3184
+ /**
3185
+ * Name of the account holder.
3186
+ */
3187
+ account_holder_name: string;
3188
+ /**
3189
+ * Bank Identifier Code, or null if not provided.
3190
+ */
3191
+ bic: string | null;
3192
+ /**
3193
+ * International Bank Account Number.
3194
+ */
3195
+ iban: string;
3196
+ /**
3197
+ * Discriminator for IBAN financial address.
3198
+ */
3199
+ type: 'iban';
3200
+ }
3201
+ interface SortCodeFinancialAddress {
3202
+ /**
3203
+ * Name of the account holder.
3204
+ */
3205
+ account_holder_name: string;
3206
+ /**
3207
+ * UK account number (8 digits).
3208
+ */
3209
+ account_number: string;
3210
+ /**
3211
+ * UK sort code (6 digits).
3212
+ */
3213
+ sort_code: string;
3214
+ /**
3215
+ * Discriminator for UK sort code financial address.
3216
+ */
3217
+ type: 'sort_code';
3218
+ }
3219
+ interface AbaFinancialAddress {
3220
+ /**
3221
+ * Name of the account holder.
3222
+ */
3223
+ account_holder_name: string;
3224
+ /**
3225
+ * Bank account number.
3226
+ */
3227
+ account_number: string;
3228
+ /**
3229
+ * ABA routing number (9 digits).
3230
+ */
3231
+ routing_number: string;
3232
+ /**
3233
+ * Discriminator for ABA wire financial address.
3234
+ */
3235
+ type: 'aba';
3236
+ }
3237
+ interface BicFinancialAddress {
3238
+ /**
3239
+ * Name of the account holder.
3240
+ */
3241
+ account_holder_name: string;
3242
+ /**
3243
+ * Local-format bank account number.
3244
+ */
3245
+ account_number: string;
3246
+ /**
3247
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
3248
+ */
3249
+ bic: string;
3250
+ /**
3251
+ * Domestic bank or branch code where the destination country uses one (for example
3252
+ * the BSB in Australia), or null.
3253
+ */
3254
+ local_bank_code: string | null;
3255
+ /**
3256
+ * Discriminator for BIC + local account financial address.
3257
+ */
3258
+ type: 'bic';
3259
+ }
3260
+ interface CryptoWalletFinancialAddress {
3261
+ /**
3262
+ * Wallet address on the specified blockchain.
3263
+ */
3264
+ address: string;
3265
+ /**
3266
+ * Blockchain network for the crypto wallet.
3267
+ */
3268
+ blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
3269
+ /**
3270
+ * Discriminator for crypto wallet financial address.
3271
+ */
3272
+ type: 'crypto_wallet';
3273
+ }
3274
+ /**
3275
+ * Physical address of the counterparty, or null if not recorded.
3276
+ */
3277
+ interface PhysicalAddress {
3278
+ /**
3279
+ * City or locality.
3280
+ */
3281
+ city: string;
3282
+ /**
3283
+ * ISO 3166-1 alpha-2 country code.
3284
+ */
3285
+ country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
3286
+ /**
3287
+ * Primary street address, or null if not recorded.
3288
+ */
3289
+ line_1: string | null;
3290
+ /**
3291
+ * Secondary street address, or null if not recorded.
3292
+ */
3293
+ line_2: string | null;
3294
+ /**
3295
+ * Postal or ZIP code, or null if not recorded.
3296
+ */
3297
+ postal_code: string | null;
3298
+ /**
3299
+ * State, province, or region, or null if not recorded.
3300
+ */
3301
+ state: string | null;
3302
+ }
3303
+ }
3304
+ }
3305
+ export interface CounterpartyRejectedWebhookEvent {
3306
+ /**
3307
+ * Unique identifier for the event. Stable across retries.
3308
+ */
3309
+ id: string;
3310
+ /**
3311
+ * API version the payload was rendered at. Stable across retries and redeliveries.
3312
+ */
3313
+ api_version: string;
3314
+ /**
3315
+ * ISO 8601 UTC timestamp when the event was created.
3316
+ */
3317
+ date: string;
3318
+ /**
3319
+ * Full resource snapshot at the time of the event.
3320
+ */
3321
+ payload: CounterpartyRejectedWebhookEvent.Payload;
3322
+ /**
3323
+ * Event type in resource.action format.
3324
+ */
3325
+ type: 'counterparty.rejected';
3326
+ }
3327
+ export declare namespace CounterpartyRejectedWebhookEvent {
3328
+ /**
3329
+ * Full resource snapshot at the time of the event.
3330
+ */
3331
+ interface Payload {
3332
+ /**
3333
+ * Unique identifier of the counterparty.
3334
+ */
3335
+ id: string;
3336
+ /**
3337
+ * Whether payments to or from this counterparty are currently blocked.
3338
+ */
3339
+ blocked: boolean;
3340
+ /**
3341
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
3342
+ */
3343
+ date_of_birth: string | null;
3344
+ /**
3345
+ * Whether the counterparty is a business or an individual.
3346
+ */
3347
+ entity_type: 'business' | 'individual';
3348
+ /**
3349
+ * Financial address of the counterparty.
3350
+ */
3351
+ financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
3352
+ /**
3353
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
3354
+ * by you, `true` if it is.
3355
+ */
3356
+ is_self_owned: boolean;
3357
+ /**
3358
+ * Set of up to 50 key-value string pairs you can attach to store structured
3359
+ * information, such as correlating this resource with an object in your own
3360
+ * system. Keys may be up to 40 characters and values up to 500 characters.
3361
+ */
3362
+ metadata: {
3363
+ [key: string]: string;
3364
+ };
3365
+ /**
3366
+ * Name of the counterparty, or null if not recorded.
3367
+ */
3368
+ name: string | null;
3369
+ /**
3370
+ * Physical address of the counterparty, or null if not recorded.
3371
+ */
3372
+ physical_address: Payload.PhysicalAddress | null;
3373
+ /**
3374
+ * Resource type discriminator.
3375
+ */
3376
+ type: 'counterparty';
3377
+ }
3378
+ namespace Payload {
3379
+ interface IbanFinancialAddress {
3380
+ /**
3381
+ * Name of the account holder.
3382
+ */
3383
+ account_holder_name: string;
3384
+ /**
3385
+ * Bank Identifier Code, or null if not provided.
3386
+ */
3387
+ bic: string | null;
3388
+ /**
3389
+ * International Bank Account Number.
3390
+ */
3391
+ iban: string;
3392
+ /**
3393
+ * Discriminator for IBAN financial address.
3394
+ */
3395
+ type: 'iban';
3396
+ }
3397
+ interface SortCodeFinancialAddress {
3398
+ /**
3399
+ * Name of the account holder.
3400
+ */
3401
+ account_holder_name: string;
3402
+ /**
3403
+ * UK account number (8 digits).
3404
+ */
3405
+ account_number: string;
3406
+ /**
3407
+ * UK sort code (6 digits).
3408
+ */
3409
+ sort_code: string;
3410
+ /**
3411
+ * Discriminator for UK sort code financial address.
3412
+ */
3413
+ type: 'sort_code';
3414
+ }
3415
+ interface AbaFinancialAddress {
3416
+ /**
3417
+ * Name of the account holder.
3418
+ */
3419
+ account_holder_name: string;
3420
+ /**
3421
+ * Bank account number.
3422
+ */
3423
+ account_number: string;
3424
+ /**
3425
+ * ABA routing number (9 digits).
3426
+ */
3427
+ routing_number: string;
3428
+ /**
3429
+ * Discriminator for ABA wire financial address.
3430
+ */
3431
+ type: 'aba';
3432
+ }
3433
+ interface BicFinancialAddress {
3434
+ /**
3435
+ * Name of the account holder.
3436
+ */
3437
+ account_holder_name: string;
3438
+ /**
3439
+ * Local-format bank account number.
3440
+ */
3441
+ account_number: string;
3442
+ /**
3443
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
3444
+ */
3445
+ bic: string;
3446
+ /**
3447
+ * Domestic bank or branch code where the destination country uses one (for example
3448
+ * the BSB in Australia), or null.
3449
+ */
3450
+ local_bank_code: string | null;
3451
+ /**
3452
+ * Discriminator for BIC + local account financial address.
3453
+ */
3454
+ type: 'bic';
3455
+ }
3456
+ interface CryptoWalletFinancialAddress {
3457
+ /**
3458
+ * Wallet address on the specified blockchain.
3459
+ */
3460
+ address: string;
3461
+ /**
3462
+ * Blockchain network for the crypto wallet.
3463
+ */
3464
+ blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
3465
+ /**
3466
+ * Discriminator for crypto wallet financial address.
3467
+ */
3468
+ type: 'crypto_wallet';
3469
+ }
3470
+ /**
3471
+ * Physical address of the counterparty, or null if not recorded.
3472
+ */
3473
+ interface PhysicalAddress {
3474
+ /**
3475
+ * City or locality.
3476
+ */
3477
+ city: string;
3478
+ /**
3479
+ * ISO 3166-1 alpha-2 country code.
3480
+ */
3481
+ country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
3482
+ /**
3483
+ * Primary street address, or null if not recorded.
3484
+ */
3485
+ line_1: string | null;
3486
+ /**
3487
+ * Secondary street address, or null if not recorded.
3488
+ */
3489
+ line_2: string | null;
3490
+ /**
3491
+ * Postal or ZIP code, or null if not recorded.
3492
+ */
3493
+ postal_code: string | null;
3494
+ /**
3495
+ * State, province, or region, or null if not recorded.
3496
+ */
3497
+ state: string | null;
3498
+ }
3499
+ }
3500
+ }
3501
+ export interface CounterpartyBlockedWebhookEvent {
3502
+ /**
3503
+ * Unique identifier for the event. Stable across retries.
3504
+ */
3505
+ id: string;
3506
+ /**
3507
+ * API version the payload was rendered at. Stable across retries and redeliveries.
3508
+ */
3509
+ api_version: string;
3510
+ /**
3511
+ * ISO 8601 UTC timestamp when the event was created.
3512
+ */
3513
+ date: string;
3514
+ /**
3515
+ * Full resource snapshot at the time of the event.
3516
+ */
3517
+ payload: CounterpartyBlockedWebhookEvent.Payload;
3518
+ /**
3519
+ * Event type in resource.action format.
3520
+ */
3521
+ type: 'counterparty.blocked';
3522
+ }
3523
+ export declare namespace CounterpartyBlockedWebhookEvent {
3524
+ /**
3525
+ * Full resource snapshot at the time of the event.
3526
+ */
3527
+ interface Payload {
3528
+ /**
3529
+ * Unique identifier of the counterparty.
3530
+ */
3531
+ id: string;
3532
+ /**
3533
+ * Whether payments to or from this counterparty are currently blocked.
3534
+ */
3535
+ blocked: boolean;
3536
+ /**
3537
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
3538
+ */
3539
+ date_of_birth: string | null;
3540
+ /**
3541
+ * Whether the counterparty is a business or an individual.
3542
+ */
3543
+ entity_type: 'business' | 'individual';
3544
+ /**
3545
+ * Financial address of the counterparty.
3546
+ */
3547
+ financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
3548
+ /**
3549
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
3550
+ * by you, `true` if it is.
3551
+ */
3552
+ is_self_owned: boolean;
3553
+ /**
3554
+ * Set of up to 50 key-value string pairs you can attach to store structured
3555
+ * information, such as correlating this resource with an object in your own
3556
+ * system. Keys may be up to 40 characters and values up to 500 characters.
3557
+ */
3558
+ metadata: {
3559
+ [key: string]: string;
3560
+ };
3561
+ /**
3562
+ * Name of the counterparty, or null if not recorded.
3563
+ */
3564
+ name: string | null;
3565
+ /**
3566
+ * Physical address of the counterparty, or null if not recorded.
3567
+ */
3568
+ physical_address: Payload.PhysicalAddress | null;
3569
+ /**
3570
+ * Resource type discriminator.
3571
+ */
3572
+ type: 'counterparty';
3573
+ }
3574
+ namespace Payload {
3575
+ interface IbanFinancialAddress {
3576
+ /**
3577
+ * Name of the account holder.
3578
+ */
3579
+ account_holder_name: string;
3580
+ /**
3581
+ * Bank Identifier Code, or null if not provided.
3582
+ */
3583
+ bic: string | null;
3584
+ /**
3585
+ * International Bank Account Number.
3586
+ */
3587
+ iban: string;
3588
+ /**
3589
+ * Discriminator for IBAN financial address.
3590
+ */
3591
+ type: 'iban';
3592
+ }
3593
+ interface SortCodeFinancialAddress {
3594
+ /**
3595
+ * Name of the account holder.
3596
+ */
3597
+ account_holder_name: string;
3598
+ /**
3599
+ * UK account number (8 digits).
3600
+ */
3601
+ account_number: string;
3602
+ /**
3603
+ * UK sort code (6 digits).
3604
+ */
3605
+ sort_code: string;
3606
+ /**
3607
+ * Discriminator for UK sort code financial address.
3608
+ */
3609
+ type: 'sort_code';
3610
+ }
3611
+ interface AbaFinancialAddress {
3612
+ /**
3613
+ * Name of the account holder.
3614
+ */
3615
+ account_holder_name: string;
3616
+ /**
3617
+ * Bank account number.
3618
+ */
3619
+ account_number: string;
3620
+ /**
3621
+ * ABA routing number (9 digits).
3622
+ */
3623
+ routing_number: string;
3624
+ /**
3625
+ * Discriminator for ABA wire financial address.
3626
+ */
3627
+ type: 'aba';
3628
+ }
3629
+ interface BicFinancialAddress {
3630
+ /**
3631
+ * Name of the account holder.
3632
+ */
3633
+ account_holder_name: string;
3634
+ /**
3635
+ * Local-format bank account number.
3636
+ */
3637
+ account_number: string;
3638
+ /**
3639
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
3640
+ */
3641
+ bic: string;
3642
+ /**
3643
+ * Domestic bank or branch code where the destination country uses one (for example
3644
+ * the BSB in Australia), or null.
3645
+ */
3646
+ local_bank_code: string | null;
3647
+ /**
3648
+ * Discriminator for BIC + local account financial address.
3649
+ */
3650
+ type: 'bic';
3651
+ }
3652
+ interface CryptoWalletFinancialAddress {
3653
+ /**
3654
+ * Wallet address on the specified blockchain.
3655
+ */
3656
+ address: string;
3657
+ /**
3658
+ * Blockchain network for the crypto wallet.
3659
+ */
3660
+ blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
3661
+ /**
3662
+ * Discriminator for crypto wallet financial address.
3663
+ */
3664
+ type: 'crypto_wallet';
3665
+ }
3666
+ /**
3667
+ * Physical address of the counterparty, or null if not recorded.
3668
+ */
3669
+ interface PhysicalAddress {
3670
+ /**
3671
+ * City or locality.
3672
+ */
3673
+ city: string;
3674
+ /**
3675
+ * ISO 3166-1 alpha-2 country code.
3676
+ */
3677
+ country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
3678
+ /**
3679
+ * Primary street address, or null if not recorded.
3680
+ */
3681
+ line_1: string | null;
3682
+ /**
3683
+ * Secondary street address, or null if not recorded.
3684
+ */
3685
+ line_2: string | null;
3686
+ /**
3687
+ * Postal or ZIP code, or null if not recorded.
3688
+ */
3689
+ postal_code: string | null;
3690
+ /**
3691
+ * State, province, or region, or null if not recorded.
3692
+ */
3693
+ state: string | null;
3694
+ }
3695
+ }
3696
+ }
3697
+ export interface CounterpartyUnblockedWebhookEvent {
3698
+ /**
3699
+ * Unique identifier for the event. Stable across retries.
3700
+ */
3701
+ id: string;
3702
+ /**
3703
+ * API version the payload was rendered at. Stable across retries and redeliveries.
3704
+ */
3705
+ api_version: string;
3706
+ /**
3707
+ * ISO 8601 UTC timestamp when the event was created.
3708
+ */
3709
+ date: string;
3710
+ /**
3711
+ * Full resource snapshot at the time of the event.
3712
+ */
3713
+ payload: CounterpartyUnblockedWebhookEvent.Payload;
3714
+ /**
3715
+ * Event type in resource.action format.
3716
+ */
3717
+ type: 'counterparty.unblocked';
3718
+ }
3719
+ export declare namespace CounterpartyUnblockedWebhookEvent {
3720
+ /**
3721
+ * Full resource snapshot at the time of the event.
3722
+ */
3723
+ interface Payload {
3724
+ /**
3725
+ * Unique identifier of the counterparty.
3726
+ */
3727
+ id: string;
3728
+ /**
3729
+ * Whether payments to or from this counterparty are currently blocked.
3730
+ */
3731
+ blocked: boolean;
3732
+ /**
3733
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
3734
+ */
3735
+ date_of_birth: string | null;
3736
+ /**
3737
+ * Whether the counterparty is a business or an individual.
3738
+ */
3739
+ entity_type: 'business' | 'individual';
3740
+ /**
3741
+ * Financial address of the counterparty.
3742
+ */
3743
+ financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
3744
+ /**
3745
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
3746
+ * by you, `true` if it is.
3747
+ */
3748
+ is_self_owned: boolean;
3749
+ /**
3750
+ * Set of up to 50 key-value string pairs you can attach to store structured
3751
+ * information, such as correlating this resource with an object in your own
3752
+ * system. Keys may be up to 40 characters and values up to 500 characters.
3753
+ */
3754
+ metadata: {
3755
+ [key: string]: string;
3756
+ };
3757
+ /**
3758
+ * Name of the counterparty, or null if not recorded.
3759
+ */
3760
+ name: string | null;
3761
+ /**
3762
+ * Physical address of the counterparty, or null if not recorded.
3763
+ */
3764
+ physical_address: Payload.PhysicalAddress | null;
3765
+ /**
3766
+ * Resource type discriminator.
3767
+ */
3768
+ type: 'counterparty';
3769
+ }
3770
+ namespace Payload {
3771
+ interface IbanFinancialAddress {
3772
+ /**
3773
+ * Name of the account holder.
3774
+ */
3775
+ account_holder_name: string;
3776
+ /**
3777
+ * Bank Identifier Code, or null if not provided.
3778
+ */
3779
+ bic: string | null;
3780
+ /**
3781
+ * International Bank Account Number.
3782
+ */
3783
+ iban: string;
3784
+ /**
3785
+ * Discriminator for IBAN financial address.
3786
+ */
3787
+ type: 'iban';
3788
+ }
3789
+ interface SortCodeFinancialAddress {
3790
+ /**
3791
+ * Name of the account holder.
3792
+ */
3793
+ account_holder_name: string;
3794
+ /**
3795
+ * UK account number (8 digits).
3796
+ */
3797
+ account_number: string;
3798
+ /**
3799
+ * UK sort code (6 digits).
3800
+ */
3801
+ sort_code: string;
3802
+ /**
3803
+ * Discriminator for UK sort code financial address.
3804
+ */
3805
+ type: 'sort_code';
3806
+ }
3807
+ interface AbaFinancialAddress {
3808
+ /**
3809
+ * Name of the account holder.
3810
+ */
3811
+ account_holder_name: string;
3812
+ /**
3813
+ * Bank account number.
3814
+ */
3815
+ account_number: string;
3816
+ /**
3817
+ * ABA routing number (9 digits).
3818
+ */
3819
+ routing_number: string;
3820
+ /**
3821
+ * Discriminator for ABA wire financial address.
3822
+ */
3823
+ type: 'aba';
3824
+ }
3825
+ interface BicFinancialAddress {
3826
+ /**
3827
+ * Name of the account holder.
3828
+ */
3829
+ account_holder_name: string;
3830
+ /**
3831
+ * Local-format bank account number.
3832
+ */
3833
+ account_number: string;
3834
+ /**
3835
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
3836
+ */
3837
+ bic: string;
3838
+ /**
3839
+ * Domestic bank or branch code where the destination country uses one (for example
3840
+ * the BSB in Australia), or null.
3841
+ */
3842
+ local_bank_code: string | null;
3843
+ /**
3844
+ * Discriminator for BIC + local account financial address.
3845
+ */
3846
+ type: 'bic';
3847
+ }
3848
+ interface CryptoWalletFinancialAddress {
3849
+ /**
3850
+ * Wallet address on the specified blockchain.
3851
+ */
3852
+ address: string;
3853
+ /**
3854
+ * Blockchain network for the crypto wallet.
3855
+ */
3856
+ blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
3857
+ /**
3858
+ * Discriminator for crypto wallet financial address.
3859
+ */
3860
+ type: 'crypto_wallet';
3861
+ }
3862
+ /**
3863
+ * Physical address of the counterparty, or null if not recorded.
3864
+ */
3865
+ interface PhysicalAddress {
3866
+ /**
3867
+ * City or locality.
3868
+ */
3869
+ city: string;
3870
+ /**
3871
+ * ISO 3166-1 alpha-2 country code.
3872
+ */
3873
+ country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
3874
+ /**
3875
+ * Primary street address, or null if not recorded.
3876
+ */
3877
+ line_1: string | null;
3878
+ /**
3879
+ * Secondary street address, or null if not recorded.
3880
+ */
3881
+ line_2: string | null;
3882
+ /**
3883
+ * Postal or ZIP code, or null if not recorded.
3884
+ */
3885
+ postal_code: string | null;
3886
+ /**
3887
+ * State, province, or region, or null if not recorded.
3888
+ */
3889
+ state: string | null;
3890
+ }
3891
+ }
3892
+ }
3893
+ export interface CounterpartyUpdatedWebhookEvent {
3894
+ /**
3895
+ * Unique identifier for the event. Stable across retries.
3896
+ */
3897
+ id: string;
3898
+ /**
3899
+ * API version the payload was rendered at. Stable across retries and redeliveries.
3900
+ */
3901
+ api_version: string;
3902
+ /**
3903
+ * ISO 8601 UTC timestamp when the event was created.
3904
+ */
3905
+ date: string;
3906
+ /**
3907
+ * Full resource snapshot at the time of the event.
3908
+ */
3909
+ payload: CounterpartyUpdatedWebhookEvent.Payload;
3910
+ /**
3911
+ * Event type in resource.action format.
3912
+ */
3913
+ type: 'counterparty.updated';
3914
+ }
3915
+ export declare namespace CounterpartyUpdatedWebhookEvent {
3916
+ /**
3917
+ * Full resource snapshot at the time of the event.
3918
+ */
3919
+ interface Payload {
3920
+ /**
3921
+ * Unique identifier of the counterparty.
3922
+ */
3923
+ id: string;
3924
+ /**
3925
+ * Whether payments to or from this counterparty are currently blocked.
3926
+ */
3927
+ blocked: boolean;
3928
+ /**
3929
+ * Date of birth in YYYY-MM-DD format, or null if not recorded.
3930
+ */
3931
+ date_of_birth: string | null;
3932
+ /**
3933
+ * Whether the counterparty is a business or an individual.
3934
+ */
3935
+ entity_type: 'business' | 'individual';
3936
+ /**
3937
+ * Financial address of the counterparty.
3938
+ */
3939
+ financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
3940
+ /**
3941
+ * Whether the counterparty is self-owned. `false` if the counterparty is not owned
3942
+ * by you, `true` if it is.
3943
+ */
3944
+ is_self_owned: boolean;
3945
+ /**
3946
+ * Set of up to 50 key-value string pairs you can attach to store structured
3947
+ * information, such as correlating this resource with an object in your own
3948
+ * system. Keys may be up to 40 characters and values up to 500 characters.
3949
+ */
3950
+ metadata: {
3951
+ [key: string]: string;
3952
+ };
3953
+ /**
3954
+ * Name of the counterparty, or null if not recorded.
3955
+ */
3956
+ name: string | null;
3957
+ /**
3958
+ * Physical address of the counterparty, or null if not recorded.
3959
+ */
3960
+ physical_address: Payload.PhysicalAddress | null;
3961
+ /**
3962
+ * Resource type discriminator.
3963
+ */
3964
+ type: 'counterparty';
3965
+ }
3966
+ namespace Payload {
3967
+ interface IbanFinancialAddress {
3968
+ /**
3969
+ * Name of the account holder.
3970
+ */
3971
+ account_holder_name: string;
3972
+ /**
3973
+ * Bank Identifier Code, or null if not provided.
3974
+ */
3975
+ bic: string | null;
3976
+ /**
3977
+ * International Bank Account Number.
3978
+ */
3979
+ iban: string;
3980
+ /**
3981
+ * Discriminator for IBAN financial address.
3982
+ */
3983
+ type: 'iban';
3984
+ }
3985
+ interface SortCodeFinancialAddress {
3986
+ /**
3987
+ * Name of the account holder.
3988
+ */
3989
+ account_holder_name: string;
3990
+ /**
3991
+ * UK account number (8 digits).
3992
+ */
3993
+ account_number: string;
3994
+ /**
3995
+ * UK sort code (6 digits).
3996
+ */
3997
+ sort_code: string;
3998
+ /**
3999
+ * Discriminator for UK sort code financial address.
4000
+ */
4001
+ type: 'sort_code';
4002
+ }
4003
+ interface AbaFinancialAddress {
4004
+ /**
4005
+ * Name of the account holder.
4006
+ */
4007
+ account_holder_name: string;
4008
+ /**
4009
+ * Bank account number.
4010
+ */
4011
+ account_number: string;
4012
+ /**
4013
+ * ABA routing number (9 digits).
4014
+ */
4015
+ routing_number: string;
4016
+ /**
4017
+ * Discriminator for ABA wire financial address.
4018
+ */
4019
+ type: 'aba';
4020
+ }
4021
+ interface BicFinancialAddress {
4022
+ /**
4023
+ * Name of the account holder.
4024
+ */
4025
+ account_holder_name: string;
4026
+ /**
4027
+ * Local-format bank account number.
4028
+ */
4029
+ account_number: string;
4030
+ /**
4031
+ * ISO 9362 Bank Identifier Code (8 or 11 characters).
4032
+ */
4033
+ bic: string;
4034
+ /**
4035
+ * Domestic bank or branch code where the destination country uses one (for example
4036
+ * the BSB in Australia), or null.
4037
+ */
4038
+ local_bank_code: string | null;
4039
+ /**
4040
+ * Discriminator for BIC + local account financial address.
4041
+ */
4042
+ type: 'bic';
4043
+ }
4044
+ interface CryptoWalletFinancialAddress {
4045
+ /**
4046
+ * Wallet address on the specified blockchain.
4047
+ */
4048
+ address: string;
4049
+ /**
4050
+ * Blockchain network for the crypto wallet.
4051
+ */
4052
+ blockchain: 'bitcoin' | 'ethereum' | 'solana' | 'polygon' | 'bitcoin_testnet4' | 'ethereum_sepolia' | 'solana_devnet' | 'polygon_amoy';
4053
+ /**
4054
+ * Discriminator for crypto wallet financial address.
4055
+ */
4056
+ type: 'crypto_wallet';
4057
+ }
4058
+ /**
4059
+ * Physical address of the counterparty, or null if not recorded.
4060
+ */
4061
+ interface PhysicalAddress {
4062
+ /**
4063
+ * City or locality.
4064
+ */
4065
+ city: string;
4066
+ /**
4067
+ * ISO 3166-1 alpha-2 country code.
4068
+ */
4069
+ country_code: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
4070
+ /**
4071
+ * Primary street address, or null if not recorded.
4072
+ */
4073
+ line_1: string | null;
4074
+ /**
4075
+ * Secondary street address, or null if not recorded.
4076
+ */
4077
+ line_2: string | null;
4078
+ /**
4079
+ * Postal or ZIP code, or null if not recorded.
4080
+ */
4081
+ postal_code: string | null;
4082
+ /**
4083
+ * State, province, or region, or null if not recorded.
4084
+ */
4085
+ state: string | null;
4086
+ }
4087
+ }
4088
+ }
2841
4089
  export interface PingTestWebhookEvent {
2842
4090
  /**
2843
4091
  * Unique identifier for the event. Stable across retries.
@@ -2888,8 +4136,8 @@ export declare namespace PingTestWebhookEvent {
2888
4136
  type: 'ping';
2889
4137
  }
2890
4138
  }
2891
- export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | PingTestWebhookEvent;
4139
+ export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | CounterpartyCreatedWebhookEvent | CounterpartyVerifiedWebhookEvent | CounterpartyRejectedWebhookEvent | CounterpartyBlockedWebhookEvent | CounterpartyUnblockedWebhookEvent | CounterpartyUpdatedWebhookEvent | PingTestWebhookEvent;
2892
4140
  export declare namespace Webhooks {
2893
- export { type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent, type PayoutSentWebhookEvent as PayoutSentWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent, type ReturnSentWebhookEvent as ReturnSentWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositSettledWebhookEvent as DepositSettledWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, type PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
4141
+ export { type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent, type PayoutSentWebhookEvent as PayoutSentWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent, type ReturnSentWebhookEvent as ReturnSentWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositSettledWebhookEvent as DepositSettledWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, type CounterpartyCreatedWebhookEvent as CounterpartyCreatedWebhookEvent, type CounterpartyVerifiedWebhookEvent as CounterpartyVerifiedWebhookEvent, type CounterpartyRejectedWebhookEvent as CounterpartyRejectedWebhookEvent, type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent, type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent, type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent, type PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
2894
4142
  }
2895
4143
  //# sourceMappingURL=webhooks.d.ts.map