@getivy/node-sdk 2.6.0 → 2.20.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 (232) hide show
  1. package/CHANGELOG.md +164 -0
  2. package/README.md +2 -2
  3. package/api-promise.d.mts +1 -0
  4. package/api-promise.d.mts.map +1 -1
  5. package/api-promise.d.ts +1 -0
  6. package/api-promise.d.ts.map +1 -1
  7. package/api-promise.mjs +1 -0
  8. package/api-promise.mjs.map +1 -1
  9. package/bin/migration-config.json +1 -1
  10. package/client.d.mts +10 -4
  11. package/client.d.mts.map +1 -1
  12. package/client.d.ts +10 -4
  13. package/client.d.ts.map +1 -1
  14. package/client.js +21 -7
  15. package/client.js.map +1 -1
  16. package/client.mjs +21 -7
  17. package/client.mjs.map +1 -1
  18. package/core/api-promise.d.mts.map +1 -1
  19. package/core/api-promise.d.ts.map +1 -1
  20. package/core/api-promise.mjs.map +1 -1
  21. package/core/error.mjs.map +1 -1
  22. package/core/resource.d.mts.map +1 -1
  23. package/core/resource.d.ts.map +1 -1
  24. package/core/uploads.d.mts.map +1 -1
  25. package/core/uploads.d.ts.map +1 -1
  26. package/core/uploads.mjs.map +1 -1
  27. package/error.d.mts +1 -0
  28. package/error.d.mts.map +1 -1
  29. package/error.d.ts +1 -0
  30. package/error.d.ts.map +1 -1
  31. package/error.mjs +1 -0
  32. package/error.mjs.map +1 -1
  33. package/index.d.mts.map +1 -1
  34. package/index.d.ts.map +1 -1
  35. package/index.mjs.map +1 -1
  36. package/internal/detect-platform.mjs.map +1 -1
  37. package/internal/headers.mjs.map +1 -1
  38. package/internal/parse.d.mts.map +1 -1
  39. package/internal/parse.d.ts.map +1 -1
  40. package/internal/parse.mjs.map +1 -1
  41. package/internal/request-options.d.mts.map +1 -1
  42. package/internal/request-options.d.ts.map +1 -1
  43. package/internal/shims.d.mts +6 -0
  44. package/internal/shims.d.mts.map +1 -1
  45. package/internal/shims.d.ts +6 -0
  46. package/internal/shims.d.ts.map +1 -1
  47. package/internal/to-file.d.mts.map +1 -1
  48. package/internal/to-file.d.ts.map +1 -1
  49. package/internal/to-file.mjs.map +1 -1
  50. package/internal/tslib.js +17 -17
  51. package/internal/types.d.mts +4 -4
  52. package/internal/types.d.mts.map +1 -1
  53. package/internal/types.d.ts +4 -4
  54. package/internal/types.d.ts.map +1 -1
  55. package/internal/uploads.d.mts.map +1 -1
  56. package/internal/uploads.d.ts.map +1 -1
  57. package/internal/uploads.mjs.map +1 -1
  58. package/internal/utils/base64.mjs.map +1 -1
  59. package/internal/utils/log.d.mts.map +1 -1
  60. package/internal/utils/log.d.ts.map +1 -1
  61. package/internal/utils/log.js +4 -1
  62. package/internal/utils/log.js.map +1 -1
  63. package/internal/utils/log.mjs +4 -1
  64. package/internal/utils/log.mjs.map +1 -1
  65. package/internal/utils/path.mjs.map +1 -1
  66. package/internal/utils/query.mjs.map +1 -1
  67. package/internal/utils/values.mjs.map +1 -1
  68. package/internal/utils.d.mts.map +1 -1
  69. package/internal/utils.d.ts.map +1 -1
  70. package/internal/utils.mjs.map +1 -1
  71. package/lib/request-signing.d.mts +6 -0
  72. package/lib/request-signing.d.mts.map +1 -0
  73. package/lib/request-signing.d.ts +6 -0
  74. package/lib/request-signing.d.ts.map +1 -0
  75. package/lib/request-signing.js +113 -0
  76. package/lib/request-signing.js.map +1 -0
  77. package/lib/request-signing.mjs +109 -0
  78. package/lib/request-signing.mjs.map +1 -0
  79. package/package.json +16 -4
  80. package/resource.d.mts +1 -0
  81. package/resource.d.mts.map +1 -1
  82. package/resource.d.ts +1 -0
  83. package/resource.d.ts.map +1 -1
  84. package/resource.mjs +1 -0
  85. package/resource.mjs.map +1 -1
  86. package/resources/balance.d.mts.map +1 -1
  87. package/resources/balance.d.ts.map +1 -1
  88. package/resources/balance.mjs.map +1 -1
  89. package/resources/banks.d.mts +12 -14
  90. package/resources/banks.d.mts.map +1 -1
  91. package/resources/banks.d.ts +12 -14
  92. package/resources/banks.d.ts.map +1 -1
  93. package/resources/banks.mjs.map +1 -1
  94. package/resources/beneficiary-payouts.d.mts +2 -2
  95. package/resources/beneficiary-payouts.d.mts.map +1 -1
  96. package/resources/beneficiary-payouts.d.ts +2 -2
  97. package/resources/beneficiary-payouts.d.ts.map +1 -1
  98. package/resources/beneficiary-payouts.mjs.map +1 -1
  99. package/resources/capabilities.d.mts +8 -1
  100. package/resources/capabilities.d.mts.map +1 -1
  101. package/resources/capabilities.d.ts +8 -1
  102. package/resources/capabilities.d.ts.map +1 -1
  103. package/resources/capabilities.js +7 -0
  104. package/resources/capabilities.js.map +1 -1
  105. package/resources/capabilities.mjs +7 -0
  106. package/resources/capabilities.mjs.map +1 -1
  107. package/resources/checkoutsession.d.mts +18 -10
  108. package/resources/checkoutsession.d.mts.map +1 -1
  109. package/resources/checkoutsession.d.ts +18 -10
  110. package/resources/checkoutsession.d.ts.map +1 -1
  111. package/resources/checkoutsession.js +3 -2
  112. package/resources/checkoutsession.js.map +1 -1
  113. package/resources/checkoutsession.mjs +3 -2
  114. package/resources/checkoutsession.mjs.map +1 -1
  115. package/resources/counterparties.d.mts +956 -0
  116. package/resources/counterparties.d.mts.map +1 -0
  117. package/resources/counterparties.d.ts +956 -0
  118. package/resources/counterparties.d.ts.map +1 -0
  119. package/resources/counterparties.js +41 -0
  120. package/resources/counterparties.js.map +1 -0
  121. package/resources/counterparties.mjs +37 -0
  122. package/resources/counterparties.mjs.map +1 -0
  123. package/resources/customers.d.mts +6 -6
  124. package/resources/customers.d.mts.map +1 -1
  125. package/resources/customers.d.ts +6 -6
  126. package/resources/customers.d.ts.map +1 -1
  127. package/resources/customers.mjs.map +1 -1
  128. package/resources/deposits.d.mts +21 -7
  129. package/resources/deposits.d.mts.map +1 -1
  130. package/resources/deposits.d.ts +21 -7
  131. package/resources/deposits.d.ts.map +1 -1
  132. package/resources/deposits.mjs.map +1 -1
  133. package/resources/index.d.mts +1 -1
  134. package/resources/index.d.mts.map +1 -1
  135. package/resources/index.d.ts +1 -1
  136. package/resources/index.d.ts.map +1 -1
  137. package/resources/index.js +3 -3
  138. package/resources/index.js.map +1 -1
  139. package/resources/index.mjs +1 -1
  140. package/resources/index.mjs.map +1 -1
  141. package/resources/orders.d.mts +102 -39
  142. package/resources/orders.d.mts.map +1 -1
  143. package/resources/orders.d.ts +102 -39
  144. package/resources/orders.d.ts.map +1 -1
  145. package/resources/orders.mjs.map +1 -1
  146. package/resources/payee.d.mts.map +1 -1
  147. package/resources/payee.d.ts.map +1 -1
  148. package/resources/payee.mjs.map +1 -1
  149. package/resources/payouts.d.mts +82 -21
  150. package/resources/payouts.d.mts.map +1 -1
  151. package/resources/payouts.d.ts +82 -21
  152. package/resources/payouts.d.ts.map +1 -1
  153. package/resources/payouts.mjs.map +1 -1
  154. package/resources/refunds.d.mts +1 -1
  155. package/resources/refunds.d.mts.map +1 -1
  156. package/resources/refunds.d.ts +1 -1
  157. package/resources/refunds.d.ts.map +1 -1
  158. package/resources/refunds.mjs.map +1 -1
  159. package/resources/returns.d.mts +2 -2
  160. package/resources/returns.d.mts.map +1 -1
  161. package/resources/returns.d.ts +2 -2
  162. package/resources/returns.d.ts.map +1 -1
  163. package/resources/returns.mjs.map +1 -1
  164. package/resources/subaccounts.d.mts +4 -4
  165. package/resources/subaccounts.d.mts.map +1 -1
  166. package/resources/subaccounts.d.ts +4 -4
  167. package/resources/subaccounts.d.ts.map +1 -1
  168. package/resources/subaccounts.mjs.map +1 -1
  169. package/resources/transactions.d.mts +3 -3
  170. package/resources/transactions.d.mts.map +1 -1
  171. package/resources/transactions.d.ts +3 -3
  172. package/resources/transactions.d.ts.map +1 -1
  173. package/resources/transactions.mjs.map +1 -1
  174. package/resources/webhook/index.d.mts.map +1 -1
  175. package/resources/webhook/index.d.ts.map +1 -1
  176. package/resources/webhook/index.mjs.map +1 -1
  177. package/resources/webhook/subscription.d.mts +12 -12
  178. package/resources/webhook/subscription.d.mts.map +1 -1
  179. package/resources/webhook/subscription.d.ts +12 -12
  180. package/resources/webhook/subscription.d.ts.map +1 -1
  181. package/resources/webhook/subscription.mjs.map +1 -1
  182. package/resources/webhook/webhook.d.mts.map +1 -1
  183. package/resources/webhook/webhook.d.ts.map +1 -1
  184. package/resources/webhook/webhook.mjs.map +1 -1
  185. package/resources/webhook.d.mts.map +1 -1
  186. package/resources/webhook.d.ts.map +1 -1
  187. package/resources/webhook.mjs.map +1 -1
  188. package/resources.d.mts.map +1 -1
  189. package/resources.d.ts.map +1 -1
  190. package/resources.mjs.map +1 -1
  191. package/src/client.ts +51 -22
  192. package/src/internal/utils/log.ts +3 -0
  193. package/src/lib/request-signing.ts +139 -0
  194. package/src/resources/banks.ts +21 -11
  195. package/src/resources/beneficiary-payouts.ts +2 -2
  196. package/src/resources/capabilities.ts +8 -1
  197. package/src/resources/checkoutsession.ts +31 -10
  198. package/src/resources/counterparties.ts +3073 -0
  199. package/src/resources/customers.ts +3509 -3509
  200. package/src/resources/deposits.ts +52 -6
  201. package/src/resources/index.ts +13 -9
  202. package/src/resources/orders.ts +222 -36
  203. package/src/resources/payouts.ts +396 -17
  204. package/src/resources/refunds.ts +1 -1
  205. package/src/resources/returns.ts +2 -2
  206. package/src/resources/subaccounts.ts +4 -4
  207. package/src/resources/transactions.ts +5 -2
  208. package/src/resources/webhook/subscription.ts +37 -12
  209. package/src/version.ts +1 -1
  210. package/uploads.d.mts +1 -0
  211. package/uploads.d.mts.map +1 -1
  212. package/uploads.d.ts +1 -0
  213. package/uploads.d.ts.map +1 -1
  214. package/uploads.mjs +1 -0
  215. package/uploads.mjs.map +1 -1
  216. package/version.d.mts +1 -1
  217. package/version.d.mts.map +1 -1
  218. package/version.d.ts +1 -1
  219. package/version.d.ts.map +1 -1
  220. package/version.js +1 -1
  221. package/version.js.map +1 -1
  222. package/version.mjs +1 -1
  223. package/version.mjs.map +1 -1
  224. package/resources/fx.d.mts +0 -155
  225. package/resources/fx.d.mts.map +0 -1
  226. package/resources/fx.d.ts +0 -155
  227. package/resources/fx.d.ts.map +0 -1
  228. package/resources/fx.js +0 -28
  229. package/resources/fx.js.map +0 -1
  230. package/resources/fx.mjs +0 -24
  231. package/resources/fx.mjs.map +0 -1
  232. package/src/resources/fx.ts +0 -195
@@ -0,0 +1,956 @@
1
+ import { APIResource } from "../core/resource.mjs";
2
+ import { APIPromise } from "../core/api-promise.mjs";
3
+ import { RequestOptions } from "../internal/request-options.mjs";
4
+ export declare class Counterparties extends APIResource {
5
+ /**
6
+ * Create a counterparty owned by the merchant.
7
+ */
8
+ create(body: CounterpartyCreateParams, options?: RequestOptions): APIPromise<Counterparty>;
9
+ /**
10
+ * Retrieve a counterparty by id.
11
+ */
12
+ retrieve(body: CounterpartyRetrieveParams, options?: RequestOptions): APIPromise<CounterpartyRetrieveResponse>;
13
+ /**
14
+ * Update the mutable details of a counterparty owned by the merchant.
15
+ */
16
+ update(body: CounterpartyUpdateParams, options?: RequestOptions): APIPromise<CounterpartyUpdateResponse>;
17
+ /**
18
+ * List counterparties owned by the merchant.
19
+ */
20
+ list(body: CounterpartyListParams, options?: RequestOptions): APIPromise<CounterpartyListResponse>;
21
+ /**
22
+ * Activate a pending counterparty owned by the merchant. A fiat counterparty
23
+ * becomes active immediately; a crypto counterparty starts verification and stays
24
+ * pending until it concludes.
25
+ */
26
+ activate(body: CounterpartyActivateParams, options?: RequestOptions): APIPromise<CounterpartyActivateResponse>;
27
+ }
28
+ export interface Counterparty {
29
+ /**
30
+ * The counterparty id
31
+ */
32
+ id: string;
33
+ /**
34
+ * Whether payments to and from the counterparty are blocked
35
+ */
36
+ blocked: boolean;
37
+ /**
38
+ * When the counterparty was created
39
+ */
40
+ createdAt: string;
41
+ /**
42
+ * The counterparty date of birth as YYYY-MM-DD
43
+ */
44
+ dateOfBirth: string | null;
45
+ /**
46
+ * Whether the counterparty is an individual, business, sole proprietor or
47
+ * non-profit
48
+ */
49
+ entityType: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
50
+ /**
51
+ * The counterparty financial address
52
+ */
53
+ financialAddress: Counterparty.FinancialAddress;
54
+ /**
55
+ * Whether the counterparty is owned by the merchant
56
+ */
57
+ isSelfOwned: boolean;
58
+ /**
59
+ * The counterparty metadata
60
+ */
61
+ metadata: {
62
+ [key: string]: string;
63
+ };
64
+ /**
65
+ * The counterparty name
66
+ */
67
+ name: string | null;
68
+ /**
69
+ * The counterparty physical address
70
+ */
71
+ physicalAddress: Counterparty.PhysicalAddress | null;
72
+ /**
73
+ * The counterparty lifecycle status
74
+ */
75
+ status: 'pending' | 'active' | 'rejected';
76
+ /**
77
+ * When the counterparty was last updated
78
+ */
79
+ updatedAt: string;
80
+ }
81
+ export declare namespace Counterparty {
82
+ /**
83
+ * The counterparty financial address
84
+ */
85
+ interface FinancialAddress {
86
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba' | 'bic';
87
+ aba?: FinancialAddress.Aba;
88
+ bankCode?: FinancialAddress.BankCode;
89
+ bban?: FinancialAddress.Bban;
90
+ bic?: FinancialAddress.Bic;
91
+ iban?: FinancialAddress.Iban;
92
+ sortCode?: FinancialAddress.SortCode;
93
+ wallet?: FinancialAddress.Wallet;
94
+ }
95
+ namespace FinancialAddress {
96
+ interface Aba {
97
+ accountHolderName: string;
98
+ accountNumber: string;
99
+ routingNumber: string;
100
+ }
101
+ interface BankCode {
102
+ accountHolderName: string;
103
+ accountNumber: string;
104
+ code: string;
105
+ }
106
+ interface Bban {
107
+ accountHolderName: string;
108
+ bban: string;
109
+ bic?: string;
110
+ }
111
+ interface Bic {
112
+ accountHolderName: string;
113
+ accountNumber: string;
114
+ bic: string;
115
+ localBankCode?: string;
116
+ }
117
+ interface Iban {
118
+ accountHolderName: string;
119
+ iban: string;
120
+ bic?: string;
121
+ }
122
+ interface SortCode {
123
+ accountHolderName: string;
124
+ accountNumber: string;
125
+ sortCode: string;
126
+ }
127
+ interface Wallet {
128
+ /**
129
+ * The blockchain wallet address
130
+ */
131
+ address: string;
132
+ /**
133
+ * The blockchain network
134
+ */
135
+ blockchain: 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
136
+ }
137
+ }
138
+ /**
139
+ * The counterparty physical address
140
+ */
141
+ interface PhysicalAddress {
142
+ /**
143
+ * City or locality.
144
+ */
145
+ city: string;
146
+ /**
147
+ * ISO 3166-1 alpha-2 country code.
148
+ */
149
+ countryCode: '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';
150
+ /**
151
+ * Primary street address line.
152
+ */
153
+ line1?: string;
154
+ /**
155
+ * Secondary street address line.
156
+ */
157
+ line2?: string;
158
+ /**
159
+ * Postal or ZIP code.
160
+ */
161
+ postalCode?: string;
162
+ /**
163
+ * State, province, or region.
164
+ */
165
+ state?: string;
166
+ }
167
+ }
168
+ export interface CounterpartyRetrieveResponse {
169
+ /**
170
+ * The counterparty id
171
+ */
172
+ id: string;
173
+ /**
174
+ * Whether payments to and from the counterparty are blocked
175
+ */
176
+ blocked: boolean;
177
+ /**
178
+ * When the counterparty was created
179
+ */
180
+ createdAt: string;
181
+ /**
182
+ * The counterparty date of birth as YYYY-MM-DD
183
+ */
184
+ dateOfBirth: string | null;
185
+ /**
186
+ * Whether the counterparty is an individual, business, sole proprietor or
187
+ * non-profit
188
+ */
189
+ entityType: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
190
+ /**
191
+ * The counterparty financial address
192
+ */
193
+ financialAddress: CounterpartyRetrieveResponse.FinancialAddress;
194
+ /**
195
+ * Whether the counterparty is owned by the merchant
196
+ */
197
+ isSelfOwned: boolean;
198
+ /**
199
+ * The counterparty metadata
200
+ */
201
+ metadata: {
202
+ [key: string]: string;
203
+ };
204
+ /**
205
+ * The counterparty name
206
+ */
207
+ name: string | null;
208
+ /**
209
+ * The counterparty physical address
210
+ */
211
+ physicalAddress: CounterpartyRetrieveResponse.PhysicalAddress | null;
212
+ /**
213
+ * The counterparty lifecycle status
214
+ */
215
+ status: 'pending' | 'active' | 'rejected';
216
+ /**
217
+ * When the counterparty was last updated
218
+ */
219
+ updatedAt: string;
220
+ }
221
+ export declare namespace CounterpartyRetrieveResponse {
222
+ /**
223
+ * The counterparty financial address
224
+ */
225
+ interface FinancialAddress {
226
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba' | 'bic';
227
+ aba?: FinancialAddress.Aba;
228
+ bankCode?: FinancialAddress.BankCode;
229
+ bban?: FinancialAddress.Bban;
230
+ bic?: FinancialAddress.Bic;
231
+ iban?: FinancialAddress.Iban;
232
+ sortCode?: FinancialAddress.SortCode;
233
+ wallet?: FinancialAddress.Wallet;
234
+ }
235
+ namespace FinancialAddress {
236
+ interface Aba {
237
+ accountHolderName: string;
238
+ accountNumber: string;
239
+ routingNumber: string;
240
+ }
241
+ interface BankCode {
242
+ accountHolderName: string;
243
+ accountNumber: string;
244
+ code: string;
245
+ }
246
+ interface Bban {
247
+ accountHolderName: string;
248
+ bban: string;
249
+ bic?: string;
250
+ }
251
+ interface Bic {
252
+ accountHolderName: string;
253
+ accountNumber: string;
254
+ bic: string;
255
+ localBankCode?: string;
256
+ }
257
+ interface Iban {
258
+ accountHolderName: string;
259
+ iban: string;
260
+ bic?: string;
261
+ }
262
+ interface SortCode {
263
+ accountHolderName: string;
264
+ accountNumber: string;
265
+ sortCode: string;
266
+ }
267
+ interface Wallet {
268
+ /**
269
+ * The blockchain wallet address
270
+ */
271
+ address: string;
272
+ /**
273
+ * The blockchain network
274
+ */
275
+ blockchain: 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
276
+ }
277
+ }
278
+ /**
279
+ * The counterparty physical address
280
+ */
281
+ interface PhysicalAddress {
282
+ /**
283
+ * City or locality.
284
+ */
285
+ city: string;
286
+ /**
287
+ * ISO 3166-1 alpha-2 country code.
288
+ */
289
+ countryCode: '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';
290
+ /**
291
+ * Primary street address line.
292
+ */
293
+ line1?: string;
294
+ /**
295
+ * Secondary street address line.
296
+ */
297
+ line2?: string;
298
+ /**
299
+ * Postal or ZIP code.
300
+ */
301
+ postalCode?: string;
302
+ /**
303
+ * State, province, or region.
304
+ */
305
+ state?: string;
306
+ }
307
+ }
308
+ export interface CounterpartyUpdateResponse {
309
+ /**
310
+ * The counterparty id
311
+ */
312
+ id: string;
313
+ /**
314
+ * Whether payments to and from the counterparty are blocked
315
+ */
316
+ blocked: boolean;
317
+ /**
318
+ * When the counterparty was created
319
+ */
320
+ createdAt: string;
321
+ /**
322
+ * The counterparty date of birth as YYYY-MM-DD
323
+ */
324
+ dateOfBirth: string | null;
325
+ /**
326
+ * Whether the counterparty is an individual, business, sole proprietor or
327
+ * non-profit
328
+ */
329
+ entityType: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
330
+ /**
331
+ * The counterparty financial address
332
+ */
333
+ financialAddress: CounterpartyUpdateResponse.FinancialAddress;
334
+ /**
335
+ * Whether the counterparty is owned by the merchant
336
+ */
337
+ isSelfOwned: boolean;
338
+ /**
339
+ * The counterparty metadata
340
+ */
341
+ metadata: {
342
+ [key: string]: string;
343
+ };
344
+ /**
345
+ * The counterparty name
346
+ */
347
+ name: string | null;
348
+ /**
349
+ * The counterparty physical address
350
+ */
351
+ physicalAddress: CounterpartyUpdateResponse.PhysicalAddress | null;
352
+ /**
353
+ * The counterparty lifecycle status
354
+ */
355
+ status: 'pending' | 'active' | 'rejected';
356
+ /**
357
+ * When the counterparty was last updated
358
+ */
359
+ updatedAt: string;
360
+ }
361
+ export declare namespace CounterpartyUpdateResponse {
362
+ /**
363
+ * The counterparty financial address
364
+ */
365
+ interface FinancialAddress {
366
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba' | 'bic';
367
+ aba?: FinancialAddress.Aba;
368
+ bankCode?: FinancialAddress.BankCode;
369
+ bban?: FinancialAddress.Bban;
370
+ bic?: FinancialAddress.Bic;
371
+ iban?: FinancialAddress.Iban;
372
+ sortCode?: FinancialAddress.SortCode;
373
+ wallet?: FinancialAddress.Wallet;
374
+ }
375
+ namespace FinancialAddress {
376
+ interface Aba {
377
+ accountHolderName: string;
378
+ accountNumber: string;
379
+ routingNumber: string;
380
+ }
381
+ interface BankCode {
382
+ accountHolderName: string;
383
+ accountNumber: string;
384
+ code: string;
385
+ }
386
+ interface Bban {
387
+ accountHolderName: string;
388
+ bban: string;
389
+ bic?: string;
390
+ }
391
+ interface Bic {
392
+ accountHolderName: string;
393
+ accountNumber: string;
394
+ bic: string;
395
+ localBankCode?: string;
396
+ }
397
+ interface Iban {
398
+ accountHolderName: string;
399
+ iban: string;
400
+ bic?: string;
401
+ }
402
+ interface SortCode {
403
+ accountHolderName: string;
404
+ accountNumber: string;
405
+ sortCode: string;
406
+ }
407
+ interface Wallet {
408
+ /**
409
+ * The blockchain wallet address
410
+ */
411
+ address: string;
412
+ /**
413
+ * The blockchain network
414
+ */
415
+ blockchain: 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
416
+ }
417
+ }
418
+ /**
419
+ * The counterparty physical address
420
+ */
421
+ interface PhysicalAddress {
422
+ /**
423
+ * City or locality.
424
+ */
425
+ city: string;
426
+ /**
427
+ * ISO 3166-1 alpha-2 country code.
428
+ */
429
+ countryCode: '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';
430
+ /**
431
+ * Primary street address line.
432
+ */
433
+ line1?: string;
434
+ /**
435
+ * Secondary street address line.
436
+ */
437
+ line2?: string;
438
+ /**
439
+ * Postal or ZIP code.
440
+ */
441
+ postalCode?: string;
442
+ /**
443
+ * State, province, or region.
444
+ */
445
+ state?: string;
446
+ }
447
+ }
448
+ export interface CounterpartyListResponse {
449
+ /**
450
+ * The list of counterparties
451
+ */
452
+ data: Array<CounterpartyListResponse.Data>;
453
+ /**
454
+ * Pagination information
455
+ */
456
+ paging: CounterpartyListResponse.Paging;
457
+ }
458
+ export declare namespace CounterpartyListResponse {
459
+ interface Data {
460
+ /**
461
+ * The counterparty id
462
+ */
463
+ id: string;
464
+ /**
465
+ * Whether payments to and from the counterparty are blocked
466
+ */
467
+ blocked: boolean;
468
+ /**
469
+ * When the counterparty was created
470
+ */
471
+ createdAt: string;
472
+ /**
473
+ * The counterparty date of birth as YYYY-MM-DD
474
+ */
475
+ dateOfBirth: string | null;
476
+ /**
477
+ * Whether the counterparty is an individual, business, sole proprietor or
478
+ * non-profit
479
+ */
480
+ entityType: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
481
+ /**
482
+ * The counterparty financial address
483
+ */
484
+ financialAddress: Data.FinancialAddress;
485
+ /**
486
+ * Whether the counterparty is owned by the merchant
487
+ */
488
+ isSelfOwned: boolean;
489
+ /**
490
+ * The counterparty metadata
491
+ */
492
+ metadata: {
493
+ [key: string]: string;
494
+ };
495
+ /**
496
+ * The counterparty name
497
+ */
498
+ name: string | null;
499
+ /**
500
+ * The counterparty physical address
501
+ */
502
+ physicalAddress: Data.PhysicalAddress | null;
503
+ /**
504
+ * The counterparty lifecycle status
505
+ */
506
+ status: 'pending' | 'active' | 'rejected';
507
+ /**
508
+ * When the counterparty was last updated
509
+ */
510
+ updatedAt: string;
511
+ }
512
+ namespace Data {
513
+ /**
514
+ * The counterparty financial address
515
+ */
516
+ interface FinancialAddress {
517
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba' | 'bic';
518
+ aba?: FinancialAddress.Aba;
519
+ bankCode?: FinancialAddress.BankCode;
520
+ bban?: FinancialAddress.Bban;
521
+ bic?: FinancialAddress.Bic;
522
+ iban?: FinancialAddress.Iban;
523
+ sortCode?: FinancialAddress.SortCode;
524
+ wallet?: FinancialAddress.Wallet;
525
+ }
526
+ namespace FinancialAddress {
527
+ interface Aba {
528
+ accountHolderName: string;
529
+ accountNumber: string;
530
+ routingNumber: string;
531
+ }
532
+ interface BankCode {
533
+ accountHolderName: string;
534
+ accountNumber: string;
535
+ code: string;
536
+ }
537
+ interface Bban {
538
+ accountHolderName: string;
539
+ bban: string;
540
+ bic?: string;
541
+ }
542
+ interface Bic {
543
+ accountHolderName: string;
544
+ accountNumber: string;
545
+ bic: string;
546
+ localBankCode?: string;
547
+ }
548
+ interface Iban {
549
+ accountHolderName: string;
550
+ iban: string;
551
+ bic?: string;
552
+ }
553
+ interface SortCode {
554
+ accountHolderName: string;
555
+ accountNumber: string;
556
+ sortCode: string;
557
+ }
558
+ interface Wallet {
559
+ /**
560
+ * The blockchain wallet address
561
+ */
562
+ address: string;
563
+ /**
564
+ * The blockchain network
565
+ */
566
+ blockchain: 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
567
+ }
568
+ }
569
+ /**
570
+ * The counterparty physical address
571
+ */
572
+ interface PhysicalAddress {
573
+ /**
574
+ * City or locality.
575
+ */
576
+ city: string;
577
+ /**
578
+ * ISO 3166-1 alpha-2 country code.
579
+ */
580
+ countryCode: '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';
581
+ /**
582
+ * Primary street address line.
583
+ */
584
+ line1?: string;
585
+ /**
586
+ * Secondary street address line.
587
+ */
588
+ line2?: string;
589
+ /**
590
+ * Postal or ZIP code.
591
+ */
592
+ postalCode?: string;
593
+ /**
594
+ * State, province, or region.
595
+ */
596
+ state?: string;
597
+ }
598
+ }
599
+ /**
600
+ * Pagination information
601
+ */
602
+ interface Paging {
603
+ /**
604
+ * Whether more counterparties are available
605
+ */
606
+ hasNext: boolean;
607
+ /**
608
+ * Cursor for the next page of results
609
+ */
610
+ nextCursor?: string;
611
+ }
612
+ }
613
+ export interface CounterpartyActivateResponse {
614
+ /**
615
+ * The counterparty id
616
+ */
617
+ id: string;
618
+ /**
619
+ * Whether payments to and from the counterparty are blocked
620
+ */
621
+ blocked: boolean;
622
+ /**
623
+ * When the counterparty was created
624
+ */
625
+ createdAt: string;
626
+ /**
627
+ * The counterparty date of birth as YYYY-MM-DD
628
+ */
629
+ dateOfBirth: string | null;
630
+ /**
631
+ * Whether the counterparty is an individual, business, sole proprietor or
632
+ * non-profit
633
+ */
634
+ entityType: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
635
+ /**
636
+ * The counterparty financial address
637
+ */
638
+ financialAddress: CounterpartyActivateResponse.FinancialAddress;
639
+ /**
640
+ * Whether the counterparty is owned by the merchant
641
+ */
642
+ isSelfOwned: boolean;
643
+ /**
644
+ * The counterparty metadata
645
+ */
646
+ metadata: {
647
+ [key: string]: string;
648
+ };
649
+ /**
650
+ * The counterparty name
651
+ */
652
+ name: string | null;
653
+ /**
654
+ * The counterparty physical address
655
+ */
656
+ physicalAddress: CounterpartyActivateResponse.PhysicalAddress | null;
657
+ /**
658
+ * The counterparty lifecycle status
659
+ */
660
+ status: 'pending' | 'active' | 'rejected';
661
+ /**
662
+ * When the counterparty was last updated
663
+ */
664
+ updatedAt: string;
665
+ }
666
+ export declare namespace CounterpartyActivateResponse {
667
+ /**
668
+ * The counterparty financial address
669
+ */
670
+ interface FinancialAddress {
671
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba' | 'bic';
672
+ aba?: FinancialAddress.Aba;
673
+ bankCode?: FinancialAddress.BankCode;
674
+ bban?: FinancialAddress.Bban;
675
+ bic?: FinancialAddress.Bic;
676
+ iban?: FinancialAddress.Iban;
677
+ sortCode?: FinancialAddress.SortCode;
678
+ wallet?: FinancialAddress.Wallet;
679
+ }
680
+ namespace FinancialAddress {
681
+ interface Aba {
682
+ accountHolderName: string;
683
+ accountNumber: string;
684
+ routingNumber: string;
685
+ }
686
+ interface BankCode {
687
+ accountHolderName: string;
688
+ accountNumber: string;
689
+ code: string;
690
+ }
691
+ interface Bban {
692
+ accountHolderName: string;
693
+ bban: string;
694
+ bic?: string;
695
+ }
696
+ interface Bic {
697
+ accountHolderName: string;
698
+ accountNumber: string;
699
+ bic: string;
700
+ localBankCode?: string;
701
+ }
702
+ interface Iban {
703
+ accountHolderName: string;
704
+ iban: string;
705
+ bic?: string;
706
+ }
707
+ interface SortCode {
708
+ accountHolderName: string;
709
+ accountNumber: string;
710
+ sortCode: string;
711
+ }
712
+ interface Wallet {
713
+ /**
714
+ * The blockchain wallet address
715
+ */
716
+ address: string;
717
+ /**
718
+ * The blockchain network
719
+ */
720
+ blockchain: 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
721
+ }
722
+ }
723
+ /**
724
+ * The counterparty physical address
725
+ */
726
+ interface PhysicalAddress {
727
+ /**
728
+ * City or locality.
729
+ */
730
+ city: string;
731
+ /**
732
+ * ISO 3166-1 alpha-2 country code.
733
+ */
734
+ countryCode: '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';
735
+ /**
736
+ * Primary street address line.
737
+ */
738
+ line1?: string;
739
+ /**
740
+ * Secondary street address line.
741
+ */
742
+ line2?: string;
743
+ /**
744
+ * Postal or ZIP code.
745
+ */
746
+ postalCode?: string;
747
+ /**
748
+ * State, province, or region.
749
+ */
750
+ state?: string;
751
+ }
752
+ }
753
+ export interface CounterpartyCreateParams {
754
+ /**
755
+ * The counterparty financial address
756
+ */
757
+ financialAddress: CounterpartyCreateParams.FinancialAddress;
758
+ /**
759
+ * The counterparty date of birth as YYYY-MM-DD
760
+ */
761
+ dateOfBirth?: string;
762
+ /**
763
+ * Whether the counterparty is an individual, business, sole proprietor or
764
+ * non-profit
765
+ */
766
+ entityType?: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
767
+ /**
768
+ * Whether the counterparty is owned by the merchant
769
+ */
770
+ isSelfOwned?: boolean;
771
+ /**
772
+ * The counterparty metadata
773
+ */
774
+ metadata?: {
775
+ [key: string]: string;
776
+ };
777
+ /**
778
+ * The counterparty name
779
+ */
780
+ name?: string;
781
+ /**
782
+ * The counterparty physical address
783
+ */
784
+ physicalAddress?: CounterpartyCreateParams.PhysicalAddress;
785
+ }
786
+ export declare namespace CounterpartyCreateParams {
787
+ /**
788
+ * The counterparty financial address
789
+ */
790
+ interface FinancialAddress {
791
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba' | 'bic';
792
+ aba?: FinancialAddress.Aba;
793
+ bankCode?: FinancialAddress.BankCode;
794
+ bban?: FinancialAddress.Bban;
795
+ bic?: FinancialAddress.Bic;
796
+ iban?: FinancialAddress.Iban;
797
+ sortCode?: FinancialAddress.SortCode;
798
+ wallet?: FinancialAddress.Wallet;
799
+ }
800
+ namespace FinancialAddress {
801
+ interface Aba {
802
+ accountHolderName: string;
803
+ accountNumber: string;
804
+ routingNumber: string;
805
+ }
806
+ interface BankCode {
807
+ accountHolderName: string;
808
+ accountNumber: string;
809
+ code: string;
810
+ }
811
+ interface Bban {
812
+ accountHolderName: string;
813
+ bban: string;
814
+ bic?: string;
815
+ }
816
+ interface Bic {
817
+ accountHolderName: string;
818
+ accountNumber: string;
819
+ bic: string;
820
+ localBankCode?: string;
821
+ }
822
+ interface Iban {
823
+ accountHolderName: string;
824
+ iban: string;
825
+ bic?: string;
826
+ }
827
+ interface SortCode {
828
+ accountHolderName: string;
829
+ accountNumber: string;
830
+ sortCode: string;
831
+ }
832
+ interface Wallet {
833
+ /**
834
+ * The blockchain wallet address
835
+ */
836
+ address: string;
837
+ /**
838
+ * The blockchain network
839
+ */
840
+ blockchain: 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
841
+ }
842
+ }
843
+ /**
844
+ * The counterparty physical address
845
+ */
846
+ interface PhysicalAddress {
847
+ /**
848
+ * City or locality.
849
+ */
850
+ city: string;
851
+ /**
852
+ * ISO 3166-1 alpha-2 country code.
853
+ */
854
+ countryCode: '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';
855
+ /**
856
+ * Primary street address line.
857
+ */
858
+ line1?: string;
859
+ /**
860
+ * Secondary street address line.
861
+ */
862
+ line2?: string;
863
+ /**
864
+ * Postal or ZIP code.
865
+ */
866
+ postalCode?: string;
867
+ /**
868
+ * State, province, or region.
869
+ */
870
+ state?: string;
871
+ }
872
+ }
873
+ export interface CounterpartyRetrieveParams {
874
+ /**
875
+ * The counterparty id
876
+ */
877
+ id: string;
878
+ }
879
+ export interface CounterpartyUpdateParams {
880
+ /**
881
+ * The counterparty id
882
+ */
883
+ id: string;
884
+ /**
885
+ * The counterparty date of birth as YYYY-MM-DD. Pass null to clear.
886
+ */
887
+ dateOfBirth?: string | null;
888
+ /**
889
+ * Whether the counterparty is an individual, business, sole proprietor or
890
+ * non-profit
891
+ */
892
+ entityType?: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
893
+ /**
894
+ * Whether the counterparty is owned by the merchant
895
+ */
896
+ isSelfOwned?: boolean;
897
+ /**
898
+ * The counterparty name. Pass null to clear.
899
+ */
900
+ name?: string | null;
901
+ /**
902
+ * The counterparty physical address. Pass null to clear.
903
+ */
904
+ physicalAddress?: CounterpartyUpdateParams.PhysicalAddress | null;
905
+ }
906
+ export declare namespace CounterpartyUpdateParams {
907
+ /**
908
+ * The counterparty physical address. Pass null to clear.
909
+ */
910
+ interface PhysicalAddress {
911
+ /**
912
+ * City or locality.
913
+ */
914
+ city: string;
915
+ /**
916
+ * ISO 3166-1 alpha-2 country code.
917
+ */
918
+ countryCode: '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';
919
+ /**
920
+ * Primary street address line.
921
+ */
922
+ line1?: string;
923
+ /**
924
+ * Secondary street address line.
925
+ */
926
+ line2?: string;
927
+ /**
928
+ * Postal or ZIP code.
929
+ */
930
+ postalCode?: string;
931
+ /**
932
+ * State, province, or region.
933
+ */
934
+ state?: string;
935
+ }
936
+ }
937
+ export interface CounterpartyListParams {
938
+ /**
939
+ * Cursor for pagination
940
+ */
941
+ afterCursor?: string;
942
+ /**
943
+ * Maximum number of counterparties to return
944
+ */
945
+ limit?: number;
946
+ }
947
+ export interface CounterpartyActivateParams {
948
+ /**
949
+ * The counterparty id
950
+ */
951
+ id: string;
952
+ }
953
+ export declare namespace Counterparties {
954
+ export { type Counterparty as Counterparty, type CounterpartyRetrieveResponse as CounterpartyRetrieveResponse, type CounterpartyUpdateResponse as CounterpartyUpdateResponse, type CounterpartyListResponse as CounterpartyListResponse, type CounterpartyActivateResponse as CounterpartyActivateResponse, type CounterpartyCreateParams as CounterpartyCreateParams, type CounterpartyRetrieveParams as CounterpartyRetrieveParams, type CounterpartyUpdateParams as CounterpartyUpdateParams, type CounterpartyListParams as CounterpartyListParams, type CounterpartyActivateParams as CounterpartyActivateParams, };
955
+ }
956
+ //# sourceMappingURL=counterparties.d.mts.map