@getivy/node-sdk 1.4.0 → 1.6.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.
- package/CHANGELOG.md +96 -0
- package/LICENSE +1 -1
- package/core.d.ts +1 -1
- package/core.d.ts.map +1 -1
- package/core.js +10 -15
- package/core.js.map +1 -1
- package/core.mjs +10 -15
- package/core.mjs.map +1 -1
- package/index.d.mts +7 -4
- package/index.d.ts +7 -4
- package/index.d.ts.map +1 -1
- package/index.js +4 -0
- package/index.js.map +1 -1
- package/index.mjs +4 -0
- package/index.mjs.map +1 -1
- package/internal/utils/query.d.ts +5 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +24 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +20 -0
- package/internal/utils/query.mjs.map +1 -0
- package/package.json +1 -1
- package/resources/balance.d.ts +9 -3
- package/resources/balance.d.ts.map +1 -1
- package/resources/checkoutsession.d.ts +80 -121
- package/resources/checkoutsession.d.ts.map +1 -1
- package/resources/data/accounts.d.ts +12 -1
- package/resources/data/accounts.d.ts.map +1 -1
- package/resources/data/transactions.d.ts +19 -133
- package/resources/data/transactions.d.ts.map +1 -1
- package/resources/deposits.d.ts +32 -6
- package/resources/deposits.d.ts.map +1 -1
- package/resources/fx.d.ts +70 -6
- package/resources/fx.d.ts.map +1 -1
- package/resources/fx.js +6 -0
- package/resources/fx.js.map +1 -1
- package/resources/fx.mjs +6 -0
- package/resources/fx.mjs.map +1 -1
- package/resources/index.d.ts +3 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/orders.d.ts +147 -141
- package/resources/orders.d.ts.map +1 -1
- package/resources/payee.d.ts +50 -0
- package/resources/payee.d.ts.map +1 -0
- package/resources/payee.js +30 -0
- package/resources/payee.js.map +1 -0
- package/resources/payee.mjs +26 -0
- package/resources/payee.mjs.map +1 -0
- package/resources/payouts.d.ts +124 -18
- package/resources/payouts.d.ts.map +1 -1
- package/resources/refunds.d.ts +3 -9
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs.map +1 -1
- package/resources/returns.d.ts +2 -2
- package/resources/returns.d.ts.map +1 -1
- package/resources/transactions.d.ts +25 -2
- package/resources/transactions.d.ts.map +1 -1
- package/resources/webhook/subscription.d.ts +5 -5
- package/resources/webhook/subscription.d.ts.map +1 -1
- package/src/core.ts +13 -19
- package/src/index.ts +14 -2
- package/src/internal/utils/query.ts +23 -0
- package/src/resources/balance.ts +10 -3
- package/src/resources/checkoutsession.ts +360 -178
- package/src/resources/data/accounts.ts +15 -1
- package/src/resources/data/transactions.ts +19 -175
- package/src/resources/deposits.ts +56 -6
- package/src/resources/fx.ts +83 -5
- package/src/resources/index.ts +3 -1
- package/src/resources/orders.ts +195 -189
- package/src/resources/payee.ts +63 -0
- package/src/resources/payouts.ts +208 -18
- package/src/resources/refunds.ts +2 -29
- package/src/resources/returns.ts +2 -2
- package/src/resources/transactions.ts +38 -2
- package/src/resources/webhook/subscription.ts +15 -20
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/orders.d.ts
CHANGED
|
@@ -56,7 +56,7 @@ export interface OrderCreateResponse {
|
|
|
56
56
|
* The status of the order. As soon as this value is 'paid', you can ship the
|
|
57
57
|
* order.
|
|
58
58
|
*/
|
|
59
|
-
status: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
59
|
+
status: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
60
60
|
updatedAt: unknown;
|
|
61
61
|
/**
|
|
62
62
|
* The unique identifier of the customer's bank.
|
|
@@ -93,7 +93,6 @@ export interface OrderCreateResponse {
|
|
|
93
93
|
* The list of line items sold with the order.
|
|
94
94
|
*/
|
|
95
95
|
lineItems?: Array<OrderCreateResponse.LineItem>;
|
|
96
|
-
mandate?: OrderCreateResponse.Mandate;
|
|
97
96
|
/**
|
|
98
97
|
* The financial address of the merchant associated with the order. Only available
|
|
99
98
|
* when requested via order/details and therefore requires authentication.
|
|
@@ -115,7 +114,7 @@ export interface OrderCreateResponse {
|
|
|
115
114
|
* after successful PIS flow.
|
|
116
115
|
*/
|
|
117
116
|
payerFinancialAddress?: OrderCreateResponse.PayerFinancialAddress;
|
|
118
|
-
paymentMethodType?: '
|
|
117
|
+
paymentMethodType?: 'customer_balance' | 'manual_bank_transfer';
|
|
119
118
|
/**
|
|
120
119
|
* The payment mode of the order. Can be either settlement or direct.
|
|
121
120
|
*/
|
|
@@ -132,11 +131,6 @@ export interface OrderCreateResponse {
|
|
|
132
131
|
* All partial and total refunds of this order.
|
|
133
132
|
*/
|
|
134
133
|
refunds?: Array<OrderCreateResponse.Refund>;
|
|
135
|
-
/**
|
|
136
|
-
* If set to true, a payment mandate will be created for the user. This is
|
|
137
|
-
* currently in alpha and defaults to false.
|
|
138
|
-
*/
|
|
139
|
-
setupPaymentMandate?: boolean;
|
|
140
134
|
shippingAddress?: OrderCreateResponse.ShippingAddress;
|
|
141
135
|
shopLogo?: string;
|
|
142
136
|
/**
|
|
@@ -175,12 +169,12 @@ export declare namespace OrderCreateResponse {
|
|
|
175
169
|
interface BillingAddress {
|
|
176
170
|
city: string;
|
|
177
171
|
country: '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';
|
|
178
|
-
firstName: string;
|
|
179
|
-
lastName: string;
|
|
180
172
|
line1: string;
|
|
181
|
-
line2: string;
|
|
182
|
-
region: string;
|
|
183
173
|
zipCode: string;
|
|
174
|
+
firstName?: string;
|
|
175
|
+
lastName?: string;
|
|
176
|
+
line2?: string;
|
|
177
|
+
region?: string;
|
|
184
178
|
}
|
|
185
179
|
interface ClimateActionMode {
|
|
186
180
|
amount: number;
|
|
@@ -199,12 +193,13 @@ export declare namespace OrderCreateResponse {
|
|
|
199
193
|
}
|
|
200
194
|
namespace Destination {
|
|
201
195
|
interface BankAccount {
|
|
202
|
-
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
196
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet';
|
|
203
197
|
bankCode?: BankAccount.BankCode;
|
|
204
198
|
bban?: BankAccount.Bban;
|
|
205
199
|
iban?: BankAccount.Iban;
|
|
206
200
|
paymentReference?: string;
|
|
207
201
|
sortCode?: BankAccount.SortCode;
|
|
202
|
+
wallet?: BankAccount.Wallet;
|
|
208
203
|
}
|
|
209
204
|
namespace BankAccount {
|
|
210
205
|
interface BankCode {
|
|
@@ -227,6 +222,16 @@ export declare namespace OrderCreateResponse {
|
|
|
227
222
|
accountNumber: string;
|
|
228
223
|
sortCode: string;
|
|
229
224
|
}
|
|
225
|
+
interface Wallet {
|
|
226
|
+
/**
|
|
227
|
+
* The blockchain wallet address
|
|
228
|
+
*/
|
|
229
|
+
address: string;
|
|
230
|
+
/**
|
|
231
|
+
* The blockchain network
|
|
232
|
+
*/
|
|
233
|
+
blockchain: 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
|
|
234
|
+
}
|
|
230
235
|
}
|
|
231
236
|
}
|
|
232
237
|
interface LineItem {
|
|
@@ -257,42 +262,18 @@ export declare namespace OrderCreateResponse {
|
|
|
257
262
|
*/
|
|
258
263
|
referenceId?: string;
|
|
259
264
|
}
|
|
260
|
-
interface Mandate {
|
|
261
|
-
accountHolderName: string;
|
|
262
|
-
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
263
|
-
creditor?: Mandate.Creditor;
|
|
264
|
-
reference?: string;
|
|
265
|
-
referenceId?: string;
|
|
266
|
-
setup?: boolean;
|
|
267
|
-
userNotificationEmail?: string;
|
|
268
|
-
}
|
|
269
|
-
namespace Mandate {
|
|
270
|
-
interface AdditionalDisplayInformation {
|
|
271
|
-
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
272
|
-
price?: AdditionalDisplayInformation.Price;
|
|
273
|
-
}
|
|
274
|
-
namespace AdditionalDisplayInformation {
|
|
275
|
-
interface Price {
|
|
276
|
-
amount: number;
|
|
277
|
-
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
278
|
-
}
|
|
279
|
-
}
|
|
280
|
-
interface Creditor {
|
|
281
|
-
id?: string;
|
|
282
|
-
name?: string;
|
|
283
|
-
}
|
|
284
|
-
}
|
|
285
265
|
/**
|
|
286
266
|
* The financial address of the merchant associated with the order. Only available
|
|
287
267
|
* when requested via order/details and therefore requires authentication.
|
|
288
268
|
*/
|
|
289
269
|
interface MerchantFinancialAddress {
|
|
290
|
-
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
270
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet';
|
|
291
271
|
bankCode?: MerchantFinancialAddress.BankCode;
|
|
292
272
|
bban?: MerchantFinancialAddress.Bban;
|
|
293
273
|
iban?: MerchantFinancialAddress.Iban;
|
|
294
274
|
paymentReference?: string;
|
|
295
275
|
sortCode?: MerchantFinancialAddress.SortCode;
|
|
276
|
+
wallet?: MerchantFinancialAddress.Wallet;
|
|
296
277
|
}
|
|
297
278
|
namespace MerchantFinancialAddress {
|
|
298
279
|
interface BankCode {
|
|
@@ -315,17 +296,28 @@ export declare namespace OrderCreateResponse {
|
|
|
315
296
|
accountNumber: string;
|
|
316
297
|
sortCode: string;
|
|
317
298
|
}
|
|
299
|
+
interface Wallet {
|
|
300
|
+
/**
|
|
301
|
+
* The blockchain wallet address
|
|
302
|
+
*/
|
|
303
|
+
address: string;
|
|
304
|
+
/**
|
|
305
|
+
* The blockchain network
|
|
306
|
+
*/
|
|
307
|
+
blockchain: 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
|
|
308
|
+
}
|
|
318
309
|
}
|
|
319
310
|
/**
|
|
320
311
|
* The financial address of the payer associated with the order. Only available
|
|
321
312
|
* after successful PIS flow.
|
|
322
313
|
*/
|
|
323
314
|
interface PayerFinancialAddress {
|
|
324
|
-
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
315
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet';
|
|
325
316
|
bankCode?: PayerFinancialAddress.BankCode;
|
|
326
317
|
bban?: PayerFinancialAddress.Bban;
|
|
327
318
|
iban?: PayerFinancialAddress.Iban;
|
|
328
319
|
sortCode?: PayerFinancialAddress.SortCode;
|
|
320
|
+
wallet?: PayerFinancialAddress.Wallet;
|
|
329
321
|
}
|
|
330
322
|
namespace PayerFinancialAddress {
|
|
331
323
|
interface BankCode {
|
|
@@ -348,6 +340,16 @@ export declare namespace OrderCreateResponse {
|
|
|
348
340
|
sortCode: string;
|
|
349
341
|
accountHolderName?: string;
|
|
350
342
|
}
|
|
343
|
+
interface Wallet {
|
|
344
|
+
/**
|
|
345
|
+
* The blockchain wallet address
|
|
346
|
+
*/
|
|
347
|
+
address: string;
|
|
348
|
+
/**
|
|
349
|
+
* The blockchain network
|
|
350
|
+
*/
|
|
351
|
+
blockchain: 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
|
|
352
|
+
}
|
|
351
353
|
}
|
|
352
354
|
interface Refund {
|
|
353
355
|
/**
|
|
@@ -381,12 +383,12 @@ export declare namespace OrderCreateResponse {
|
|
|
381
383
|
interface ShippingAddress {
|
|
382
384
|
city: string;
|
|
383
385
|
country: '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';
|
|
384
|
-
firstName: string;
|
|
385
|
-
lastName: string;
|
|
386
386
|
line1: string;
|
|
387
|
-
line2: string;
|
|
388
|
-
region: string;
|
|
389
387
|
zipCode: string;
|
|
388
|
+
firstName?: string;
|
|
389
|
+
lastName?: string;
|
|
390
|
+
line2?: string;
|
|
391
|
+
region?: string;
|
|
390
392
|
}
|
|
391
393
|
/**
|
|
392
394
|
* Information about the customer who finished the order.
|
|
@@ -397,14 +399,14 @@ export declare namespace OrderCreateResponse {
|
|
|
397
399
|
}
|
|
398
400
|
interface StatusClassification {
|
|
399
401
|
primary: 'payment_authorisation_failed' | 'payment_execution_failed' | 'payment_abandoned';
|
|
400
|
-
secondary?: 'timeout' | 'wrong_credentials' | 'incorrect_2fa_response' | 'payment_rejected' | 'insufficient_funds' | 'cancelled' | 'connection_to_bank_failed' | 'international_transfer_blocked' | 'international_transfer_limit_exceeded' | 'user_blocked' | 'bank_error' | 'instant_transfers_not_enabled' | 'no_active_tan_methods_available' | 'account_limit_exceeded' | 'bank_under_maintenance' | 'pin_blocked' | 'payment_not_settled' | 'unsupported_bank_account';
|
|
402
|
+
secondary?: 'timeout' | 'wrong_credentials' | 'incorrect_2fa_response' | 'payment_rejected' | 'insufficient_funds' | 'cancelled' | 'connection_to_bank_failed' | 'international_transfer_blocked' | 'international_transfer_limit_exceeded' | 'user_blocked' | 'bank_error' | 'instant_transfers_not_enabled' | 'no_active_tan_methods_available' | 'account_limit_exceeded' | 'bank_under_maintenance' | 'pin_blocked' | 'payment_not_settled' | 'unsupported_bank_account' | 'online_banking_login_required' | 'deutsche_bank_psu_migration' | 'out_of_operational_hours';
|
|
401
403
|
}
|
|
402
404
|
interface StatusHistoryList {
|
|
403
405
|
createdAt: unknown;
|
|
404
|
-
currentStatus: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
406
|
+
currentStatus: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
405
407
|
reason: 'ORDER_CREATED' | 'CHECKOUT_SESSION_ABORTED' | 'PAYMENT_SUCCEEDED' | 'PAYMENT_INITIATED' | 'ORDER_CANCELED' | 'ORDER_EXPIRED_BY_MERCHANT' | 'ORDER_REFUND_INITIATED' | 'ORDER_REFUNDED' | 'REFUND_CHARGE_SUCCEEDED' | 'REFUND_UPDATED' | 'CHECKOUT_COMPLETED' | 'PIS_PAYMENT_INITIATED' | 'PIS_PAYMENT_UPDATED' | 'PIS_PAYMENT_SUCCEEDED' | 'PAYMENT_NOT_SETTLED' | 'PAYMENT_INITIATION_FAILED' | 'PAYMENT_CANCELED' | 'PAYMENT_FAILED' | 'CHECKOUT_SESSION_CREATED' | 'EXPIRED_CHECKOUT_SESSION_ABORTED' | 'DISPUTE' | 'PENDING_PAYMENT_ATTEMPTS_FOUND' | 'AML_FREEZE' | 'MANUAL_FREEZE' | 'MANUAL_UNFREEZE' | 'ORDER_MANUALLY_REOPENED' | 'ORDER_FINALIZATION_STARTED';
|
|
406
408
|
updatedAt: unknown;
|
|
407
|
-
previousStatus?: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing' | null;
|
|
409
|
+
previousStatus?: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing' | null;
|
|
408
410
|
}
|
|
409
411
|
}
|
|
410
412
|
export interface OrderRetrieveResponse {
|
|
@@ -443,7 +445,7 @@ export interface OrderRetrieveResponse {
|
|
|
443
445
|
* The status of the order. As soon as this value is 'paid', you can ship the
|
|
444
446
|
* order.
|
|
445
447
|
*/
|
|
446
|
-
status: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
448
|
+
status: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
447
449
|
updatedAt: unknown;
|
|
448
450
|
/**
|
|
449
451
|
* The unique identifier of the customer's bank.
|
|
@@ -480,7 +482,6 @@ export interface OrderRetrieveResponse {
|
|
|
480
482
|
* The list of line items sold with the order.
|
|
481
483
|
*/
|
|
482
484
|
lineItems?: Array<OrderRetrieveResponse.LineItem>;
|
|
483
|
-
mandate?: OrderRetrieveResponse.Mandate;
|
|
484
485
|
/**
|
|
485
486
|
* The financial address of the merchant associated with the order. Only available
|
|
486
487
|
* when requested via order/details and therefore requires authentication.
|
|
@@ -502,7 +503,7 @@ export interface OrderRetrieveResponse {
|
|
|
502
503
|
* after successful PIS flow.
|
|
503
504
|
*/
|
|
504
505
|
payerFinancialAddress?: OrderRetrieveResponse.PayerFinancialAddress;
|
|
505
|
-
paymentMethodType?: '
|
|
506
|
+
paymentMethodType?: 'customer_balance' | 'manual_bank_transfer';
|
|
506
507
|
/**
|
|
507
508
|
* The payment mode of the order. Can be either settlement or direct.
|
|
508
509
|
*/
|
|
@@ -519,11 +520,6 @@ export interface OrderRetrieveResponse {
|
|
|
519
520
|
* All partial and total refunds of this order.
|
|
520
521
|
*/
|
|
521
522
|
refunds?: Array<OrderRetrieveResponse.Refund>;
|
|
522
|
-
/**
|
|
523
|
-
* If set to true, a payment mandate will be created for the user. This is
|
|
524
|
-
* currently in alpha and defaults to false.
|
|
525
|
-
*/
|
|
526
|
-
setupPaymentMandate?: boolean;
|
|
527
523
|
shippingAddress?: OrderRetrieveResponse.ShippingAddress;
|
|
528
524
|
shopLogo?: string;
|
|
529
525
|
/**
|
|
@@ -562,12 +558,12 @@ export declare namespace OrderRetrieveResponse {
|
|
|
562
558
|
interface BillingAddress {
|
|
563
559
|
city: string;
|
|
564
560
|
country: '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';
|
|
565
|
-
firstName: string;
|
|
566
|
-
lastName: string;
|
|
567
561
|
line1: string;
|
|
568
|
-
line2: string;
|
|
569
|
-
region: string;
|
|
570
562
|
zipCode: string;
|
|
563
|
+
firstName?: string;
|
|
564
|
+
lastName?: string;
|
|
565
|
+
line2?: string;
|
|
566
|
+
region?: string;
|
|
571
567
|
}
|
|
572
568
|
interface ClimateActionMode {
|
|
573
569
|
amount: number;
|
|
@@ -586,12 +582,13 @@ export declare namespace OrderRetrieveResponse {
|
|
|
586
582
|
}
|
|
587
583
|
namespace Destination {
|
|
588
584
|
interface BankAccount {
|
|
589
|
-
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
585
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet';
|
|
590
586
|
bankCode?: BankAccount.BankCode;
|
|
591
587
|
bban?: BankAccount.Bban;
|
|
592
588
|
iban?: BankAccount.Iban;
|
|
593
589
|
paymentReference?: string;
|
|
594
590
|
sortCode?: BankAccount.SortCode;
|
|
591
|
+
wallet?: BankAccount.Wallet;
|
|
595
592
|
}
|
|
596
593
|
namespace BankAccount {
|
|
597
594
|
interface BankCode {
|
|
@@ -614,6 +611,16 @@ export declare namespace OrderRetrieveResponse {
|
|
|
614
611
|
accountNumber: string;
|
|
615
612
|
sortCode: string;
|
|
616
613
|
}
|
|
614
|
+
interface Wallet {
|
|
615
|
+
/**
|
|
616
|
+
* The blockchain wallet address
|
|
617
|
+
*/
|
|
618
|
+
address: string;
|
|
619
|
+
/**
|
|
620
|
+
* The blockchain network
|
|
621
|
+
*/
|
|
622
|
+
blockchain: 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
|
|
623
|
+
}
|
|
617
624
|
}
|
|
618
625
|
}
|
|
619
626
|
interface LineItem {
|
|
@@ -644,42 +651,18 @@ export declare namespace OrderRetrieveResponse {
|
|
|
644
651
|
*/
|
|
645
652
|
referenceId?: string;
|
|
646
653
|
}
|
|
647
|
-
interface Mandate {
|
|
648
|
-
accountHolderName: string;
|
|
649
|
-
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
650
|
-
creditor?: Mandate.Creditor;
|
|
651
|
-
reference?: string;
|
|
652
|
-
referenceId?: string;
|
|
653
|
-
setup?: boolean;
|
|
654
|
-
userNotificationEmail?: string;
|
|
655
|
-
}
|
|
656
|
-
namespace Mandate {
|
|
657
|
-
interface AdditionalDisplayInformation {
|
|
658
|
-
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
659
|
-
price?: AdditionalDisplayInformation.Price;
|
|
660
|
-
}
|
|
661
|
-
namespace AdditionalDisplayInformation {
|
|
662
|
-
interface Price {
|
|
663
|
-
amount: number;
|
|
664
|
-
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
665
|
-
}
|
|
666
|
-
}
|
|
667
|
-
interface Creditor {
|
|
668
|
-
id?: string;
|
|
669
|
-
name?: string;
|
|
670
|
-
}
|
|
671
|
-
}
|
|
672
654
|
/**
|
|
673
655
|
* The financial address of the merchant associated with the order. Only available
|
|
674
656
|
* when requested via order/details and therefore requires authentication.
|
|
675
657
|
*/
|
|
676
658
|
interface MerchantFinancialAddress {
|
|
677
|
-
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
659
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet';
|
|
678
660
|
bankCode?: MerchantFinancialAddress.BankCode;
|
|
679
661
|
bban?: MerchantFinancialAddress.Bban;
|
|
680
662
|
iban?: MerchantFinancialAddress.Iban;
|
|
681
663
|
paymentReference?: string;
|
|
682
664
|
sortCode?: MerchantFinancialAddress.SortCode;
|
|
665
|
+
wallet?: MerchantFinancialAddress.Wallet;
|
|
683
666
|
}
|
|
684
667
|
namespace MerchantFinancialAddress {
|
|
685
668
|
interface BankCode {
|
|
@@ -702,17 +685,28 @@ export declare namespace OrderRetrieveResponse {
|
|
|
702
685
|
accountNumber: string;
|
|
703
686
|
sortCode: string;
|
|
704
687
|
}
|
|
688
|
+
interface Wallet {
|
|
689
|
+
/**
|
|
690
|
+
* The blockchain wallet address
|
|
691
|
+
*/
|
|
692
|
+
address: string;
|
|
693
|
+
/**
|
|
694
|
+
* The blockchain network
|
|
695
|
+
*/
|
|
696
|
+
blockchain: 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
|
|
697
|
+
}
|
|
705
698
|
}
|
|
706
699
|
/**
|
|
707
700
|
* The financial address of the payer associated with the order. Only available
|
|
708
701
|
* after successful PIS flow.
|
|
709
702
|
*/
|
|
710
703
|
interface PayerFinancialAddress {
|
|
711
|
-
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
704
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet';
|
|
712
705
|
bankCode?: PayerFinancialAddress.BankCode;
|
|
713
706
|
bban?: PayerFinancialAddress.Bban;
|
|
714
707
|
iban?: PayerFinancialAddress.Iban;
|
|
715
708
|
sortCode?: PayerFinancialAddress.SortCode;
|
|
709
|
+
wallet?: PayerFinancialAddress.Wallet;
|
|
716
710
|
}
|
|
717
711
|
namespace PayerFinancialAddress {
|
|
718
712
|
interface BankCode {
|
|
@@ -735,6 +729,16 @@ export declare namespace OrderRetrieveResponse {
|
|
|
735
729
|
sortCode: string;
|
|
736
730
|
accountHolderName?: string;
|
|
737
731
|
}
|
|
732
|
+
interface Wallet {
|
|
733
|
+
/**
|
|
734
|
+
* The blockchain wallet address
|
|
735
|
+
*/
|
|
736
|
+
address: string;
|
|
737
|
+
/**
|
|
738
|
+
* The blockchain network
|
|
739
|
+
*/
|
|
740
|
+
blockchain: 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
|
|
741
|
+
}
|
|
738
742
|
}
|
|
739
743
|
interface Refund {
|
|
740
744
|
/**
|
|
@@ -768,12 +772,12 @@ export declare namespace OrderRetrieveResponse {
|
|
|
768
772
|
interface ShippingAddress {
|
|
769
773
|
city: string;
|
|
770
774
|
country: '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';
|
|
771
|
-
firstName: string;
|
|
772
|
-
lastName: string;
|
|
773
775
|
line1: string;
|
|
774
|
-
line2: string;
|
|
775
|
-
region: string;
|
|
776
776
|
zipCode: string;
|
|
777
|
+
firstName?: string;
|
|
778
|
+
lastName?: string;
|
|
779
|
+
line2?: string;
|
|
780
|
+
region?: string;
|
|
777
781
|
}
|
|
778
782
|
/**
|
|
779
783
|
* Information about the customer who finished the order.
|
|
@@ -784,14 +788,14 @@ export declare namespace OrderRetrieveResponse {
|
|
|
784
788
|
}
|
|
785
789
|
interface StatusClassification {
|
|
786
790
|
primary: 'payment_authorisation_failed' | 'payment_execution_failed' | 'payment_abandoned';
|
|
787
|
-
secondary?: 'timeout' | 'wrong_credentials' | 'incorrect_2fa_response' | 'payment_rejected' | 'insufficient_funds' | 'cancelled' | 'connection_to_bank_failed' | 'international_transfer_blocked' | 'international_transfer_limit_exceeded' | 'user_blocked' | 'bank_error' | 'instant_transfers_not_enabled' | 'no_active_tan_methods_available' | 'account_limit_exceeded' | 'bank_under_maintenance' | 'pin_blocked' | 'payment_not_settled' | 'unsupported_bank_account';
|
|
791
|
+
secondary?: 'timeout' | 'wrong_credentials' | 'incorrect_2fa_response' | 'payment_rejected' | 'insufficient_funds' | 'cancelled' | 'connection_to_bank_failed' | 'international_transfer_blocked' | 'international_transfer_limit_exceeded' | 'user_blocked' | 'bank_error' | 'instant_transfers_not_enabled' | 'no_active_tan_methods_available' | 'account_limit_exceeded' | 'bank_under_maintenance' | 'pin_blocked' | 'payment_not_settled' | 'unsupported_bank_account' | 'online_banking_login_required' | 'deutsche_bank_psu_migration' | 'out_of_operational_hours';
|
|
788
792
|
}
|
|
789
793
|
interface StatusHistoryList {
|
|
790
794
|
createdAt: unknown;
|
|
791
|
-
currentStatus: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
795
|
+
currentStatus: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
792
796
|
reason: 'ORDER_CREATED' | 'CHECKOUT_SESSION_ABORTED' | 'PAYMENT_SUCCEEDED' | 'PAYMENT_INITIATED' | 'ORDER_CANCELED' | 'ORDER_EXPIRED_BY_MERCHANT' | 'ORDER_REFUND_INITIATED' | 'ORDER_REFUNDED' | 'REFUND_CHARGE_SUCCEEDED' | 'REFUND_UPDATED' | 'CHECKOUT_COMPLETED' | 'PIS_PAYMENT_INITIATED' | 'PIS_PAYMENT_UPDATED' | 'PIS_PAYMENT_SUCCEEDED' | 'PAYMENT_NOT_SETTLED' | 'PAYMENT_INITIATION_FAILED' | 'PAYMENT_CANCELED' | 'PAYMENT_FAILED' | 'CHECKOUT_SESSION_CREATED' | 'EXPIRED_CHECKOUT_SESSION_ABORTED' | 'DISPUTE' | 'PENDING_PAYMENT_ATTEMPTS_FOUND' | 'AML_FREEZE' | 'MANUAL_FREEZE' | 'MANUAL_UNFREEZE' | 'ORDER_MANUALLY_REOPENED' | 'ORDER_FINALIZATION_STARTED';
|
|
793
797
|
updatedAt: unknown;
|
|
794
|
-
previousStatus?: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing' | null;
|
|
798
|
+
previousStatus?: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing' | null;
|
|
795
799
|
}
|
|
796
800
|
}
|
|
797
801
|
export interface OrderExpireResponse {
|
|
@@ -830,7 +834,7 @@ export interface OrderExpireResponse {
|
|
|
830
834
|
* The status of the order. As soon as this value is 'paid', you can ship the
|
|
831
835
|
* order.
|
|
832
836
|
*/
|
|
833
|
-
status: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
837
|
+
status: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
834
838
|
updatedAt: unknown;
|
|
835
839
|
/**
|
|
836
840
|
* The unique identifier of the customer's bank.
|
|
@@ -867,7 +871,6 @@ export interface OrderExpireResponse {
|
|
|
867
871
|
* The list of line items sold with the order.
|
|
868
872
|
*/
|
|
869
873
|
lineItems?: Array<OrderExpireResponse.LineItem>;
|
|
870
|
-
mandate?: OrderExpireResponse.Mandate;
|
|
871
874
|
/**
|
|
872
875
|
* The financial address of the merchant associated with the order. Only available
|
|
873
876
|
* when requested via order/details and therefore requires authentication.
|
|
@@ -889,7 +892,7 @@ export interface OrderExpireResponse {
|
|
|
889
892
|
* after successful PIS flow.
|
|
890
893
|
*/
|
|
891
894
|
payerFinancialAddress?: OrderExpireResponse.PayerFinancialAddress;
|
|
892
|
-
paymentMethodType?: '
|
|
895
|
+
paymentMethodType?: 'customer_balance' | 'manual_bank_transfer';
|
|
893
896
|
/**
|
|
894
897
|
* The payment mode of the order. Can be either settlement or direct.
|
|
895
898
|
*/
|
|
@@ -906,11 +909,6 @@ export interface OrderExpireResponse {
|
|
|
906
909
|
* All partial and total refunds of this order.
|
|
907
910
|
*/
|
|
908
911
|
refunds?: Array<OrderExpireResponse.Refund>;
|
|
909
|
-
/**
|
|
910
|
-
* If set to true, a payment mandate will be created for the user. This is
|
|
911
|
-
* currently in alpha and defaults to false.
|
|
912
|
-
*/
|
|
913
|
-
setupPaymentMandate?: boolean;
|
|
914
912
|
shippingAddress?: OrderExpireResponse.ShippingAddress;
|
|
915
913
|
shopLogo?: string;
|
|
916
914
|
/**
|
|
@@ -949,12 +947,12 @@ export declare namespace OrderExpireResponse {
|
|
|
949
947
|
interface BillingAddress {
|
|
950
948
|
city: string;
|
|
951
949
|
country: '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';
|
|
952
|
-
firstName: string;
|
|
953
|
-
lastName: string;
|
|
954
950
|
line1: string;
|
|
955
|
-
line2: string;
|
|
956
|
-
region: string;
|
|
957
951
|
zipCode: string;
|
|
952
|
+
firstName?: string;
|
|
953
|
+
lastName?: string;
|
|
954
|
+
line2?: string;
|
|
955
|
+
region?: string;
|
|
958
956
|
}
|
|
959
957
|
interface ClimateActionMode {
|
|
960
958
|
amount: number;
|
|
@@ -973,12 +971,13 @@ export declare namespace OrderExpireResponse {
|
|
|
973
971
|
}
|
|
974
972
|
namespace Destination {
|
|
975
973
|
interface BankAccount {
|
|
976
|
-
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
974
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet';
|
|
977
975
|
bankCode?: BankAccount.BankCode;
|
|
978
976
|
bban?: BankAccount.Bban;
|
|
979
977
|
iban?: BankAccount.Iban;
|
|
980
978
|
paymentReference?: string;
|
|
981
979
|
sortCode?: BankAccount.SortCode;
|
|
980
|
+
wallet?: BankAccount.Wallet;
|
|
982
981
|
}
|
|
983
982
|
namespace BankAccount {
|
|
984
983
|
interface BankCode {
|
|
@@ -1001,6 +1000,16 @@ export declare namespace OrderExpireResponse {
|
|
|
1001
1000
|
accountNumber: string;
|
|
1002
1001
|
sortCode: string;
|
|
1003
1002
|
}
|
|
1003
|
+
interface Wallet {
|
|
1004
|
+
/**
|
|
1005
|
+
* The blockchain wallet address
|
|
1006
|
+
*/
|
|
1007
|
+
address: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* The blockchain network
|
|
1010
|
+
*/
|
|
1011
|
+
blockchain: 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
|
|
1012
|
+
}
|
|
1004
1013
|
}
|
|
1005
1014
|
}
|
|
1006
1015
|
interface LineItem {
|
|
@@ -1031,42 +1040,18 @@ export declare namespace OrderExpireResponse {
|
|
|
1031
1040
|
*/
|
|
1032
1041
|
referenceId?: string;
|
|
1033
1042
|
}
|
|
1034
|
-
interface Mandate {
|
|
1035
|
-
accountHolderName: string;
|
|
1036
|
-
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
1037
|
-
creditor?: Mandate.Creditor;
|
|
1038
|
-
reference?: string;
|
|
1039
|
-
referenceId?: string;
|
|
1040
|
-
setup?: boolean;
|
|
1041
|
-
userNotificationEmail?: string;
|
|
1042
|
-
}
|
|
1043
|
-
namespace Mandate {
|
|
1044
|
-
interface AdditionalDisplayInformation {
|
|
1045
|
-
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
1046
|
-
price?: AdditionalDisplayInformation.Price;
|
|
1047
|
-
}
|
|
1048
|
-
namespace AdditionalDisplayInformation {
|
|
1049
|
-
interface Price {
|
|
1050
|
-
amount: number;
|
|
1051
|
-
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
1052
|
-
}
|
|
1053
|
-
}
|
|
1054
|
-
interface Creditor {
|
|
1055
|
-
id?: string;
|
|
1056
|
-
name?: string;
|
|
1057
|
-
}
|
|
1058
|
-
}
|
|
1059
1043
|
/**
|
|
1060
1044
|
* The financial address of the merchant associated with the order. Only available
|
|
1061
1045
|
* when requested via order/details and therefore requires authentication.
|
|
1062
1046
|
*/
|
|
1063
1047
|
interface MerchantFinancialAddress {
|
|
1064
|
-
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
1048
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet';
|
|
1065
1049
|
bankCode?: MerchantFinancialAddress.BankCode;
|
|
1066
1050
|
bban?: MerchantFinancialAddress.Bban;
|
|
1067
1051
|
iban?: MerchantFinancialAddress.Iban;
|
|
1068
1052
|
paymentReference?: string;
|
|
1069
1053
|
sortCode?: MerchantFinancialAddress.SortCode;
|
|
1054
|
+
wallet?: MerchantFinancialAddress.Wallet;
|
|
1070
1055
|
}
|
|
1071
1056
|
namespace MerchantFinancialAddress {
|
|
1072
1057
|
interface BankCode {
|
|
@@ -1089,17 +1074,28 @@ export declare namespace OrderExpireResponse {
|
|
|
1089
1074
|
accountNumber: string;
|
|
1090
1075
|
sortCode: string;
|
|
1091
1076
|
}
|
|
1077
|
+
interface Wallet {
|
|
1078
|
+
/**
|
|
1079
|
+
* The blockchain wallet address
|
|
1080
|
+
*/
|
|
1081
|
+
address: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* The blockchain network
|
|
1084
|
+
*/
|
|
1085
|
+
blockchain: 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
|
|
1086
|
+
}
|
|
1092
1087
|
}
|
|
1093
1088
|
/**
|
|
1094
1089
|
* The financial address of the payer associated with the order. Only available
|
|
1095
1090
|
* after successful PIS flow.
|
|
1096
1091
|
*/
|
|
1097
1092
|
interface PayerFinancialAddress {
|
|
1098
|
-
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
1093
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet';
|
|
1099
1094
|
bankCode?: PayerFinancialAddress.BankCode;
|
|
1100
1095
|
bban?: PayerFinancialAddress.Bban;
|
|
1101
1096
|
iban?: PayerFinancialAddress.Iban;
|
|
1102
1097
|
sortCode?: PayerFinancialAddress.SortCode;
|
|
1098
|
+
wallet?: PayerFinancialAddress.Wallet;
|
|
1103
1099
|
}
|
|
1104
1100
|
namespace PayerFinancialAddress {
|
|
1105
1101
|
interface BankCode {
|
|
@@ -1122,6 +1118,16 @@ export declare namespace OrderExpireResponse {
|
|
|
1122
1118
|
sortCode: string;
|
|
1123
1119
|
accountHolderName?: string;
|
|
1124
1120
|
}
|
|
1121
|
+
interface Wallet {
|
|
1122
|
+
/**
|
|
1123
|
+
* The blockchain wallet address
|
|
1124
|
+
*/
|
|
1125
|
+
address: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* The blockchain network
|
|
1128
|
+
*/
|
|
1129
|
+
blockchain: 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY';
|
|
1130
|
+
}
|
|
1125
1131
|
}
|
|
1126
1132
|
interface Refund {
|
|
1127
1133
|
/**
|
|
@@ -1155,12 +1161,12 @@ export declare namespace OrderExpireResponse {
|
|
|
1155
1161
|
interface ShippingAddress {
|
|
1156
1162
|
city: string;
|
|
1157
1163
|
country: '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';
|
|
1158
|
-
firstName: string;
|
|
1159
|
-
lastName: string;
|
|
1160
1164
|
line1: string;
|
|
1161
|
-
line2: string;
|
|
1162
|
-
region: string;
|
|
1163
1165
|
zipCode: string;
|
|
1166
|
+
firstName?: string;
|
|
1167
|
+
lastName?: string;
|
|
1168
|
+
line2?: string;
|
|
1169
|
+
region?: string;
|
|
1164
1170
|
}
|
|
1165
1171
|
/**
|
|
1166
1172
|
* Information about the customer who finished the order.
|
|
@@ -1171,14 +1177,14 @@ export declare namespace OrderExpireResponse {
|
|
|
1171
1177
|
}
|
|
1172
1178
|
interface StatusClassification {
|
|
1173
1179
|
primary: 'payment_authorisation_failed' | 'payment_execution_failed' | 'payment_abandoned';
|
|
1174
|
-
secondary?: 'timeout' | 'wrong_credentials' | 'incorrect_2fa_response' | 'payment_rejected' | 'insufficient_funds' | 'cancelled' | 'connection_to_bank_failed' | 'international_transfer_blocked' | 'international_transfer_limit_exceeded' | 'user_blocked' | 'bank_error' | 'instant_transfers_not_enabled' | 'no_active_tan_methods_available' | 'account_limit_exceeded' | 'bank_under_maintenance' | 'pin_blocked' | 'payment_not_settled' | 'unsupported_bank_account';
|
|
1180
|
+
secondary?: 'timeout' | 'wrong_credentials' | 'incorrect_2fa_response' | 'payment_rejected' | 'insufficient_funds' | 'cancelled' | 'connection_to_bank_failed' | 'international_transfer_blocked' | 'international_transfer_limit_exceeded' | 'user_blocked' | 'bank_error' | 'instant_transfers_not_enabled' | 'no_active_tan_methods_available' | 'account_limit_exceeded' | 'bank_under_maintenance' | 'pin_blocked' | 'payment_not_settled' | 'unsupported_bank_account' | 'online_banking_login_required' | 'deutsche_bank_psu_migration' | 'out_of_operational_hours';
|
|
1175
1181
|
}
|
|
1176
1182
|
interface StatusHistoryList {
|
|
1177
1183
|
createdAt: unknown;
|
|
1178
|
-
currentStatus: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
1184
|
+
currentStatus: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing';
|
|
1179
1185
|
reason: 'ORDER_CREATED' | 'CHECKOUT_SESSION_ABORTED' | 'PAYMENT_SUCCEEDED' | 'PAYMENT_INITIATED' | 'ORDER_CANCELED' | 'ORDER_EXPIRED_BY_MERCHANT' | 'ORDER_REFUND_INITIATED' | 'ORDER_REFUNDED' | 'REFUND_CHARGE_SUCCEEDED' | 'REFUND_UPDATED' | 'CHECKOUT_COMPLETED' | 'PIS_PAYMENT_INITIATED' | 'PIS_PAYMENT_UPDATED' | 'PIS_PAYMENT_SUCCEEDED' | 'PAYMENT_NOT_SETTLED' | 'PAYMENT_INITIATION_FAILED' | 'PAYMENT_CANCELED' | 'PAYMENT_FAILED' | 'CHECKOUT_SESSION_CREATED' | 'EXPIRED_CHECKOUT_SESSION_ABORTED' | 'DISPUTE' | 'PENDING_PAYMENT_ATTEMPTS_FOUND' | 'AML_FREEZE' | 'MANUAL_FREEZE' | 'MANUAL_UNFREEZE' | 'ORDER_MANUALLY_REOPENED' | 'ORDER_FINALIZATION_STARTED';
|
|
1180
1186
|
updatedAt: unknown;
|
|
1181
|
-
previousStatus?: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing' | null;
|
|
1187
|
+
previousStatus?: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing' | null;
|
|
1182
1188
|
}
|
|
1183
1189
|
}
|
|
1184
1190
|
export interface OrderCreateParams {
|