@augustusbank/typescript-sdk 0.21.0 → 0.22.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/client.d.mts +12 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +12 -6
- package/client.d.ts.map +1 -1
- package/client.js +6 -0
- package/client.js.map +1 -1
- package/client.mjs +6 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/account-holders.d.mts +1555 -1184
- package/resources/account-holders.d.mts.map +1 -1
- package/resources/account-holders.d.ts +1555 -1184
- package/resources/account-holders.d.ts.map +1 -1
- package/resources/account-holders.js +59 -0
- package/resources/account-holders.js.map +1 -1
- package/resources/account-holders.mjs +59 -0
- package/resources/account-holders.mjs.map +1 -1
- package/resources/account-programs.d.mts +22 -17
- package/resources/account-programs.d.mts.map +1 -1
- package/resources/account-programs.d.ts +22 -17
- package/resources/account-programs.d.ts.map +1 -1
- package/resources/account-programs.js +2 -2
- package/resources/account-programs.js.map +1 -1
- package/resources/account-programs.mjs +2 -2
- package/resources/account-programs.mjs.map +1 -1
- package/resources/accounts.d.mts +226 -48
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +226 -48
- package/resources/accounts.d.ts.map +1 -1
- package/resources/accounts.js +55 -2
- package/resources/accounts.js.map +1 -1
- package/resources/accounts.mjs +55 -2
- package/resources/accounts.mjs.map +1 -1
- package/resources/api-keys.d.mts +1 -1
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +1 -1
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/api-versions.d.mts +3 -0
- package/resources/api-versions.d.mts.map +1 -1
- package/resources/api-versions.d.ts +3 -0
- package/resources/api-versions.d.ts.map +1 -1
- package/resources/conversions.d.mts +36 -81
- package/resources/conversions.d.mts.map +1 -1
- package/resources/conversions.d.ts +36 -81
- package/resources/conversions.d.ts.map +1 -1
- package/resources/conversions.js +25 -1
- package/resources/conversions.js.map +1 -1
- package/resources/conversions.mjs +25 -1
- package/resources/conversions.mjs.map +1 -1
- package/resources/counterparties.d.mts +1042 -0
- package/resources/counterparties.d.mts.map +1 -0
- package/resources/counterparties.d.ts +1042 -0
- package/resources/counterparties.d.ts.map +1 -0
- package/resources/counterparties.js +45 -0
- package/resources/counterparties.js.map +1 -0
- package/resources/counterparties.mjs +41 -0
- package/resources/counterparties.mjs.map +1 -0
- package/resources/deposits.d.mts +48 -186
- package/resources/deposits.d.mts.map +1 -1
- package/resources/deposits.d.ts +48 -186
- package/resources/deposits.d.ts.map +1 -1
- package/resources/events.d.mts +3 -3
- package/resources/events.d.mts.map +1 -1
- package/resources/events.d.ts +3 -3
- package/resources/events.d.ts.map +1 -1
- package/resources/index.d.mts +5 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -0
- package/resources/index.mjs.map +1 -1
- package/resources/payouts.d.mts +133 -335
- package/resources/payouts.d.mts.map +1 -1
- package/resources/payouts.d.ts +133 -335
- package/resources/payouts.d.ts.map +1 -1
- package/resources/payouts.js +25 -0
- package/resources/payouts.js.map +1 -1
- package/resources/payouts.mjs +25 -0
- package/resources/payouts.mjs.map +1 -1
- package/resources/quotes/indicative.d.mts +7 -11
- package/resources/quotes/indicative.d.mts.map +1 -1
- package/resources/quotes/indicative.d.ts +7 -11
- package/resources/quotes/indicative.d.ts.map +1 -1
- package/resources/quotes/quotes.d.mts +4 -8
- package/resources/quotes/quotes.d.mts.map +1 -1
- package/resources/quotes/quotes.d.ts +4 -8
- package/resources/quotes/quotes.d.ts.map +1 -1
- package/resources/quotes/quotes.js.map +1 -1
- package/resources/quotes/quotes.mjs.map +1 -1
- package/resources/returns.d.mts +84 -39
- package/resources/returns.d.mts.map +1 -1
- package/resources/returns.d.ts +84 -39
- package/resources/returns.d.ts.map +1 -1
- package/resources/returns.js +22 -0
- package/resources/returns.js.map +1 -1
- package/resources/returns.mjs +22 -0
- package/resources/returns.mjs.map +1 -1
- package/resources/scopes.d.mts +4 -1
- package/resources/scopes.d.mts.map +1 -1
- package/resources/scopes.d.ts +4 -1
- package/resources/scopes.d.ts.map +1 -1
- package/resources/simulations/account-programs.d.mts +215 -0
- package/resources/simulations/account-programs.d.mts.map +1 -0
- package/resources/simulations/account-programs.d.ts +215 -0
- package/resources/simulations/account-programs.d.ts.map +1 -0
- package/resources/simulations/account-programs.js +96 -0
- package/resources/simulations/account-programs.js.map +1 -0
- package/resources/simulations/account-programs.mjs +92 -0
- package/resources/simulations/account-programs.mjs.map +1 -0
- package/resources/simulations/accounts.d.mts +209 -0
- package/resources/simulations/accounts.d.mts.map +1 -0
- package/resources/simulations/accounts.d.ts +209 -0
- package/resources/simulations/accounts.d.ts.map +1 -0
- package/resources/simulations/accounts.js +90 -0
- package/resources/simulations/accounts.js.map +1 -0
- package/resources/simulations/accounts.mjs +86 -0
- package/resources/simulations/accounts.mjs.map +1 -0
- package/resources/simulations/conversions.d.mts +54 -0
- package/resources/simulations/conversions.d.mts.map +1 -0
- package/resources/simulations/conversions.d.ts +54 -0
- package/resources/simulations/conversions.d.ts.map +1 -0
- package/resources/simulations/conversions.js +39 -0
- package/resources/simulations/conversions.js.map +1 -0
- package/resources/simulations/conversions.mjs +35 -0
- package/resources/simulations/conversions.mjs.map +1 -0
- package/resources/simulations/deposits.d.mts +202 -0
- package/resources/simulations/deposits.d.mts.map +1 -0
- package/resources/simulations/deposits.d.ts +202 -0
- package/resources/simulations/deposits.d.ts.map +1 -0
- package/resources/simulations/deposits.js +25 -0
- package/resources/simulations/deposits.js.map +1 -0
- package/resources/simulations/deposits.mjs +21 -0
- package/resources/simulations/deposits.mjs.map +1 -0
- package/resources/simulations/index.d.mts +7 -0
- package/resources/simulations/index.d.mts.map +1 -0
- package/resources/simulations/index.d.ts +7 -0
- package/resources/simulations/index.d.ts.map +1 -0
- package/resources/simulations/index.js +17 -0
- package/resources/simulations/index.js.map +1 -0
- package/resources/simulations/index.mjs +8 -0
- package/resources/simulations/index.mjs.map +1 -0
- package/resources/simulations/payouts.d.mts +62 -0
- package/resources/simulations/payouts.d.mts.map +1 -0
- package/resources/simulations/payouts.d.ts +62 -0
- package/resources/simulations/payouts.d.ts.map +1 -0
- package/resources/simulations/payouts.js +39 -0
- package/resources/simulations/payouts.js.map +1 -0
- package/resources/simulations/payouts.mjs +35 -0
- package/resources/simulations/payouts.mjs.map +1 -0
- package/resources/simulations/simulations.d.mts +26 -0
- package/resources/simulations/simulations.d.mts.map +1 -0
- package/resources/simulations/simulations.d.ts +26 -0
- package/resources/simulations/simulations.d.ts.map +1 -0
- package/resources/simulations/simulations.js +33 -0
- package/resources/simulations/simulations.js.map +1 -0
- package/resources/simulations/simulations.mjs +28 -0
- package/resources/simulations/simulations.mjs.map +1 -0
- package/resources/simulations.d.mts +2 -0
- package/resources/simulations.d.mts.map +1 -0
- package/resources/simulations.d.ts +2 -0
- package/resources/simulations.d.ts.map +1 -0
- package/resources/simulations.js +6 -0
- package/resources/simulations.js.map +1 -0
- package/resources/simulations.mjs +3 -0
- package/resources/simulations.mjs.map +1 -0
- package/resources/transactions.d.mts +342 -162
- package/resources/transactions.d.mts.map +1 -1
- package/resources/transactions.d.ts +342 -162
- package/resources/transactions.d.ts.map +1 -1
- package/resources/webhook-subscriptions.d.mts +61 -11
- package/resources/webhook-subscriptions.d.mts.map +1 -1
- package/resources/webhook-subscriptions.d.ts +61 -11
- package/resources/webhook-subscriptions.d.ts.map +1 -1
- package/resources/webhook-subscriptions.js +49 -0
- package/resources/webhook-subscriptions.js.map +1 -1
- package/resources/webhook-subscriptions.mjs +49 -0
- package/resources/webhook-subscriptions.mjs.map +1 -1
- package/resources/webhooks.d.mts +976 -978
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +976 -978
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +48 -8
- package/src/resources/account-holders.ts +1701 -1282
- package/src/resources/account-programs.ts +30 -19
- package/src/resources/accounts.ts +265 -50
- package/src/resources/api-keys.ts +3 -0
- package/src/resources/api-versions.ts +3 -0
- package/src/resources/conversions.ts +36 -93
- package/src/resources/counterparties.ts +3127 -0
- package/src/resources/deposits.ts +66 -269
- package/src/resources/events.ts +18 -12
- package/src/resources/index.ts +21 -4
- package/src/resources/payouts.ts +204 -439
- package/src/resources/quotes/indicative.ts +7 -12
- package/src/resources/quotes/quotes.ts +4 -9
- package/src/resources/returns.ts +144 -40
- package/src/resources/scopes.ts +7 -1
- package/src/resources/simulations/account-programs.ts +282 -0
- package/src/resources/simulations/accounts.ts +265 -0
- package/src/resources/simulations/conversions.ts +70 -0
- package/src/resources/simulations/deposits.ts +522 -0
- package/src/resources/simulations/index.ts +33 -0
- package/src/resources/simulations/payouts.ts +80 -0
- package/src/resources/simulations/simulations.ts +92 -0
- package/src/resources/simulations.ts +3 -0
- package/src/resources/transactions.ts +954 -206
- package/src/resources/webhook-subscriptions.ts +102 -36
- package/src/resources/webhooks.ts +1283 -1153
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -37,7 +37,7 @@ export interface TransactionRetrieveResponse {
|
|
|
37
37
|
id: string;
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
* ID of the merchant account this transaction
|
|
40
|
+
* ID of the merchant account this transaction was credited to or debited from.
|
|
41
41
|
*/
|
|
42
42
|
account_id: string;
|
|
43
43
|
|
|
@@ -47,34 +47,48 @@ export interface TransactionRetrieveResponse {
|
|
|
47
47
|
amount: string;
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* ISO 8601 UTC timestamp when the transaction was recorded.
|
|
51
51
|
*/
|
|
52
|
-
|
|
52
|
+
booked_at: string;
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* Counterparty of the transaction.
|
|
56
56
|
*/
|
|
57
|
-
counterparty:
|
|
58
|
-
| TransactionRetrieveResponse.IbanFinancialAddress
|
|
59
|
-
| TransactionRetrieveResponse.SortCodeFinancialAddress
|
|
60
|
-
| TransactionRetrieveResponse.AbaFinancialAddress
|
|
61
|
-
| TransactionRetrieveResponse.CryptoWalletFinancialAddress
|
|
62
|
-
| null;
|
|
57
|
+
counterparty: TransactionRetrieveResponse.Counterparty | null;
|
|
63
58
|
|
|
64
59
|
/**
|
|
65
|
-
*
|
|
60
|
+
* ID of the counterparty this transaction is associated with, or null when none
|
|
61
|
+
* was resolved. Correlates with the counterparties API and a payout's
|
|
62
|
+
* counterparty_id.
|
|
66
63
|
*/
|
|
67
|
-
|
|
64
|
+
counterparty_id: string | null;
|
|
68
65
|
|
|
69
66
|
/**
|
|
70
|
-
* ISO 4217
|
|
67
|
+
* Currency code (ISO 4217 or crypto).
|
|
71
68
|
*/
|
|
72
69
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
73
70
|
|
|
74
71
|
/**
|
|
75
|
-
*
|
|
72
|
+
* Payment scheme or blockchain used for the transaction, or null when unknown.
|
|
76
73
|
*/
|
|
77
|
-
|
|
74
|
+
rail:
|
|
75
|
+
| 'sepa'
|
|
76
|
+
| 'sepa_instant'
|
|
77
|
+
| 'faster_payments'
|
|
78
|
+
| 'swift'
|
|
79
|
+
| 'internal'
|
|
80
|
+
| 'target'
|
|
81
|
+
| 'ach'
|
|
82
|
+
| 'fedwire'
|
|
83
|
+
| 'bitcoin'
|
|
84
|
+
| 'bitcoin_testnet4'
|
|
85
|
+
| 'ethereum'
|
|
86
|
+
| 'ethereum_sepolia'
|
|
87
|
+
| 'solana'
|
|
88
|
+
| 'solana_devnet'
|
|
89
|
+
| 'polygon'
|
|
90
|
+
| 'polygon_amoy'
|
|
91
|
+
| null;
|
|
78
92
|
|
|
79
93
|
/**
|
|
80
94
|
* Direction of the movement relative to the merchant account.
|
|
@@ -82,121 +96,481 @@ export interface TransactionRetrieveResponse {
|
|
|
82
96
|
side: 'credit' | 'debit';
|
|
83
97
|
|
|
84
98
|
/**
|
|
85
|
-
*
|
|
99
|
+
* The resource that originated this transaction, or null when it does not map to a
|
|
100
|
+
* retrievable resource.
|
|
86
101
|
*/
|
|
87
|
-
|
|
102
|
+
source: TransactionRetrieveResponse.Source | null;
|
|
88
103
|
|
|
89
104
|
/**
|
|
90
|
-
*
|
|
105
|
+
* State of the transaction. Transactions are by definition booked.
|
|
91
106
|
*/
|
|
92
|
-
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
export namespace TransactionRetrieveResponse {
|
|
96
|
-
export interface IbanFinancialAddress {
|
|
97
|
-
/**
|
|
98
|
-
* Name of the account holder.
|
|
99
|
-
*/
|
|
100
|
-
account_holder_name: string;
|
|
101
|
-
|
|
102
|
-
/**
|
|
103
|
-
* Bank Identifier Code, or null if not provided.
|
|
104
|
-
*/
|
|
105
|
-
bic: string | null;
|
|
107
|
+
status: 'booked';
|
|
106
108
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
/**
|
|
113
|
-
* Discriminator for IBAN financial address.
|
|
114
|
-
*/
|
|
115
|
-
type: 'iban';
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
export interface SortCodeFinancialAddress {
|
|
119
|
-
/**
|
|
120
|
-
* Name of the account holder.
|
|
121
|
-
*/
|
|
122
|
-
account_holder_name: string;
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* UK account number (8 digits).
|
|
126
|
-
*/
|
|
127
|
-
account_number: string;
|
|
128
|
-
|
|
129
|
-
/**
|
|
130
|
-
* UK sort code (6 digits).
|
|
131
|
-
*/
|
|
132
|
-
sort_code: string;
|
|
109
|
+
/**
|
|
110
|
+
* Reference used to track the payment across the payment network, such as the UETR
|
|
111
|
+
* for SWIFT payments.
|
|
112
|
+
*/
|
|
113
|
+
tracking_reference: string | null;
|
|
133
114
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
115
|
+
/**
|
|
116
|
+
* Transaction hash for crypto transactions, or null when not known. Only
|
|
117
|
+
* blockchain rails support this field.
|
|
118
|
+
*/
|
|
119
|
+
tx_hash: string | null;
|
|
139
120
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
account_holder_name: string;
|
|
121
|
+
/**
|
|
122
|
+
* Resource type discriminator.
|
|
123
|
+
*/
|
|
124
|
+
type: 'transaction';
|
|
145
125
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
126
|
+
/**
|
|
127
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
128
|
+
* support this field.
|
|
129
|
+
*/
|
|
130
|
+
unstructured_remittance_information: string | null;
|
|
131
|
+
}
|
|
150
132
|
|
|
133
|
+
export namespace TransactionRetrieveResponse {
|
|
134
|
+
/**
|
|
135
|
+
* Counterparty of the transaction.
|
|
136
|
+
*/
|
|
137
|
+
export interface Counterparty {
|
|
151
138
|
/**
|
|
152
|
-
*
|
|
139
|
+
* Financial address of the counterparty.
|
|
153
140
|
*/
|
|
154
|
-
|
|
141
|
+
financial_address:
|
|
142
|
+
| Counterparty.IbanFinancialAddress
|
|
143
|
+
| Counterparty.SortCodeFinancialAddress
|
|
144
|
+
| Counterparty.AbaFinancialAddress
|
|
145
|
+
| Counterparty.BicFinancialAddress
|
|
146
|
+
| Counterparty.CryptoWalletFinancialAddress;
|
|
155
147
|
|
|
156
148
|
/**
|
|
157
|
-
*
|
|
149
|
+
* Physical address of the counterparty.
|
|
158
150
|
*/
|
|
159
|
-
|
|
151
|
+
physical_address: Counterparty.PhysicalAddress | null;
|
|
160
152
|
}
|
|
161
153
|
|
|
162
|
-
export
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
154
|
+
export namespace Counterparty {
|
|
155
|
+
export interface IbanFinancialAddress {
|
|
156
|
+
/**
|
|
157
|
+
* Name of the account holder.
|
|
158
|
+
*/
|
|
159
|
+
account_holder_name: string;
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Bank Identifier Code, or null if not provided.
|
|
163
|
+
*/
|
|
164
|
+
bic: string | null;
|
|
165
|
+
|
|
166
|
+
/**
|
|
167
|
+
* International Bank Account Number.
|
|
168
|
+
*/
|
|
169
|
+
iban: string;
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* Discriminator for IBAN financial address.
|
|
173
|
+
*/
|
|
174
|
+
type: 'iban';
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
export interface SortCodeFinancialAddress {
|
|
178
|
+
/**
|
|
179
|
+
* Name of the account holder.
|
|
180
|
+
*/
|
|
181
|
+
account_holder_name: string;
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* UK account number (8 digits).
|
|
185
|
+
*/
|
|
186
|
+
account_number: string;
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* UK sort code (6 digits).
|
|
190
|
+
*/
|
|
191
|
+
sort_code: string;
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Discriminator for UK sort code financial address.
|
|
195
|
+
*/
|
|
196
|
+
type: 'sort_code';
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
export interface AbaFinancialAddress {
|
|
200
|
+
/**
|
|
201
|
+
* Name of the account holder.
|
|
202
|
+
*/
|
|
203
|
+
account_holder_name: string;
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* Bank account number.
|
|
207
|
+
*/
|
|
208
|
+
account_number: string;
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* ABA routing number (9 digits).
|
|
212
|
+
*/
|
|
213
|
+
routing_number: string;
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* Discriminator for ABA wire financial address.
|
|
217
|
+
*/
|
|
218
|
+
type: 'aba';
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
export interface BicFinancialAddress {
|
|
222
|
+
/**
|
|
223
|
+
* Name of the account holder.
|
|
224
|
+
*/
|
|
225
|
+
account_holder_name: string;
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* Local-format bank account number.
|
|
229
|
+
*/
|
|
230
|
+
account_number: string;
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* ISO 9362 Bank Identifier Code (8 or 11 characters).
|
|
234
|
+
*/
|
|
235
|
+
bic: string;
|
|
236
|
+
|
|
237
|
+
/**
|
|
238
|
+
* Domestic bank or branch code where the destination country uses one (for example
|
|
239
|
+
* the BSB in Australia), or null.
|
|
240
|
+
*/
|
|
241
|
+
local_bank_code: string | null;
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* Discriminator for BIC + local account financial address.
|
|
245
|
+
*/
|
|
246
|
+
type: 'bic';
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
export interface CryptoWalletFinancialAddress {
|
|
250
|
+
/**
|
|
251
|
+
* Wallet address on the specified blockchain.
|
|
252
|
+
*/
|
|
253
|
+
address: string;
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* Blockchain network for the crypto wallet.
|
|
257
|
+
*/
|
|
258
|
+
blockchain:
|
|
259
|
+
| 'bitcoin'
|
|
260
|
+
| 'ethereum'
|
|
261
|
+
| 'solana'
|
|
262
|
+
| 'polygon'
|
|
263
|
+
| 'bitcoin_testnet4'
|
|
264
|
+
| 'ethereum_sepolia'
|
|
265
|
+
| 'solana_devnet'
|
|
266
|
+
| 'polygon_amoy';
|
|
267
|
+
|
|
268
|
+
/**
|
|
269
|
+
* Discriminator for crypto wallet financial address.
|
|
270
|
+
*/
|
|
271
|
+
type: 'crypto_wallet';
|
|
272
|
+
}
|
|
180
273
|
|
|
181
274
|
/**
|
|
182
|
-
*
|
|
275
|
+
* Physical address of the counterparty.
|
|
183
276
|
*/
|
|
184
|
-
|
|
277
|
+
export interface PhysicalAddress {
|
|
278
|
+
/**
|
|
279
|
+
* City or locality.
|
|
280
|
+
*/
|
|
281
|
+
city: string;
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* ISO 3166-1 alpha-2 country code.
|
|
285
|
+
*/
|
|
286
|
+
country_code:
|
|
287
|
+
| 'AF'
|
|
288
|
+
| 'AL'
|
|
289
|
+
| 'DZ'
|
|
290
|
+
| 'AS'
|
|
291
|
+
| 'AD'
|
|
292
|
+
| 'AO'
|
|
293
|
+
| 'AI'
|
|
294
|
+
| 'AQ'
|
|
295
|
+
| 'AG'
|
|
296
|
+
| 'AR'
|
|
297
|
+
| 'AM'
|
|
298
|
+
| 'AW'
|
|
299
|
+
| 'AU'
|
|
300
|
+
| 'AT'
|
|
301
|
+
| 'AZ'
|
|
302
|
+
| 'BS'
|
|
303
|
+
| 'BH'
|
|
304
|
+
| 'BD'
|
|
305
|
+
| 'BB'
|
|
306
|
+
| 'BY'
|
|
307
|
+
| 'BE'
|
|
308
|
+
| 'BZ'
|
|
309
|
+
| 'BJ'
|
|
310
|
+
| 'BM'
|
|
311
|
+
| 'BT'
|
|
312
|
+
| 'BO'
|
|
313
|
+
| 'BA'
|
|
314
|
+
| 'BW'
|
|
315
|
+
| 'BV'
|
|
316
|
+
| 'BR'
|
|
317
|
+
| 'IO'
|
|
318
|
+
| 'BN'
|
|
319
|
+
| 'BG'
|
|
320
|
+
| 'BF'
|
|
321
|
+
| 'BI'
|
|
322
|
+
| 'KH'
|
|
323
|
+
| 'CM'
|
|
324
|
+
| 'CA'
|
|
325
|
+
| 'CV'
|
|
326
|
+
| 'KY'
|
|
327
|
+
| 'CF'
|
|
328
|
+
| 'TD'
|
|
329
|
+
| 'CL'
|
|
330
|
+
| 'CN'
|
|
331
|
+
| 'CX'
|
|
332
|
+
| 'CC'
|
|
333
|
+
| 'CO'
|
|
334
|
+
| 'KM'
|
|
335
|
+
| 'CG'
|
|
336
|
+
| 'CD'
|
|
337
|
+
| 'CK'
|
|
338
|
+
| 'CR'
|
|
339
|
+
| 'CI'
|
|
340
|
+
| 'HR'
|
|
341
|
+
| 'CU'
|
|
342
|
+
| 'CY'
|
|
343
|
+
| 'CZ'
|
|
344
|
+
| 'DK'
|
|
345
|
+
| 'DJ'
|
|
346
|
+
| 'DM'
|
|
347
|
+
| 'DO'
|
|
348
|
+
| 'EC'
|
|
349
|
+
| 'EG'
|
|
350
|
+
| 'SV'
|
|
351
|
+
| 'GQ'
|
|
352
|
+
| 'ER'
|
|
353
|
+
| 'EE'
|
|
354
|
+
| 'ET'
|
|
355
|
+
| 'FK'
|
|
356
|
+
| 'FO'
|
|
357
|
+
| 'FJ'
|
|
358
|
+
| 'FI'
|
|
359
|
+
| 'FR'
|
|
360
|
+
| 'GF'
|
|
361
|
+
| 'PF'
|
|
362
|
+
| 'TF'
|
|
363
|
+
| 'GA'
|
|
364
|
+
| 'GM'
|
|
365
|
+
| 'GE'
|
|
366
|
+
| 'DE'
|
|
367
|
+
| 'GH'
|
|
368
|
+
| 'GI'
|
|
369
|
+
| 'GR'
|
|
370
|
+
| 'GL'
|
|
371
|
+
| 'GD'
|
|
372
|
+
| 'GP'
|
|
373
|
+
| 'GU'
|
|
374
|
+
| 'GT'
|
|
375
|
+
| 'GN'
|
|
376
|
+
| 'GW'
|
|
377
|
+
| 'GY'
|
|
378
|
+
| 'HT'
|
|
379
|
+
| 'HM'
|
|
380
|
+
| 'VA'
|
|
381
|
+
| 'HN'
|
|
382
|
+
| 'HK'
|
|
383
|
+
| 'HU'
|
|
384
|
+
| 'IS'
|
|
385
|
+
| 'IN'
|
|
386
|
+
| 'ID'
|
|
387
|
+
| 'IR'
|
|
388
|
+
| 'IQ'
|
|
389
|
+
| 'IE'
|
|
390
|
+
| 'IL'
|
|
391
|
+
| 'IT'
|
|
392
|
+
| 'JM'
|
|
393
|
+
| 'JP'
|
|
394
|
+
| 'JO'
|
|
395
|
+
| 'KZ'
|
|
396
|
+
| 'KE'
|
|
397
|
+
| 'KI'
|
|
398
|
+
| 'KP'
|
|
399
|
+
| 'KR'
|
|
400
|
+
| 'KW'
|
|
401
|
+
| 'KG'
|
|
402
|
+
| 'LA'
|
|
403
|
+
| 'LV'
|
|
404
|
+
| 'LB'
|
|
405
|
+
| 'LS'
|
|
406
|
+
| 'LR'
|
|
407
|
+
| 'LY'
|
|
408
|
+
| 'LI'
|
|
409
|
+
| 'LT'
|
|
410
|
+
| 'LU'
|
|
411
|
+
| 'MO'
|
|
412
|
+
| 'MG'
|
|
413
|
+
| 'MW'
|
|
414
|
+
| 'MY'
|
|
415
|
+
| 'MV'
|
|
416
|
+
| 'ML'
|
|
417
|
+
| 'MT'
|
|
418
|
+
| 'MH'
|
|
419
|
+
| 'MQ'
|
|
420
|
+
| 'MR'
|
|
421
|
+
| 'MU'
|
|
422
|
+
| 'YT'
|
|
423
|
+
| 'MX'
|
|
424
|
+
| 'FM'
|
|
425
|
+
| 'MD'
|
|
426
|
+
| 'MC'
|
|
427
|
+
| 'MN'
|
|
428
|
+
| 'MS'
|
|
429
|
+
| 'MA'
|
|
430
|
+
| 'MZ'
|
|
431
|
+
| 'MM'
|
|
432
|
+
| 'NA'
|
|
433
|
+
| 'NR'
|
|
434
|
+
| 'NP'
|
|
435
|
+
| 'NL'
|
|
436
|
+
| 'NC'
|
|
437
|
+
| 'NZ'
|
|
438
|
+
| 'NI'
|
|
439
|
+
| 'NE'
|
|
440
|
+
| 'NG'
|
|
441
|
+
| 'NU'
|
|
442
|
+
| 'NF'
|
|
443
|
+
| 'MP'
|
|
444
|
+
| 'MK'
|
|
445
|
+
| 'NO'
|
|
446
|
+
| 'OM'
|
|
447
|
+
| 'PK'
|
|
448
|
+
| 'PW'
|
|
449
|
+
| 'PS'
|
|
450
|
+
| 'PA'
|
|
451
|
+
| 'PG'
|
|
452
|
+
| 'PY'
|
|
453
|
+
| 'PE'
|
|
454
|
+
| 'PH'
|
|
455
|
+
| 'PN'
|
|
456
|
+
| 'PL'
|
|
457
|
+
| 'PT'
|
|
458
|
+
| 'PR'
|
|
459
|
+
| 'QA'
|
|
460
|
+
| 'RE'
|
|
461
|
+
| 'RO'
|
|
462
|
+
| 'RU'
|
|
463
|
+
| 'RW'
|
|
464
|
+
| 'SH'
|
|
465
|
+
| 'KN'
|
|
466
|
+
| 'LC'
|
|
467
|
+
| 'PM'
|
|
468
|
+
| 'VC'
|
|
469
|
+
| 'WS'
|
|
470
|
+
| 'SM'
|
|
471
|
+
| 'ST'
|
|
472
|
+
| 'SA'
|
|
473
|
+
| 'SN'
|
|
474
|
+
| 'SC'
|
|
475
|
+
| 'SL'
|
|
476
|
+
| 'SG'
|
|
477
|
+
| 'SK'
|
|
478
|
+
| 'SI'
|
|
479
|
+
| 'SB'
|
|
480
|
+
| 'SO'
|
|
481
|
+
| 'ZA'
|
|
482
|
+
| 'GS'
|
|
483
|
+
| 'ES'
|
|
484
|
+
| 'LK'
|
|
485
|
+
| 'SD'
|
|
486
|
+
| 'SR'
|
|
487
|
+
| 'SJ'
|
|
488
|
+
| 'SZ'
|
|
489
|
+
| 'SE'
|
|
490
|
+
| 'CH'
|
|
491
|
+
| 'SY'
|
|
492
|
+
| 'TW'
|
|
493
|
+
| 'TJ'
|
|
494
|
+
| 'TZ'
|
|
495
|
+
| 'TH'
|
|
496
|
+
| 'TL'
|
|
497
|
+
| 'TG'
|
|
498
|
+
| 'TK'
|
|
499
|
+
| 'TO'
|
|
500
|
+
| 'TT'
|
|
501
|
+
| 'TN'
|
|
502
|
+
| 'TR'
|
|
503
|
+
| 'TM'
|
|
504
|
+
| 'TC'
|
|
505
|
+
| 'TV'
|
|
506
|
+
| 'UG'
|
|
507
|
+
| 'UA'
|
|
508
|
+
| 'AE'
|
|
509
|
+
| 'GB'
|
|
510
|
+
| 'US'
|
|
511
|
+
| 'UM'
|
|
512
|
+
| 'UY'
|
|
513
|
+
| 'UZ'
|
|
514
|
+
| 'VU'
|
|
515
|
+
| 'VE'
|
|
516
|
+
| 'VN'
|
|
517
|
+
| 'VG'
|
|
518
|
+
| 'VI'
|
|
519
|
+
| 'WF'
|
|
520
|
+
| 'EH'
|
|
521
|
+
| 'YE'
|
|
522
|
+
| 'ZM'
|
|
523
|
+
| 'ZW'
|
|
524
|
+
| 'AX'
|
|
525
|
+
| 'BQ'
|
|
526
|
+
| 'CW'
|
|
527
|
+
| 'GG'
|
|
528
|
+
| 'IM'
|
|
529
|
+
| 'JE'
|
|
530
|
+
| 'ME'
|
|
531
|
+
| 'BL'
|
|
532
|
+
| 'MF'
|
|
533
|
+
| 'RS'
|
|
534
|
+
| 'SX'
|
|
535
|
+
| 'SS'
|
|
536
|
+
| 'XK';
|
|
537
|
+
|
|
538
|
+
/**
|
|
539
|
+
* Primary street address.
|
|
540
|
+
*/
|
|
541
|
+
line_1: string;
|
|
542
|
+
|
|
543
|
+
/**
|
|
544
|
+
* Secondary street address, or null if not recorded.
|
|
545
|
+
*/
|
|
546
|
+
line_2: string | null;
|
|
547
|
+
|
|
548
|
+
/**
|
|
549
|
+
* Postal or ZIP code.
|
|
550
|
+
*/
|
|
551
|
+
postal_code: string;
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
* State, province, or region, or null if not recorded.
|
|
555
|
+
*/
|
|
556
|
+
state: string | null;
|
|
557
|
+
}
|
|
185
558
|
}
|
|
186
559
|
|
|
187
560
|
/**
|
|
188
|
-
* The
|
|
561
|
+
* The resource that originated this transaction, or null when it does not map to a
|
|
562
|
+
* retrievable resource.
|
|
189
563
|
*/
|
|
190
|
-
export interface
|
|
564
|
+
export interface Source {
|
|
191
565
|
/**
|
|
192
|
-
* Identifier of the
|
|
566
|
+
* Identifier of the originating resource, retrievable on its own endpoint.
|
|
193
567
|
*/
|
|
194
568
|
id: string;
|
|
195
569
|
|
|
196
570
|
/**
|
|
197
|
-
* Type of the
|
|
571
|
+
* Type of the resource that originated this transaction.
|
|
198
572
|
*/
|
|
199
|
-
type: 'deposit' | '
|
|
573
|
+
type: 'deposit' | 'payout' | 'return';
|
|
200
574
|
}
|
|
201
575
|
}
|
|
202
576
|
|
|
@@ -207,7 +581,7 @@ export interface TransactionListResponse {
|
|
|
207
581
|
id: string;
|
|
208
582
|
|
|
209
583
|
/**
|
|
210
|
-
* ID of the merchant account this transaction
|
|
584
|
+
* ID of the merchant account this transaction was credited to or debited from.
|
|
211
585
|
*/
|
|
212
586
|
account_id: string;
|
|
213
587
|
|
|
@@ -217,34 +591,48 @@ export interface TransactionListResponse {
|
|
|
217
591
|
amount: string;
|
|
218
592
|
|
|
219
593
|
/**
|
|
220
|
-
*
|
|
594
|
+
* ISO 8601 UTC timestamp when the transaction was recorded.
|
|
221
595
|
*/
|
|
222
|
-
|
|
596
|
+
booked_at: string;
|
|
223
597
|
|
|
224
598
|
/**
|
|
225
|
-
*
|
|
599
|
+
* Counterparty of the transaction.
|
|
226
600
|
*/
|
|
227
|
-
counterparty:
|
|
228
|
-
| TransactionListResponse.IbanFinancialAddress
|
|
229
|
-
| TransactionListResponse.SortCodeFinancialAddress
|
|
230
|
-
| TransactionListResponse.AbaFinancialAddress
|
|
231
|
-
| TransactionListResponse.CryptoWalletFinancialAddress
|
|
232
|
-
| null;
|
|
601
|
+
counterparty: TransactionListResponse.Counterparty | null;
|
|
233
602
|
|
|
234
603
|
/**
|
|
235
|
-
*
|
|
604
|
+
* ID of the counterparty this transaction is associated with, or null when none
|
|
605
|
+
* was resolved. Correlates with the counterparties API and a payout's
|
|
606
|
+
* counterparty_id.
|
|
236
607
|
*/
|
|
237
|
-
|
|
608
|
+
counterparty_id: string | null;
|
|
238
609
|
|
|
239
610
|
/**
|
|
240
|
-
* ISO 4217
|
|
611
|
+
* Currency code (ISO 4217 or crypto).
|
|
241
612
|
*/
|
|
242
613
|
currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
|
|
243
614
|
|
|
244
615
|
/**
|
|
245
|
-
*
|
|
616
|
+
* Payment scheme or blockchain used for the transaction, or null when unknown.
|
|
246
617
|
*/
|
|
247
|
-
|
|
618
|
+
rail:
|
|
619
|
+
| 'sepa'
|
|
620
|
+
| 'sepa_instant'
|
|
621
|
+
| 'faster_payments'
|
|
622
|
+
| 'swift'
|
|
623
|
+
| 'internal'
|
|
624
|
+
| 'target'
|
|
625
|
+
| 'ach'
|
|
626
|
+
| 'fedwire'
|
|
627
|
+
| 'bitcoin'
|
|
628
|
+
| 'bitcoin_testnet4'
|
|
629
|
+
| 'ethereum'
|
|
630
|
+
| 'ethereum_sepolia'
|
|
631
|
+
| 'solana'
|
|
632
|
+
| 'solana_devnet'
|
|
633
|
+
| 'polygon'
|
|
634
|
+
| 'polygon_amoy'
|
|
635
|
+
| null;
|
|
248
636
|
|
|
249
637
|
/**
|
|
250
638
|
* Direction of the movement relative to the merchant account.
|
|
@@ -252,121 +640,481 @@ export interface TransactionListResponse {
|
|
|
252
640
|
side: 'credit' | 'debit';
|
|
253
641
|
|
|
254
642
|
/**
|
|
255
|
-
*
|
|
643
|
+
* The resource that originated this transaction, or null when it does not map to a
|
|
644
|
+
* retrievable resource.
|
|
256
645
|
*/
|
|
257
|
-
|
|
646
|
+
source: TransactionListResponse.Source | null;
|
|
258
647
|
|
|
259
648
|
/**
|
|
260
|
-
*
|
|
649
|
+
* State of the transaction. Transactions are by definition booked.
|
|
261
650
|
*/
|
|
262
|
-
|
|
263
|
-
}
|
|
264
|
-
|
|
265
|
-
export namespace TransactionListResponse {
|
|
266
|
-
export interface IbanFinancialAddress {
|
|
267
|
-
/**
|
|
268
|
-
* Name of the account holder.
|
|
269
|
-
*/
|
|
270
|
-
account_holder_name: string;
|
|
271
|
-
|
|
272
|
-
/**
|
|
273
|
-
* Bank Identifier Code, or null if not provided.
|
|
274
|
-
*/
|
|
275
|
-
bic: string | null;
|
|
651
|
+
status: 'booked';
|
|
276
652
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
/**
|
|
283
|
-
* Discriminator for IBAN financial address.
|
|
284
|
-
*/
|
|
285
|
-
type: 'iban';
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
export interface SortCodeFinancialAddress {
|
|
289
|
-
/**
|
|
290
|
-
* Name of the account holder.
|
|
291
|
-
*/
|
|
292
|
-
account_holder_name: string;
|
|
293
|
-
|
|
294
|
-
/**
|
|
295
|
-
* UK account number (8 digits).
|
|
296
|
-
*/
|
|
297
|
-
account_number: string;
|
|
298
|
-
|
|
299
|
-
/**
|
|
300
|
-
* UK sort code (6 digits).
|
|
301
|
-
*/
|
|
302
|
-
sort_code: string;
|
|
653
|
+
/**
|
|
654
|
+
* Reference used to track the payment across the payment network, such as the UETR
|
|
655
|
+
* for SWIFT payments.
|
|
656
|
+
*/
|
|
657
|
+
tracking_reference: string | null;
|
|
303
658
|
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
659
|
+
/**
|
|
660
|
+
* Transaction hash for crypto transactions, or null when not known. Only
|
|
661
|
+
* blockchain rails support this field.
|
|
662
|
+
*/
|
|
663
|
+
tx_hash: string | null;
|
|
309
664
|
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
account_holder_name: string;
|
|
665
|
+
/**
|
|
666
|
+
* Resource type discriminator.
|
|
667
|
+
*/
|
|
668
|
+
type: 'transaction';
|
|
315
669
|
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
670
|
+
/**
|
|
671
|
+
* Unstructured remittance information attached to the transfer. Not all rails
|
|
672
|
+
* support this field.
|
|
673
|
+
*/
|
|
674
|
+
unstructured_remittance_information: string | null;
|
|
675
|
+
}
|
|
320
676
|
|
|
677
|
+
export namespace TransactionListResponse {
|
|
678
|
+
/**
|
|
679
|
+
* Counterparty of the transaction.
|
|
680
|
+
*/
|
|
681
|
+
export interface Counterparty {
|
|
321
682
|
/**
|
|
322
|
-
*
|
|
683
|
+
* Financial address of the counterparty.
|
|
323
684
|
*/
|
|
324
|
-
|
|
685
|
+
financial_address:
|
|
686
|
+
| Counterparty.IbanFinancialAddress
|
|
687
|
+
| Counterparty.SortCodeFinancialAddress
|
|
688
|
+
| Counterparty.AbaFinancialAddress
|
|
689
|
+
| Counterparty.BicFinancialAddress
|
|
690
|
+
| Counterparty.CryptoWalletFinancialAddress;
|
|
325
691
|
|
|
326
692
|
/**
|
|
327
|
-
*
|
|
693
|
+
* Physical address of the counterparty.
|
|
328
694
|
*/
|
|
329
|
-
|
|
695
|
+
physical_address: Counterparty.PhysicalAddress | null;
|
|
330
696
|
}
|
|
331
697
|
|
|
332
|
-
export
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
698
|
+
export namespace Counterparty {
|
|
699
|
+
export interface IbanFinancialAddress {
|
|
700
|
+
/**
|
|
701
|
+
* Name of the account holder.
|
|
702
|
+
*/
|
|
703
|
+
account_holder_name: string;
|
|
704
|
+
|
|
705
|
+
/**
|
|
706
|
+
* Bank Identifier Code, or null if not provided.
|
|
707
|
+
*/
|
|
708
|
+
bic: string | null;
|
|
709
|
+
|
|
710
|
+
/**
|
|
711
|
+
* International Bank Account Number.
|
|
712
|
+
*/
|
|
713
|
+
iban: string;
|
|
714
|
+
|
|
715
|
+
/**
|
|
716
|
+
* Discriminator for IBAN financial address.
|
|
717
|
+
*/
|
|
718
|
+
type: 'iban';
|
|
719
|
+
}
|
|
720
|
+
|
|
721
|
+
export interface SortCodeFinancialAddress {
|
|
722
|
+
/**
|
|
723
|
+
* Name of the account holder.
|
|
724
|
+
*/
|
|
725
|
+
account_holder_name: string;
|
|
726
|
+
|
|
727
|
+
/**
|
|
728
|
+
* UK account number (8 digits).
|
|
729
|
+
*/
|
|
730
|
+
account_number: string;
|
|
731
|
+
|
|
732
|
+
/**
|
|
733
|
+
* UK sort code (6 digits).
|
|
734
|
+
*/
|
|
735
|
+
sort_code: string;
|
|
736
|
+
|
|
737
|
+
/**
|
|
738
|
+
* Discriminator for UK sort code financial address.
|
|
739
|
+
*/
|
|
740
|
+
type: 'sort_code';
|
|
741
|
+
}
|
|
742
|
+
|
|
743
|
+
export interface AbaFinancialAddress {
|
|
744
|
+
/**
|
|
745
|
+
* Name of the account holder.
|
|
746
|
+
*/
|
|
747
|
+
account_holder_name: string;
|
|
748
|
+
|
|
749
|
+
/**
|
|
750
|
+
* Bank account number.
|
|
751
|
+
*/
|
|
752
|
+
account_number: string;
|
|
753
|
+
|
|
754
|
+
/**
|
|
755
|
+
* ABA routing number (9 digits).
|
|
756
|
+
*/
|
|
757
|
+
routing_number: string;
|
|
758
|
+
|
|
759
|
+
/**
|
|
760
|
+
* Discriminator for ABA wire financial address.
|
|
761
|
+
*/
|
|
762
|
+
type: 'aba';
|
|
763
|
+
}
|
|
764
|
+
|
|
765
|
+
export interface BicFinancialAddress {
|
|
766
|
+
/**
|
|
767
|
+
* Name of the account holder.
|
|
768
|
+
*/
|
|
769
|
+
account_holder_name: string;
|
|
770
|
+
|
|
771
|
+
/**
|
|
772
|
+
* Local-format bank account number.
|
|
773
|
+
*/
|
|
774
|
+
account_number: string;
|
|
775
|
+
|
|
776
|
+
/**
|
|
777
|
+
* ISO 9362 Bank Identifier Code (8 or 11 characters).
|
|
778
|
+
*/
|
|
779
|
+
bic: string;
|
|
780
|
+
|
|
781
|
+
/**
|
|
782
|
+
* Domestic bank or branch code where the destination country uses one (for example
|
|
783
|
+
* the BSB in Australia), or null.
|
|
784
|
+
*/
|
|
785
|
+
local_bank_code: string | null;
|
|
786
|
+
|
|
787
|
+
/**
|
|
788
|
+
* Discriminator for BIC + local account financial address.
|
|
789
|
+
*/
|
|
790
|
+
type: 'bic';
|
|
791
|
+
}
|
|
792
|
+
|
|
793
|
+
export interface CryptoWalletFinancialAddress {
|
|
794
|
+
/**
|
|
795
|
+
* Wallet address on the specified blockchain.
|
|
796
|
+
*/
|
|
797
|
+
address: string;
|
|
798
|
+
|
|
799
|
+
/**
|
|
800
|
+
* Blockchain network for the crypto wallet.
|
|
801
|
+
*/
|
|
802
|
+
blockchain:
|
|
803
|
+
| 'bitcoin'
|
|
804
|
+
| 'ethereum'
|
|
805
|
+
| 'solana'
|
|
806
|
+
| 'polygon'
|
|
807
|
+
| 'bitcoin_testnet4'
|
|
808
|
+
| 'ethereum_sepolia'
|
|
809
|
+
| 'solana_devnet'
|
|
810
|
+
| 'polygon_amoy';
|
|
811
|
+
|
|
812
|
+
/**
|
|
813
|
+
* Discriminator for crypto wallet financial address.
|
|
814
|
+
*/
|
|
815
|
+
type: 'crypto_wallet';
|
|
816
|
+
}
|
|
350
817
|
|
|
351
818
|
/**
|
|
352
|
-
*
|
|
819
|
+
* Physical address of the counterparty.
|
|
353
820
|
*/
|
|
354
|
-
|
|
821
|
+
export interface PhysicalAddress {
|
|
822
|
+
/**
|
|
823
|
+
* City or locality.
|
|
824
|
+
*/
|
|
825
|
+
city: string;
|
|
826
|
+
|
|
827
|
+
/**
|
|
828
|
+
* ISO 3166-1 alpha-2 country code.
|
|
829
|
+
*/
|
|
830
|
+
country_code:
|
|
831
|
+
| 'AF'
|
|
832
|
+
| 'AL'
|
|
833
|
+
| 'DZ'
|
|
834
|
+
| 'AS'
|
|
835
|
+
| 'AD'
|
|
836
|
+
| 'AO'
|
|
837
|
+
| 'AI'
|
|
838
|
+
| 'AQ'
|
|
839
|
+
| 'AG'
|
|
840
|
+
| 'AR'
|
|
841
|
+
| 'AM'
|
|
842
|
+
| 'AW'
|
|
843
|
+
| 'AU'
|
|
844
|
+
| 'AT'
|
|
845
|
+
| 'AZ'
|
|
846
|
+
| 'BS'
|
|
847
|
+
| 'BH'
|
|
848
|
+
| 'BD'
|
|
849
|
+
| 'BB'
|
|
850
|
+
| 'BY'
|
|
851
|
+
| 'BE'
|
|
852
|
+
| 'BZ'
|
|
853
|
+
| 'BJ'
|
|
854
|
+
| 'BM'
|
|
855
|
+
| 'BT'
|
|
856
|
+
| 'BO'
|
|
857
|
+
| 'BA'
|
|
858
|
+
| 'BW'
|
|
859
|
+
| 'BV'
|
|
860
|
+
| 'BR'
|
|
861
|
+
| 'IO'
|
|
862
|
+
| 'BN'
|
|
863
|
+
| 'BG'
|
|
864
|
+
| 'BF'
|
|
865
|
+
| 'BI'
|
|
866
|
+
| 'KH'
|
|
867
|
+
| 'CM'
|
|
868
|
+
| 'CA'
|
|
869
|
+
| 'CV'
|
|
870
|
+
| 'KY'
|
|
871
|
+
| 'CF'
|
|
872
|
+
| 'TD'
|
|
873
|
+
| 'CL'
|
|
874
|
+
| 'CN'
|
|
875
|
+
| 'CX'
|
|
876
|
+
| 'CC'
|
|
877
|
+
| 'CO'
|
|
878
|
+
| 'KM'
|
|
879
|
+
| 'CG'
|
|
880
|
+
| 'CD'
|
|
881
|
+
| 'CK'
|
|
882
|
+
| 'CR'
|
|
883
|
+
| 'CI'
|
|
884
|
+
| 'HR'
|
|
885
|
+
| 'CU'
|
|
886
|
+
| 'CY'
|
|
887
|
+
| 'CZ'
|
|
888
|
+
| 'DK'
|
|
889
|
+
| 'DJ'
|
|
890
|
+
| 'DM'
|
|
891
|
+
| 'DO'
|
|
892
|
+
| 'EC'
|
|
893
|
+
| 'EG'
|
|
894
|
+
| 'SV'
|
|
895
|
+
| 'GQ'
|
|
896
|
+
| 'ER'
|
|
897
|
+
| 'EE'
|
|
898
|
+
| 'ET'
|
|
899
|
+
| 'FK'
|
|
900
|
+
| 'FO'
|
|
901
|
+
| 'FJ'
|
|
902
|
+
| 'FI'
|
|
903
|
+
| 'FR'
|
|
904
|
+
| 'GF'
|
|
905
|
+
| 'PF'
|
|
906
|
+
| 'TF'
|
|
907
|
+
| 'GA'
|
|
908
|
+
| 'GM'
|
|
909
|
+
| 'GE'
|
|
910
|
+
| 'DE'
|
|
911
|
+
| 'GH'
|
|
912
|
+
| 'GI'
|
|
913
|
+
| 'GR'
|
|
914
|
+
| 'GL'
|
|
915
|
+
| 'GD'
|
|
916
|
+
| 'GP'
|
|
917
|
+
| 'GU'
|
|
918
|
+
| 'GT'
|
|
919
|
+
| 'GN'
|
|
920
|
+
| 'GW'
|
|
921
|
+
| 'GY'
|
|
922
|
+
| 'HT'
|
|
923
|
+
| 'HM'
|
|
924
|
+
| 'VA'
|
|
925
|
+
| 'HN'
|
|
926
|
+
| 'HK'
|
|
927
|
+
| 'HU'
|
|
928
|
+
| 'IS'
|
|
929
|
+
| 'IN'
|
|
930
|
+
| 'ID'
|
|
931
|
+
| 'IR'
|
|
932
|
+
| 'IQ'
|
|
933
|
+
| 'IE'
|
|
934
|
+
| 'IL'
|
|
935
|
+
| 'IT'
|
|
936
|
+
| 'JM'
|
|
937
|
+
| 'JP'
|
|
938
|
+
| 'JO'
|
|
939
|
+
| 'KZ'
|
|
940
|
+
| 'KE'
|
|
941
|
+
| 'KI'
|
|
942
|
+
| 'KP'
|
|
943
|
+
| 'KR'
|
|
944
|
+
| 'KW'
|
|
945
|
+
| 'KG'
|
|
946
|
+
| 'LA'
|
|
947
|
+
| 'LV'
|
|
948
|
+
| 'LB'
|
|
949
|
+
| 'LS'
|
|
950
|
+
| 'LR'
|
|
951
|
+
| 'LY'
|
|
952
|
+
| 'LI'
|
|
953
|
+
| 'LT'
|
|
954
|
+
| 'LU'
|
|
955
|
+
| 'MO'
|
|
956
|
+
| 'MG'
|
|
957
|
+
| 'MW'
|
|
958
|
+
| 'MY'
|
|
959
|
+
| 'MV'
|
|
960
|
+
| 'ML'
|
|
961
|
+
| 'MT'
|
|
962
|
+
| 'MH'
|
|
963
|
+
| 'MQ'
|
|
964
|
+
| 'MR'
|
|
965
|
+
| 'MU'
|
|
966
|
+
| 'YT'
|
|
967
|
+
| 'MX'
|
|
968
|
+
| 'FM'
|
|
969
|
+
| 'MD'
|
|
970
|
+
| 'MC'
|
|
971
|
+
| 'MN'
|
|
972
|
+
| 'MS'
|
|
973
|
+
| 'MA'
|
|
974
|
+
| 'MZ'
|
|
975
|
+
| 'MM'
|
|
976
|
+
| 'NA'
|
|
977
|
+
| 'NR'
|
|
978
|
+
| 'NP'
|
|
979
|
+
| 'NL'
|
|
980
|
+
| 'NC'
|
|
981
|
+
| 'NZ'
|
|
982
|
+
| 'NI'
|
|
983
|
+
| 'NE'
|
|
984
|
+
| 'NG'
|
|
985
|
+
| 'NU'
|
|
986
|
+
| 'NF'
|
|
987
|
+
| 'MP'
|
|
988
|
+
| 'MK'
|
|
989
|
+
| 'NO'
|
|
990
|
+
| 'OM'
|
|
991
|
+
| 'PK'
|
|
992
|
+
| 'PW'
|
|
993
|
+
| 'PS'
|
|
994
|
+
| 'PA'
|
|
995
|
+
| 'PG'
|
|
996
|
+
| 'PY'
|
|
997
|
+
| 'PE'
|
|
998
|
+
| 'PH'
|
|
999
|
+
| 'PN'
|
|
1000
|
+
| 'PL'
|
|
1001
|
+
| 'PT'
|
|
1002
|
+
| 'PR'
|
|
1003
|
+
| 'QA'
|
|
1004
|
+
| 'RE'
|
|
1005
|
+
| 'RO'
|
|
1006
|
+
| 'RU'
|
|
1007
|
+
| 'RW'
|
|
1008
|
+
| 'SH'
|
|
1009
|
+
| 'KN'
|
|
1010
|
+
| 'LC'
|
|
1011
|
+
| 'PM'
|
|
1012
|
+
| 'VC'
|
|
1013
|
+
| 'WS'
|
|
1014
|
+
| 'SM'
|
|
1015
|
+
| 'ST'
|
|
1016
|
+
| 'SA'
|
|
1017
|
+
| 'SN'
|
|
1018
|
+
| 'SC'
|
|
1019
|
+
| 'SL'
|
|
1020
|
+
| 'SG'
|
|
1021
|
+
| 'SK'
|
|
1022
|
+
| 'SI'
|
|
1023
|
+
| 'SB'
|
|
1024
|
+
| 'SO'
|
|
1025
|
+
| 'ZA'
|
|
1026
|
+
| 'GS'
|
|
1027
|
+
| 'ES'
|
|
1028
|
+
| 'LK'
|
|
1029
|
+
| 'SD'
|
|
1030
|
+
| 'SR'
|
|
1031
|
+
| 'SJ'
|
|
1032
|
+
| 'SZ'
|
|
1033
|
+
| 'SE'
|
|
1034
|
+
| 'CH'
|
|
1035
|
+
| 'SY'
|
|
1036
|
+
| 'TW'
|
|
1037
|
+
| 'TJ'
|
|
1038
|
+
| 'TZ'
|
|
1039
|
+
| 'TH'
|
|
1040
|
+
| 'TL'
|
|
1041
|
+
| 'TG'
|
|
1042
|
+
| 'TK'
|
|
1043
|
+
| 'TO'
|
|
1044
|
+
| 'TT'
|
|
1045
|
+
| 'TN'
|
|
1046
|
+
| 'TR'
|
|
1047
|
+
| 'TM'
|
|
1048
|
+
| 'TC'
|
|
1049
|
+
| 'TV'
|
|
1050
|
+
| 'UG'
|
|
1051
|
+
| 'UA'
|
|
1052
|
+
| 'AE'
|
|
1053
|
+
| 'GB'
|
|
1054
|
+
| 'US'
|
|
1055
|
+
| 'UM'
|
|
1056
|
+
| 'UY'
|
|
1057
|
+
| 'UZ'
|
|
1058
|
+
| 'VU'
|
|
1059
|
+
| 'VE'
|
|
1060
|
+
| 'VN'
|
|
1061
|
+
| 'VG'
|
|
1062
|
+
| 'VI'
|
|
1063
|
+
| 'WF'
|
|
1064
|
+
| 'EH'
|
|
1065
|
+
| 'YE'
|
|
1066
|
+
| 'ZM'
|
|
1067
|
+
| 'ZW'
|
|
1068
|
+
| 'AX'
|
|
1069
|
+
| 'BQ'
|
|
1070
|
+
| 'CW'
|
|
1071
|
+
| 'GG'
|
|
1072
|
+
| 'IM'
|
|
1073
|
+
| 'JE'
|
|
1074
|
+
| 'ME'
|
|
1075
|
+
| 'BL'
|
|
1076
|
+
| 'MF'
|
|
1077
|
+
| 'RS'
|
|
1078
|
+
| 'SX'
|
|
1079
|
+
| 'SS'
|
|
1080
|
+
| 'XK';
|
|
1081
|
+
|
|
1082
|
+
/**
|
|
1083
|
+
* Primary street address.
|
|
1084
|
+
*/
|
|
1085
|
+
line_1: string;
|
|
1086
|
+
|
|
1087
|
+
/**
|
|
1088
|
+
* Secondary street address, or null if not recorded.
|
|
1089
|
+
*/
|
|
1090
|
+
line_2: string | null;
|
|
1091
|
+
|
|
1092
|
+
/**
|
|
1093
|
+
* Postal or ZIP code.
|
|
1094
|
+
*/
|
|
1095
|
+
postal_code: string;
|
|
1096
|
+
|
|
1097
|
+
/**
|
|
1098
|
+
* State, province, or region, or null if not recorded.
|
|
1099
|
+
*/
|
|
1100
|
+
state: string | null;
|
|
1101
|
+
}
|
|
355
1102
|
}
|
|
356
1103
|
|
|
357
1104
|
/**
|
|
358
|
-
* The
|
|
1105
|
+
* The resource that originated this transaction, or null when it does not map to a
|
|
1106
|
+
* retrievable resource.
|
|
359
1107
|
*/
|
|
360
|
-
export interface
|
|
1108
|
+
export interface Source {
|
|
361
1109
|
/**
|
|
362
|
-
* Identifier of the
|
|
1110
|
+
* Identifier of the originating resource, retrievable on its own endpoint.
|
|
363
1111
|
*/
|
|
364
1112
|
id: string;
|
|
365
1113
|
|
|
366
1114
|
/**
|
|
367
|
-
* Type of the
|
|
1115
|
+
* Type of the resource that originated this transaction.
|
|
368
1116
|
*/
|
|
369
|
-
type: 'deposit' | '
|
|
1117
|
+
type: 'deposit' | 'payout' | 'return';
|
|
370
1118
|
}
|
|
371
1119
|
}
|
|
372
1120
|
|
|
@@ -376,19 +1124,19 @@ export interface TransactionListParams extends CursorPageParams {
|
|
|
376
1124
|
*/
|
|
377
1125
|
account_id: string;
|
|
378
1126
|
|
|
379
|
-
|
|
1127
|
+
booked_at?: TransactionListParams.BookedAt;
|
|
380
1128
|
}
|
|
381
1129
|
|
|
382
1130
|
export namespace TransactionListParams {
|
|
383
|
-
export interface
|
|
1131
|
+
export interface BookedAt {
|
|
384
1132
|
/**
|
|
385
|
-
* Include transactions whose
|
|
1133
|
+
* Include transactions whose booked_at is greater than or equal to this ISO 8601
|
|
386
1134
|
* timestamp.
|
|
387
1135
|
*/
|
|
388
1136
|
gte?: string;
|
|
389
1137
|
|
|
390
1138
|
/**
|
|
391
|
-
* Include transactions whose
|
|
1139
|
+
* Include transactions whose booked_at is less than or equal to this ISO 8601
|
|
392
1140
|
* timestamp.
|
|
393
1141
|
*/
|
|
394
1142
|
lte?: string;
|