@jpmorgan-payments/embedded-finance-components 0.5.53
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/README.md +245 -0
- package/dist/asset/docs/placeholder.pdf +0 -0
- package/dist/esm/ef-components.js +70336 -0
- package/dist/index.css +1 -0
- package/dist/index.d.ts +1113 -0
- package/dist/mockServiceWorker.js +284 -0
- package/dist/umd/ef-components.js +358 -0
- package/package.json +169 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,1113 @@
|
|
|
1
|
+
import { FC } from 'react';
|
|
2
|
+
import { JSX as JSX_2 } from 'react/jsx-runtime';
|
|
3
|
+
import { ReactNode } from 'react';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* List of user access descriptors.
|
|
7
|
+
* @deprecated
|
|
8
|
+
* @minItems 0
|
|
9
|
+
* @maxItems 10
|
|
10
|
+
*/
|
|
11
|
+
declare type AccessList = string[];
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Whether the party is active or not. False if inactive.
|
|
15
|
+
*/
|
|
16
|
+
declare type Active = boolean;
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* An address.
|
|
20
|
+
*/
|
|
21
|
+
declare interface AddressDto {
|
|
22
|
+
/**
|
|
23
|
+
* The first line must not be a PO Box and must begin with a number. Each line has a maximum of 60 characters.
|
|
24
|
+
* @minItems 1
|
|
25
|
+
* @maxItems 5
|
|
26
|
+
*/
|
|
27
|
+
addressLines: string[];
|
|
28
|
+
/** Type of address. */
|
|
29
|
+
addressType?: AddressDtoAddressType;
|
|
30
|
+
/**
|
|
31
|
+
* city has a maximum of 30 characters.
|
|
32
|
+
* @maxLength 34
|
|
33
|
+
*/
|
|
34
|
+
city: string;
|
|
35
|
+
/** Country code in alpha-2 format. */
|
|
36
|
+
country: string;
|
|
37
|
+
/**
|
|
38
|
+
* Postal/ZIP code.
|
|
39
|
+
* @maxLength 10
|
|
40
|
+
*/
|
|
41
|
+
postalCode: string;
|
|
42
|
+
/**
|
|
43
|
+
* State code in alpha-2 format. State is mandatory for countries like United States. Refer to subdivision codes in [ISO-3166-2](https://www.iso.org/obp/ui/#search/code/).
|
|
44
|
+
* @minLength 1
|
|
45
|
+
* @maxLength 3
|
|
46
|
+
*/
|
|
47
|
+
state?: string;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Type of address.
|
|
52
|
+
*/
|
|
53
|
+
declare type AddressDtoAddressType = (typeof AddressDtoAddressType)[keyof typeof AddressDtoAddressType];
|
|
54
|
+
|
|
55
|
+
declare const AddressDtoAddressType: {
|
|
56
|
+
readonly LEGAL_ADDRESS: "LEGAL_ADDRESS";
|
|
57
|
+
readonly MAILING_ADDRESS: "MAILING_ADDRESS";
|
|
58
|
+
readonly BUSINESS_ADDRESS: "BUSINESS_ADDRESS";
|
|
59
|
+
readonly RESIDENTIAL_ADDRESS: "RESIDENTIAL_ADDRESS";
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Indicates whether the merchant has opted-in to American Express OptBlue marketing. - `true` ? All Marketing (Merchant has not opted out of receiving marketing) - `false` ? No Marketing (Merchant has opted out of receiving marketing)
|
|
64
|
+
|
|
65
|
+
*/
|
|
66
|
+
declare type AmexOptBlueMarketing = boolean;
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* The ID that identifies the merchant account when processing with American Express OptBlue.
|
|
70
|
+
|
|
71
|
+
*/
|
|
72
|
+
declare type AmexSellerId = string;
|
|
73
|
+
|
|
74
|
+
declare interface ApiError {
|
|
75
|
+
/**
|
|
76
|
+
* Provides additional context and detail on the validation errors
|
|
77
|
+
* @minItems 0
|
|
78
|
+
* @maxItems 100
|
|
79
|
+
*/
|
|
80
|
+
context?: ApiErrorReasonV2[];
|
|
81
|
+
/** HTTP status code */
|
|
82
|
+
httpStatus?: number;
|
|
83
|
+
/** Client provided request identifier */
|
|
84
|
+
requestId?: string;
|
|
85
|
+
/** Short humanly-readable title of the error */
|
|
86
|
+
title: string;
|
|
87
|
+
/** Internal assigned traced identifier */
|
|
88
|
+
traceId?: string;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
declare interface ApiErrorReasonV2 {
|
|
92
|
+
/** Short code that identifies the error - publicly cataloged and documented */
|
|
93
|
+
code?: string;
|
|
94
|
+
/** The location of the property or parameter in error */
|
|
95
|
+
field?: string;
|
|
96
|
+
/** Part of the request which is responsible for the reason */
|
|
97
|
+
location?: ApiErrorReasonV2Location;
|
|
98
|
+
/** Message describing the reason. This message can typically be displayed to your platform's users, except in cases specified otherwise */
|
|
99
|
+
message: string;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Part of the request which is responsible for the reason
|
|
104
|
+
*/
|
|
105
|
+
declare type ApiErrorReasonV2Location = (typeof ApiErrorReasonV2Location)[keyof typeof ApiErrorReasonV2Location];
|
|
106
|
+
|
|
107
|
+
declare const ApiErrorReasonV2Location: {
|
|
108
|
+
readonly BODY: "BODY";
|
|
109
|
+
readonly QUERY: "QUERY";
|
|
110
|
+
readonly PATH: "PATH";
|
|
111
|
+
readonly HEADER: "HEADER";
|
|
112
|
+
};
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* The attesting of presented legal statements. Either "attester" or "attesterFullName" is required.
|
|
116
|
+
*/
|
|
117
|
+
declare interface Attestation {
|
|
118
|
+
attestationTime: string;
|
|
119
|
+
attester?: Attester;
|
|
120
|
+
/** The full name of an individual. */
|
|
121
|
+
attesterFullName?: string;
|
|
122
|
+
documentId: DocumentId;
|
|
123
|
+
/** IPv4 Address. */
|
|
124
|
+
ipAddress: string;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* The details of the attester.
|
|
129
|
+
*/
|
|
130
|
+
declare interface Attester {
|
|
131
|
+
designation: AttesterDesignation;
|
|
132
|
+
firstName: AttesterFirstName;
|
|
133
|
+
lastName: AttesterLastName;
|
|
134
|
+
middleName?: AttesterMiddleName;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* The attester's held position in the client business.
|
|
139
|
+
* @maxLength 255
|
|
140
|
+
*/
|
|
141
|
+
declare type AttesterDesignation = string;
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* The first name of an individual.
|
|
145
|
+
* @maxLength 255
|
|
146
|
+
*/
|
|
147
|
+
declare type AttesterFirstName = string;
|
|
148
|
+
|
|
149
|
+
/**
|
|
150
|
+
* The last name of an individual.
|
|
151
|
+
* @maxLength 255
|
|
152
|
+
*/
|
|
153
|
+
declare type AttesterLastName = string;
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* The middle name of an individual.
|
|
157
|
+
* @maxLength 255
|
|
158
|
+
*/
|
|
159
|
+
declare type AttesterMiddleName = string;
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* The date of birth (yyyy-MM-dd) of the individual in case of party type being an individual.
|
|
163
|
+
|
|
164
|
+
*/
|
|
165
|
+
declare type BirthDate = string;
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* A client's unique ID
|
|
169
|
+
* @maxLength 10
|
|
170
|
+
*/
|
|
171
|
+
declare type ClientId = string;
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Client Product Table:
|
|
175
|
+
|
|
176
|
+
| Product | Description |
|
|
177
|
+
|-----|-----|-------|
|
|
178
|
+
| EMBEDDED_PAYMENTS | Create and manage embedded bank accounts |
|
|
179
|
+
| MERCHANT_SERVICES | Manage online payments |
|
|
180
|
+
|
|
181
|
+
*/
|
|
182
|
+
declare type ClientProduct = (typeof ClientProduct)[keyof typeof ClientProduct];
|
|
183
|
+
|
|
184
|
+
declare const ClientProduct: {
|
|
185
|
+
readonly MERCHANT_SERVICES: "MERCHANT_SERVICES";
|
|
186
|
+
readonly EMBEDDED_PAYMENTS: "EMBEDDED_PAYMENTS";
|
|
187
|
+
};
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* A list of product selections.
|
|
191
|
+
* @minItems 1
|
|
192
|
+
* @maxItems 50
|
|
193
|
+
*/
|
|
194
|
+
declare type ClientProductList = ClientProduct[];
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* The client's response to a question.
|
|
198
|
+
*/
|
|
199
|
+
declare interface ClientQuestionResponse {
|
|
200
|
+
questionId?: QuestionId;
|
|
201
|
+
values?: ResponseValueList;
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
declare interface ClientResponse {
|
|
205
|
+
/**
|
|
206
|
+
* @minItems 0
|
|
207
|
+
* @maxItems 10
|
|
208
|
+
*/
|
|
209
|
+
attestations?: Attestation[];
|
|
210
|
+
/** Date and time when the client was created */
|
|
211
|
+
createdAt?: string;
|
|
212
|
+
id: ClientId;
|
|
213
|
+
outstanding: ClientResponseOutstanding;
|
|
214
|
+
/** @minItems 0 */
|
|
215
|
+
parties?: PartyResponse[];
|
|
216
|
+
partyId: PartyId;
|
|
217
|
+
products: ClientProductList;
|
|
218
|
+
/**
|
|
219
|
+
* @minItems 0
|
|
220
|
+
* @maxItems 200
|
|
221
|
+
*/
|
|
222
|
+
questionResponses?: ClientQuestionResponse[];
|
|
223
|
+
results?: ClientResults;
|
|
224
|
+
status: ClientStatus;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
declare type ClientResponseOutstanding = {
|
|
228
|
+
attestationDocumentIds?: DocumentIdList;
|
|
229
|
+
documentRequestIds?: DocumentRequestIdList;
|
|
230
|
+
partyIds?: PartyIdList;
|
|
231
|
+
partyRoles?: PartyRoleList;
|
|
232
|
+
questionIds?: QuestionIdList;
|
|
233
|
+
};
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
* The results of the client verification process.
|
|
237
|
+
*/
|
|
238
|
+
declare interface ClientResults {
|
|
239
|
+
customerIdentityStatus: CustomerIdentityStatus;
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* The client's status.
|
|
244
|
+
*/
|
|
245
|
+
declare type ClientStatus = (typeof ClientStatus)[keyof typeof ClientStatus];
|
|
246
|
+
|
|
247
|
+
declare const ClientStatus: {
|
|
248
|
+
readonly APPROVED: "APPROVED";
|
|
249
|
+
readonly DECLINED: "DECLINED";
|
|
250
|
+
readonly INFORMATION_REQUESTED: "INFORMATION_REQUESTED";
|
|
251
|
+
readonly NEW: "NEW";
|
|
252
|
+
readonly REVIEW_IN_PROGRESS: "REVIEW_IN_PROGRESS";
|
|
253
|
+
readonly SUSPENDED: "SUSPENDED";
|
|
254
|
+
readonly TERMINATED: "TERMINATED";
|
|
255
|
+
};
|
|
256
|
+
|
|
257
|
+
declare interface ClientVerificationResponse {
|
|
258
|
+
/** The timestamp when the request to start verification was accepted. */
|
|
259
|
+
acceptedAt?: string;
|
|
260
|
+
consumerDevice?: ConsumerDevice;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
declare type ComponentRegistry = typeof componentRegistry;
|
|
264
|
+
|
|
265
|
+
declare const componentRegistry: {
|
|
266
|
+
LinkedAccountWidget: FC< {
|
|
267
|
+
variant?: "default" | "singleAccount";
|
|
268
|
+
}>;
|
|
269
|
+
OnboardingWizard: ({ clientId, onPostClientsVerification, onGetClientsConfirmation, ...props }: OnboardingWizardInitProps) => JSX_2.Element;
|
|
270
|
+
};
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Consumer device information provided by the merchant. It is only returned when present in the create or update client requests.
|
|
274
|
+
*/
|
|
275
|
+
declare interface ConsumerDevice {
|
|
276
|
+
/** IPv4 address of the consumer device. */
|
|
277
|
+
ipAddress?: string;
|
|
278
|
+
/**
|
|
279
|
+
* The unique session identifier of the device that was created by the client. It can be up to 128 characters long and can contain only the following characters: uppercase and lowercase Roman letters, digits, underscore characters, and hyphens (a?z, A?Z, 0?9, _, -). The session ID should contain at least 16 bytes of randomly generated data.
|
|
280
|
+
|
|
281
|
+
* @pattern ^[a-zA-Z0-9_-]+$
|
|
282
|
+
*/
|
|
283
|
+
sessionId?: string;
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
/**
|
|
287
|
+
* Country code in ISO alpha-2 format.
|
|
288
|
+
* @minLength 2
|
|
289
|
+
* @maxLength 2
|
|
290
|
+
*/
|
|
291
|
+
declare type CountryCodeIsoAlpha2 = string;
|
|
292
|
+
|
|
293
|
+
/**
|
|
294
|
+
* The status of the customer identification process.
|
|
295
|
+
*/
|
|
296
|
+
declare type CustomerIdentityStatus = (typeof CustomerIdentityStatus)[keyof typeof CustomerIdentityStatus];
|
|
297
|
+
|
|
298
|
+
declare const CustomerIdentityStatus: {
|
|
299
|
+
readonly APPROVED: "APPROVED";
|
|
300
|
+
readonly INFORMATION_REQUESTED: "INFORMATION_REQUESTED";
|
|
301
|
+
readonly NOT_STARTED: "NOT_STARTED";
|
|
302
|
+
readonly REVIEW_IN_PROGRESS: "REVIEW_IN_PROGRESS";
|
|
303
|
+
};
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* @minLength 1
|
|
307
|
+
* @maxLength 100
|
|
308
|
+
*/
|
|
309
|
+
declare type DbaName = string;
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Indicates if the merchant will be accepting Discover cards as a part of Discover's consumer debt repayment program.
|
|
313
|
+
|
|
314
|
+
*/
|
|
315
|
+
declare type DiscoverDebtRepayment = boolean;
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* The ID that identifies the merchant account when processing with Discover.
|
|
319
|
+
|
|
320
|
+
*/
|
|
321
|
+
declare type DiscoverMerchantId = string;
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* The unique id generated by the system for the uploaded document, which can be used for future retrieval.
|
|
325
|
+
|
|
326
|
+
*/
|
|
327
|
+
declare type DocumentId = string;
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* A list of document IDs.
|
|
331
|
+
* @minItems 0
|
|
332
|
+
* @maxItems 10
|
|
333
|
+
*/
|
|
334
|
+
declare type DocumentIdList = DocumentId[];
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* A list of document request IDs.
|
|
338
|
+
* @minItems 0
|
|
339
|
+
* @maxItems 10
|
|
340
|
+
*/
|
|
341
|
+
declare type DocumentRequestIdList = string[];
|
|
342
|
+
|
|
343
|
+
declare type EBColorScheme = 'dark' | 'light' | 'system';
|
|
344
|
+
|
|
345
|
+
declare class EBComponentsManager {
|
|
346
|
+
private config;
|
|
347
|
+
private components;
|
|
348
|
+
private roots;
|
|
349
|
+
constructor(config: EBConfig);
|
|
350
|
+
mountComponent(componentName: keyof ComponentRegistry, props: any, containerId: string): void;
|
|
351
|
+
unmountComponent(containerId: string): void;
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
export declare const EBComponentsProvider: React.FC<EBComponentsProviderProps>;
|
|
355
|
+
|
|
356
|
+
export declare interface EBComponentsProviderProps extends EBConfig {
|
|
357
|
+
children: ReactNode;
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
declare type EBConfig = {
|
|
361
|
+
apiBaseUrl: string;
|
|
362
|
+
theme?: EBTheme;
|
|
363
|
+
headers?: Record<string, string>;
|
|
364
|
+
};
|
|
365
|
+
|
|
366
|
+
declare type EBTheme = {
|
|
367
|
+
colorScheme?: EBColorScheme;
|
|
368
|
+
variables?: EBThemeVariables;
|
|
369
|
+
light?: EBThemeVariables;
|
|
370
|
+
dark?: EBThemeVariables;
|
|
371
|
+
};
|
|
372
|
+
|
|
373
|
+
declare type EBThemeVariables = {
|
|
374
|
+
fontFamily?: string;
|
|
375
|
+
backgroundColor?: string;
|
|
376
|
+
foregroundColor?: string;
|
|
377
|
+
primaryColor?: string;
|
|
378
|
+
primaryColorHover?: string;
|
|
379
|
+
primaryForegroundColor?: string;
|
|
380
|
+
secondaryColor?: string;
|
|
381
|
+
secondaryForegroundColor?: string;
|
|
382
|
+
destructiveColor?: string;
|
|
383
|
+
destructiveForegroundColor?: string;
|
|
384
|
+
mutedColor?: string;
|
|
385
|
+
mutedForegroundColor?: string;
|
|
386
|
+
accentColor?: string;
|
|
387
|
+
accentForegroundColor?: string;
|
|
388
|
+
cardColor?: string;
|
|
389
|
+
cardForegroundColor?: string;
|
|
390
|
+
popoverColor?: string;
|
|
391
|
+
popoverForegroundColor?: string;
|
|
392
|
+
borderRadius?: string;
|
|
393
|
+
buttonBorderRadius?: string;
|
|
394
|
+
borderColor?: string;
|
|
395
|
+
inputColor?: string;
|
|
396
|
+
ringColor?: string;
|
|
397
|
+
zIndexOverlay?: number;
|
|
398
|
+
};
|
|
399
|
+
|
|
400
|
+
/**
|
|
401
|
+
* Email of the party.
|
|
402
|
+
* @minLength 0
|
|
403
|
+
* @maxLength 320
|
|
404
|
+
*/
|
|
405
|
+
declare type Email = string;
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* Entities in ownership means that one or more businesses own part of the business connected to the client. Always required for a Privately Owned Business.
|
|
409
|
+
|
|
410
|
+
*/
|
|
411
|
+
declare type EntitiesInOwnership = boolean;
|
|
412
|
+
|
|
413
|
+
/**
|
|
414
|
+
* Id in external system.
|
|
415
|
+
* @minLength 1
|
|
416
|
+
* @maxLength 20
|
|
417
|
+
*/
|
|
418
|
+
declare type ExternalId = string;
|
|
419
|
+
|
|
420
|
+
/**
|
|
421
|
+
* First name of the individual in case of party type being an individual like Owners, Controllers and Decision Makers.
|
|
422
|
+
|
|
423
|
+
* @minLength 2
|
|
424
|
+
* @maxLength 30
|
|
425
|
+
*/
|
|
426
|
+
declare type FirstName = string;
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* Details of an individual.
|
|
430
|
+
*/
|
|
431
|
+
declare interface IndividualDetails {
|
|
432
|
+
/**
|
|
433
|
+
* @minItems 1
|
|
434
|
+
* @maxItems 5
|
|
435
|
+
*/
|
|
436
|
+
addresses?: AddressDto[];
|
|
437
|
+
birthDate?: BirthDate;
|
|
438
|
+
countryOfResidence?: CountryCodeIsoAlpha2;
|
|
439
|
+
firstName?: FirstName;
|
|
440
|
+
/**
|
|
441
|
+
* @minItems 0
|
|
442
|
+
* @maxItems 16
|
|
443
|
+
*/
|
|
444
|
+
individualIds?: IndividualIdentity[];
|
|
445
|
+
jobTitle?: IndividualJobTitle;
|
|
446
|
+
jobTitleDescription?: IndividualJobTitleDescription;
|
|
447
|
+
lastName?: LastName;
|
|
448
|
+
middleName?: MiddleName;
|
|
449
|
+
nameSuffix?: NameSuffix;
|
|
450
|
+
natureOfOwnership?: NatureOfOwnership;
|
|
451
|
+
phone?: PhoneSmbdo;
|
|
452
|
+
socialMedia?: SocialMediaList;
|
|
453
|
+
soleOwner?: SoleOwner;
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
/**
|
|
457
|
+
* An individual's identification.
|
|
458
|
+
*/
|
|
459
|
+
declare interface IndividualIdentity {
|
|
460
|
+
/** Description of the ID. */
|
|
461
|
+
description?: string;
|
|
462
|
+
expiryDate?: string;
|
|
463
|
+
/** `idType` denotes the type of taxpayer identification number (e.g. Social Security Number or Individual Taxpayer Identification Number). A Social Security Number or Individual Taxpayer Identification Number is accepted for an owner or controller individual. Decision makers do not require any tax identifier.
|
|
464
|
+
*/
|
|
465
|
+
idType: IndividualIdentityIdType;
|
|
466
|
+
/** Identification issuer country code e.g. US */
|
|
467
|
+
issuer: string;
|
|
468
|
+
/**
|
|
469
|
+
* Value of the identification type. EIN/SSN/ITIN must be of 9 digits.
|
|
470
|
+
* @minLength 1
|
|
471
|
+
* @maxLength 20
|
|
472
|
+
*/
|
|
473
|
+
value: string;
|
|
474
|
+
}
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* `idType` denotes the type of taxpayer identification number (e.g. Social Security Number or Individual Taxpayer Identification Number). A Social Security Number or Individual Taxpayer Identification Number is accepted for an owner or controller individual. Decision makers do not require any tax identifier.
|
|
478
|
+
|
|
479
|
+
*/
|
|
480
|
+
declare type IndividualIdentityIdType = (typeof IndividualIdentityIdType)[keyof typeof IndividualIdentityIdType];
|
|
481
|
+
|
|
482
|
+
declare const IndividualIdentityIdType: {
|
|
483
|
+
readonly SSN: "SSN";
|
|
484
|
+
readonly ITIN: "ITIN";
|
|
485
|
+
readonly NATIONAL_ID: "NATIONAL_ID";
|
|
486
|
+
readonly DRIVERS_LICENSE: "DRIVERS_LICENSE";
|
|
487
|
+
readonly PASSPORT: "PASSPORT";
|
|
488
|
+
readonly SOCIAL_INSURANCE_NUMBER: "SOCIAL_INSURANCE_NUMBER";
|
|
489
|
+
readonly OTHER_GOVERNMENT_ID: "OTHER_GOVERNMENT_ID";
|
|
490
|
+
};
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* Job title in the case of party type being an `INDIVIDUAL`. Job title is a required field for Controllers. Also, If Privately Owned Business is selected as the business type, Job Title should be a required field for Decision Makers. e.g. CEO|CFO|COO|President|Chairman|Senior Branch Manager|Other
|
|
494
|
+
|
|
495
|
+
* @minLength 0
|
|
496
|
+
*/
|
|
497
|
+
declare type IndividualJobTitle = string;
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* If `jobTitle` is Other, then job title description is required.
|
|
501
|
+
|
|
502
|
+
* @minLength 0
|
|
503
|
+
* @maxLength 50
|
|
504
|
+
*/
|
|
505
|
+
declare type IndividualJobTitleDescription = string;
|
|
506
|
+
|
|
507
|
+
export declare const initEBComponentsManager: (config: EBConfig) => EBComponentsManager;
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* Indicates if the merchant will accept JCB cards. Required American Express OptBlue is selected in Australia, New Zealand, or Canada.
|
|
511
|
+
|
|
512
|
+
*/
|
|
513
|
+
declare type JcbAccepted = boolean;
|
|
514
|
+
|
|
515
|
+
/**
|
|
516
|
+
* Last name of the individual in case of party type being an individual like Owners, Controllers and Decision Makers.
|
|
517
|
+
|
|
518
|
+
* @minLength 2
|
|
519
|
+
* @maxLength 30
|
|
520
|
+
*/
|
|
521
|
+
declare type LastName = string;
|
|
522
|
+
|
|
523
|
+
export declare const LinkedAccountWidget: React.FC<LinkedAccountWidgetProps>;
|
|
524
|
+
|
|
525
|
+
declare type LinkedAccountWidgetProps = {
|
|
526
|
+
variant?: 'default' | 'singleAccount';
|
|
527
|
+
};
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* The merchant category code describing the merchant's industry.
|
|
531
|
+
* @minLength 4
|
|
532
|
+
* @maxLength 4
|
|
533
|
+
*/
|
|
534
|
+
declare type MerchantCategoryCode = string;
|
|
535
|
+
|
|
536
|
+
/**
|
|
537
|
+
* Middle name of the individual in case of party type being an individual.
|
|
538
|
+
|
|
539
|
+
* @minLength 0
|
|
540
|
+
* @maxLength 30
|
|
541
|
+
*/
|
|
542
|
+
declare type MiddleName = string;
|
|
543
|
+
|
|
544
|
+
/**
|
|
545
|
+
* The name suffix used by the party
|
|
546
|
+
* @minLength 1
|
|
547
|
+
* @maxLength 5
|
|
548
|
+
*/
|
|
549
|
+
declare type NameSuffix = string;
|
|
550
|
+
|
|
551
|
+
/**
|
|
552
|
+
* Nature of ownership e.g. Direct|Indirect
|
|
553
|
+
|
|
554
|
+
* @minLength 0
|
|
555
|
+
*/
|
|
556
|
+
declare type NatureOfOwnership = string;
|
|
557
|
+
|
|
558
|
+
/**
|
|
559
|
+
* Network registration configuration.
|
|
560
|
+
*/
|
|
561
|
+
declare interface NetworkRegistration {
|
|
562
|
+
amexOptBlueMarketing?: AmexOptBlueMarketing;
|
|
563
|
+
amexSellerId?: AmexSellerId;
|
|
564
|
+
currencyCode?: NetworkRegistrationCurrencyCode;
|
|
565
|
+
discoverDebtRepayment?: DiscoverDebtRepayment;
|
|
566
|
+
discoverMerchantId?: DiscoverMerchantId;
|
|
567
|
+
jcbAccepted?: JcbAccepted;
|
|
568
|
+
serviceEstablishmentStatus?: ServiceEstablishmentStatus;
|
|
569
|
+
/** The last update date of the service establishment status. Required if the service establishment status is provided.
|
|
570
|
+
*/
|
|
571
|
+
serviceEstablishmentStatusUpdateDate?: string;
|
|
572
|
+
/**
|
|
573
|
+
* The selection of method of payments used in network registration.
|
|
574
|
+
* @minItems 1
|
|
575
|
+
* @maxItems 3
|
|
576
|
+
*/
|
|
577
|
+
settlementPaymentMethods?: SettlementPaymentMethods[];
|
|
578
|
+
/** The opting out of settlement payment method selection. Required to specify true if the merchant is not selecting any settlement payment method.
|
|
579
|
+
*/
|
|
580
|
+
settlementPaymentMethodsOptOut?: boolean;
|
|
581
|
+
transactionDeviceType?: TransactionDeviceType;
|
|
582
|
+
visaDebitAcceptance?: VisaDebitAcceptance;
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* The merchant's preferred currency for transactions. Required when AMEX_OPT_BLUE is selected.
|
|
587
|
+
|
|
588
|
+
*/
|
|
589
|
+
declare type NetworkRegistrationCurrencyCode = (typeof NetworkRegistrationCurrencyCode)[keyof typeof NetworkRegistrationCurrencyCode];
|
|
590
|
+
|
|
591
|
+
declare const NetworkRegistrationCurrencyCode: {
|
|
592
|
+
readonly GBP: "GBP";
|
|
593
|
+
readonly USD: "USD";
|
|
594
|
+
readonly CAD: "CAD";
|
|
595
|
+
readonly EUR: "EUR";
|
|
596
|
+
};
|
|
597
|
+
|
|
598
|
+
declare type OnboardingUseCase = 'EF' | 'CanadaMS';
|
|
599
|
+
|
|
600
|
+
export declare const OnboardingWizard: ({ clientId, onPostClientsVerification, onGetClientsConfirmation, ...props }: OnboardingWizardInitProps) => JSX_2.Element;
|
|
601
|
+
|
|
602
|
+
export declare const OnboardingWizardBasic: FC<OnboardingWizardBasicProps>;
|
|
603
|
+
|
|
604
|
+
export declare type OnboardingWizardBasicProps = {
|
|
605
|
+
clientId?: string;
|
|
606
|
+
title?: string;
|
|
607
|
+
setClientId?: (clientId: string) => void;
|
|
608
|
+
onPostClientResponse?: (response?: ClientResponse, error?: ApiError) => void;
|
|
609
|
+
onPostClientVerificationsResponse?: (response?: ClientVerificationResponse, error?: ApiError) => void;
|
|
610
|
+
initialStep?: number;
|
|
611
|
+
variant?: 'circle' | 'circle-alt' | 'line';
|
|
612
|
+
useCase?: OnboardingUseCase;
|
|
613
|
+
};
|
|
614
|
+
|
|
615
|
+
declare interface OnboardingWizardInitProps extends RootConfig {
|
|
616
|
+
title?: string;
|
|
617
|
+
clientId?: string;
|
|
618
|
+
currentStep?: number;
|
|
619
|
+
onPostClientsVerification: ({ clientId, clientResponse, }: {
|
|
620
|
+
clientId: string;
|
|
621
|
+
clientResponse?: any;
|
|
622
|
+
}) => void;
|
|
623
|
+
onGetClientsConfirmation: ({ clientId, clientResponse, }: {
|
|
624
|
+
clientId: string;
|
|
625
|
+
clientResponse?: any;
|
|
626
|
+
}) => void;
|
|
627
|
+
}
|
|
628
|
+
|
|
629
|
+
declare interface onRegistrationProp {
|
|
630
|
+
clientId: string;
|
|
631
|
+
clientResponse?: any;
|
|
632
|
+
}
|
|
633
|
+
|
|
634
|
+
/**
|
|
635
|
+
* The organization?s description.
|
|
636
|
+
|
|
637
|
+
* @minLength 0
|
|
638
|
+
*/
|
|
639
|
+
declare type OrganizationDescription = string;
|
|
640
|
+
|
|
641
|
+
/**
|
|
642
|
+
* Details of an organization.
|
|
643
|
+
*/
|
|
644
|
+
declare interface OrganizationDetails {
|
|
645
|
+
/**
|
|
646
|
+
* @minItems 1
|
|
647
|
+
* @maxItems 5
|
|
648
|
+
*/
|
|
649
|
+
addresses?: AddressDto[];
|
|
650
|
+
/**
|
|
651
|
+
* @minItems 0
|
|
652
|
+
* @maxItems 100
|
|
653
|
+
*/
|
|
654
|
+
associatedCountries?: CountryCodeIsoAlpha2[];
|
|
655
|
+
countryOfFormation?: CountryCodeIsoAlpha2;
|
|
656
|
+
dbaName?: DbaName;
|
|
657
|
+
entitiesInOwnership?: EntitiesInOwnership;
|
|
658
|
+
industry?: OrganizationIndustry;
|
|
659
|
+
industryCategory?: OrganizationIndustryCategory;
|
|
660
|
+
industryType?: OrganizationIndustryType;
|
|
661
|
+
jurisdiction?: CountryCodeIsoAlpha2;
|
|
662
|
+
mcc?: MerchantCategoryCode;
|
|
663
|
+
organizationDescription?: OrganizationDescription;
|
|
664
|
+
/**
|
|
665
|
+
* @minItems 0
|
|
666
|
+
* @maxItems 6
|
|
667
|
+
*/
|
|
668
|
+
organizationIds?: OrganizationIdentityDto[];
|
|
669
|
+
organizationName?: OrganizationName;
|
|
670
|
+
organizationType?: OrganizationType;
|
|
671
|
+
phone?: PhoneSmbdo;
|
|
672
|
+
/**
|
|
673
|
+
* The list of additional merchant category codes describing industries that the business is in.
|
|
674
|
+
|
|
675
|
+
* @minItems 0
|
|
676
|
+
* @maxItems 10
|
|
677
|
+
*/
|
|
678
|
+
secondaryMccList?: MerchantCategoryCode[];
|
|
679
|
+
socialMedia?: SocialMediaList;
|
|
680
|
+
website?: Website;
|
|
681
|
+
websiteAvailable?: WebsiteAvailable;
|
|
682
|
+
yearOfFormation?: YearOfFormation;
|
|
683
|
+
}
|
|
684
|
+
|
|
685
|
+
/**
|
|
686
|
+
* The tax ID of the organization.
|
|
687
|
+
*/
|
|
688
|
+
declare interface OrganizationIdentityDto {
|
|
689
|
+
/** Description of the ID. */
|
|
690
|
+
description?: string;
|
|
691
|
+
expiryDate?: string;
|
|
692
|
+
/** The ID type */
|
|
693
|
+
idType: OrganizationIdentityDtoIdType;
|
|
694
|
+
/**
|
|
695
|
+
* Issuing authority
|
|
696
|
+
* @minLength 1
|
|
697
|
+
* @maxLength 500
|
|
698
|
+
*/
|
|
699
|
+
issuer: string;
|
|
700
|
+
/**
|
|
701
|
+
* ID value
|
|
702
|
+
* @minLength 1
|
|
703
|
+
* @maxLength 100
|
|
704
|
+
*/
|
|
705
|
+
value: string;
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
/**
|
|
709
|
+
* The ID type
|
|
710
|
+
*/
|
|
711
|
+
declare type OrganizationIdentityDtoIdType = (typeof OrganizationIdentityDtoIdType)[keyof typeof OrganizationIdentityDtoIdType];
|
|
712
|
+
|
|
713
|
+
declare const OrganizationIdentityDtoIdType: {
|
|
714
|
+
readonly EIN: "EIN";
|
|
715
|
+
readonly BUSINESS_REGISTRATION_ID: "BUSINESS_REGISTRATION_ID";
|
|
716
|
+
readonly BUSINESS_NUMBER: "BUSINESS_NUMBER";
|
|
717
|
+
readonly BUSINESS_REGISTRATION_NUMBER: "BUSINESS_REGISTRATION_NUMBER";
|
|
718
|
+
};
|
|
719
|
+
|
|
720
|
+
declare interface OrganizationIndustry {
|
|
721
|
+
/**
|
|
722
|
+
* Value of the industry code such as a 9 digit NAICS code
|
|
723
|
+
* @minLength 1
|
|
724
|
+
* @maxLength 24
|
|
725
|
+
*/
|
|
726
|
+
code?: string;
|
|
727
|
+
codeType?: OrganizationIndustryCodeType;
|
|
728
|
+
}
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
* The industry category of the business connected to the client. For example, Accommodation and Food Services. You can use the Reference Data resource to get a list of acceptable values.
|
|
732
|
+
|
|
733
|
+
* @minLength 0
|
|
734
|
+
*/
|
|
735
|
+
declare type OrganizationIndustryCategory = string;
|
|
736
|
+
|
|
737
|
+
declare type OrganizationIndustryCodeType = (typeof OrganizationIndustryCodeType)[keyof typeof OrganizationIndustryCodeType];
|
|
738
|
+
|
|
739
|
+
declare const OrganizationIndustryCodeType: {
|
|
740
|
+
readonly NAICS: "NAICS";
|
|
741
|
+
};
|
|
742
|
+
|
|
743
|
+
/**
|
|
744
|
+
* The industry type of the business connected to the client. You can use the Reference Data resource to get a list of acceptable values.
|
|
745
|
+
|
|
746
|
+
* @minLength 0
|
|
747
|
+
*/
|
|
748
|
+
declare type OrganizationIndustryType = string;
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
* The organization?s legal name. It is the official name of the person or entity that owns a company. Must be the name used on the legal party's government forms and business paperwork
|
|
752
|
+
|
|
753
|
+
* @minLength 1
|
|
754
|
+
*/
|
|
755
|
+
declare type OrganizationName = string;
|
|
756
|
+
|
|
757
|
+
declare type OrganizationType = (typeof OrganizationType)[keyof typeof OrganizationType];
|
|
758
|
+
|
|
759
|
+
declare const OrganizationType: {
|
|
760
|
+
readonly LIMITED_LIABILITY_PARTNERSHIP: "LIMITED_LIABILITY_PARTNERSHIP";
|
|
761
|
+
readonly LIMITED_PARTNERSHIP: "LIMITED_PARTNERSHIP";
|
|
762
|
+
readonly GENERAL_PARTNERSHIP: "GENERAL_PARTNERSHIP";
|
|
763
|
+
readonly LIMITED_LIABILITY_COMPANY: "LIMITED_LIABILITY_COMPANY";
|
|
764
|
+
readonly C_CORPORATION: "C_CORPORATION";
|
|
765
|
+
readonly S_CORPORATION: "S_CORPORATION";
|
|
766
|
+
readonly PARTNERSHIP: "PARTNERSHIP";
|
|
767
|
+
readonly PUBLICLY_TRADED_COMPANY: "PUBLICLY_TRADED_COMPANY";
|
|
768
|
+
readonly NON_PROFIT_CORPORATION: "NON_PROFIT_CORPORATION";
|
|
769
|
+
readonly GOVERNMENT_ENTITY: "GOVERNMENT_ENTITY";
|
|
770
|
+
readonly SOLE_PROPRIETORSHIP: "SOLE_PROPRIETORSHIP";
|
|
771
|
+
readonly UNINCORPORATED_ASSOCIATION: "UNINCORPORATED_ASSOCIATION";
|
|
772
|
+
};
|
|
773
|
+
|
|
774
|
+
/**
|
|
775
|
+
* The parent party ID.
|
|
776
|
+
|
|
777
|
+
* @minLength 10
|
|
778
|
+
* @maxLength 10
|
|
779
|
+
*/
|
|
780
|
+
declare type ParentPartyId = string;
|
|
781
|
+
|
|
782
|
+
/**
|
|
783
|
+
* A party field. It refers to either a missing field or a field that needs to be updated.
|
|
784
|
+
*/
|
|
785
|
+
declare interface PartyField {
|
|
786
|
+
/** Display name of the field. */
|
|
787
|
+
displayName?: string;
|
|
788
|
+
/** Name of the field. */
|
|
789
|
+
name?: string;
|
|
790
|
+
/** Type of the field. */
|
|
791
|
+
type?: string;
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
/**
|
|
795
|
+
* Organization/Individual party id, that uniquely identifies the party.
|
|
796
|
+
|
|
797
|
+
* @maxLength 10
|
|
798
|
+
* @pattern ^[0-9]{10}$
|
|
799
|
+
*/
|
|
800
|
+
declare type PartyId = string;
|
|
801
|
+
|
|
802
|
+
/**
|
|
803
|
+
* A list of party IDs.
|
|
804
|
+
* @minItems 0
|
|
805
|
+
* @maxItems 10
|
|
806
|
+
*/
|
|
807
|
+
declare type PartyIdList = PartyId[];
|
|
808
|
+
|
|
809
|
+
declare interface PartyResponse {
|
|
810
|
+
/** @deprecated */
|
|
811
|
+
access?: AccessList;
|
|
812
|
+
active?: Active;
|
|
813
|
+
createdAt?: string;
|
|
814
|
+
email?: Email;
|
|
815
|
+
externalId?: ExternalId;
|
|
816
|
+
id?: PartyId;
|
|
817
|
+
individualDetails?: IndividualDetails;
|
|
818
|
+
networkRegistration?: NetworkRegistration;
|
|
819
|
+
organizationDetails?: OrganizationDetails;
|
|
820
|
+
parentExternalId?: ExternalId;
|
|
821
|
+
parentPartyId?: ParentPartyId;
|
|
822
|
+
partyType?: PartyType;
|
|
823
|
+
profileStatus?: ProfileStatus;
|
|
824
|
+
/**
|
|
825
|
+
* @minItems 0
|
|
826
|
+
* @maxItems 10
|
|
827
|
+
*/
|
|
828
|
+
roles?: Role[];
|
|
829
|
+
/** @deprecated */
|
|
830
|
+
status?: PartyStatus;
|
|
831
|
+
validationResponse?: ValidationResponse;
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
/**
|
|
835
|
+
* A list of party roles.
|
|
836
|
+
* @minItems 0
|
|
837
|
+
* @maxItems 10
|
|
838
|
+
*/
|
|
839
|
+
declare type PartyRoleList = Role[];
|
|
840
|
+
|
|
841
|
+
declare type PartyStatus = (typeof PartyStatus)[keyof typeof PartyStatus];
|
|
842
|
+
|
|
843
|
+
declare const PartyStatus: {
|
|
844
|
+
readonly ACTIVE: "ACTIVE";
|
|
845
|
+
readonly INACTIVE: "INACTIVE";
|
|
846
|
+
};
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* The party type
|
|
850
|
+
*/
|
|
851
|
+
declare type PartyType = (typeof PartyType)[keyof typeof PartyType];
|
|
852
|
+
|
|
853
|
+
declare const PartyType: {
|
|
854
|
+
readonly INDIVIDUAL: "INDIVIDUAL";
|
|
855
|
+
readonly ORGANIZATION: "ORGANIZATION";
|
|
856
|
+
};
|
|
857
|
+
|
|
858
|
+
/**
|
|
859
|
+
* Phone Number Information of the account
|
|
860
|
+
|
|
861
|
+
*/
|
|
862
|
+
declare interface PhoneSmbdo {
|
|
863
|
+
countryCode: string;
|
|
864
|
+
phoneNumber: string;
|
|
865
|
+
phoneType: PhoneSmbdoPhoneType;
|
|
866
|
+
}
|
|
867
|
+
|
|
868
|
+
declare type PhoneSmbdoPhoneType = (typeof PhoneSmbdoPhoneType)[keyof typeof PhoneSmbdoPhoneType];
|
|
869
|
+
|
|
870
|
+
declare const PhoneSmbdoPhoneType: {
|
|
871
|
+
readonly BUSINESS_PHONE: "BUSINESS_PHONE";
|
|
872
|
+
readonly MOBILE_PHONE: "MOBILE_PHONE";
|
|
873
|
+
readonly ALTERNATE_PHONE: "ALTERNATE_PHONE";
|
|
874
|
+
};
|
|
875
|
+
|
|
876
|
+
declare type ProfileStatus = (typeof ProfileStatus)[keyof typeof ProfileStatus];
|
|
877
|
+
|
|
878
|
+
declare const ProfileStatus: {
|
|
879
|
+
readonly NEW: "NEW";
|
|
880
|
+
readonly REVIEW_IN_PROGRESS: "REVIEW_IN_PROGRESS";
|
|
881
|
+
readonly INFORMATION_REQUESTED: "INFORMATION_REQUESTED";
|
|
882
|
+
readonly APPROVED: "APPROVED";
|
|
883
|
+
readonly DECLINED: "DECLINED";
|
|
884
|
+
readonly SUSPENDED: "SUSPENDED";
|
|
885
|
+
readonly TERMINATED: "TERMINATED";
|
|
886
|
+
};
|
|
887
|
+
|
|
888
|
+
/**
|
|
889
|
+
* The ID uniquely identifying a question.
|
|
890
|
+
* @maxLength 10
|
|
891
|
+
*/
|
|
892
|
+
declare type QuestionId = string;
|
|
893
|
+
|
|
894
|
+
/**
|
|
895
|
+
* A list of question IDs.
|
|
896
|
+
* @minItems 0
|
|
897
|
+
* @maxItems 200
|
|
898
|
+
*/
|
|
899
|
+
declare type QuestionIdList = QuestionId[];
|
|
900
|
+
|
|
901
|
+
/**
|
|
902
|
+
* The values of a question response. Each item is a string that will be validated according to the question's responseSchema.
|
|
903
|
+
|
|
904
|
+
* @minItems 1
|
|
905
|
+
* @maxItems 20
|
|
906
|
+
*/
|
|
907
|
+
declare type ResponseValueList = string[];
|
|
908
|
+
|
|
909
|
+
declare type Role = (typeof Role)[keyof typeof Role];
|
|
910
|
+
|
|
911
|
+
declare const Role: {
|
|
912
|
+
readonly AUTHORIZED_USER: "AUTHORIZED_USER";
|
|
913
|
+
readonly BENEFICIAL_OWNER: "BENEFICIAL_OWNER";
|
|
914
|
+
readonly CLIENT: "CLIENT";
|
|
915
|
+
readonly CONTROLLER: "CONTROLLER";
|
|
916
|
+
readonly DECISION_MAKER: "DECISION_MAKER";
|
|
917
|
+
readonly PRIMARY_CONTACT: "PRIMARY_CONTACT";
|
|
918
|
+
readonly DIRECTOR: "DIRECTOR";
|
|
919
|
+
};
|
|
920
|
+
|
|
921
|
+
declare interface RootConfig {
|
|
922
|
+
clientId?: string;
|
|
923
|
+
partyId?: string;
|
|
924
|
+
jurisdictions?: string[];
|
|
925
|
+
entityType?: string;
|
|
926
|
+
products?: string[];
|
|
927
|
+
setClientId?: any;
|
|
928
|
+
setPartyId?: any;
|
|
929
|
+
onPostClientsVerification: ({ clientId, clientResponse, }: onRegistrationProp) => void;
|
|
930
|
+
onGetClientsConfirmation: ({ clientId, clientResponse, }: onRegistrationProp) => void;
|
|
931
|
+
}
|
|
932
|
+
|
|
933
|
+
/**
|
|
934
|
+
* The American Express status code for the merchant if they are terminated or reinstated. The payment provider must provide this if the merchant was previously terminated and AMEX_OPT_BLUE is a selected method of payment.
|
|
935
|
+
|
|
936
|
+
*/
|
|
937
|
+
declare type ServiceEstablishmentStatus = (typeof ServiceEstablishmentStatus)[keyof typeof ServiceEstablishmentStatus];
|
|
938
|
+
|
|
939
|
+
declare const ServiceEstablishmentStatus: {
|
|
940
|
+
readonly D_CANCELLED: "D_CANCELLED";
|
|
941
|
+
readonly N_CANCELLED: "N_CANCELLED";
|
|
942
|
+
readonly R_REINSTATED: "R_REINSTATED";
|
|
943
|
+
};
|
|
944
|
+
|
|
945
|
+
/**
|
|
946
|
+
* The method of payment used in network registration.
|
|
947
|
+
*/
|
|
948
|
+
declare type SettlementPaymentMethods = (typeof SettlementPaymentMethods)[keyof typeof SettlementPaymentMethods];
|
|
949
|
+
|
|
950
|
+
declare const SettlementPaymentMethods: {
|
|
951
|
+
readonly VISA: "VISA";
|
|
952
|
+
readonly AMEX_OPT_BLUE: "AMEX_OPT_BLUE";
|
|
953
|
+
readonly DISCOVER: "DISCOVER";
|
|
954
|
+
};
|
|
955
|
+
|
|
956
|
+
declare interface SocialMedia {
|
|
957
|
+
/** The platform of the social media profile.
|
|
958
|
+
| Platform | Description |
|
|
959
|
+
| -- | -- |
|
|
960
|
+
| FACEBOOK | Facebook, the social media profile at facebook.com. |
|
|
961
|
+
| INSTAGRAM | Instagram, the social media profile at instagram.com. |
|
|
962
|
+
| X | X (formerly known as Twitter), the social media profile at x.com. |
|
|
963
|
+
*/
|
|
964
|
+
profilePlatform: SocialMediaProfilePlatform;
|
|
965
|
+
/**
|
|
966
|
+
* The username of the social media profile.
|
|
967
|
+
* @minLength 1
|
|
968
|
+
* @maxLength 50
|
|
969
|
+
*/
|
|
970
|
+
username: string;
|
|
971
|
+
}
|
|
972
|
+
|
|
973
|
+
/**
|
|
974
|
+
* The entity's social media profiles.
|
|
975
|
+
* @minItems 1
|
|
976
|
+
* @maxItems 3
|
|
977
|
+
*/
|
|
978
|
+
declare type SocialMediaList = SocialMedia[];
|
|
979
|
+
|
|
980
|
+
/**
|
|
981
|
+
* The platform of the social media profile.
|
|
982
|
+
| Platform | Description |
|
|
983
|
+
| -- | -- |
|
|
984
|
+
| FACEBOOK | Facebook, the social media profile at facebook.com. |
|
|
985
|
+
| INSTAGRAM | Instagram, the social media profile at instagram.com. |
|
|
986
|
+
| X | X (formerly known as Twitter), the social media profile at x.com. |
|
|
987
|
+
|
|
988
|
+
*/
|
|
989
|
+
declare type SocialMediaProfilePlatform = (typeof SocialMediaProfilePlatform)[keyof typeof SocialMediaProfilePlatform];
|
|
990
|
+
|
|
991
|
+
declare const SocialMediaProfilePlatform: {
|
|
992
|
+
readonly FACEBOOK: "FACEBOOK";
|
|
993
|
+
readonly INSTAGRAM: "INSTAGRAM";
|
|
994
|
+
readonly X: "X";
|
|
995
|
+
};
|
|
996
|
+
|
|
997
|
+
declare type SoleOwner = boolean;
|
|
998
|
+
|
|
999
|
+
export declare const StepperProvider: FC<yStepper>;
|
|
1000
|
+
|
|
1001
|
+
/**
|
|
1002
|
+
* The mechanism used to provide details at the merchant's terminal for transactions. Required when DISCOVER is selected.
|
|
1003
|
+
|
|
1004
|
+
*/
|
|
1005
|
+
declare type TransactionDeviceType = (typeof TransactionDeviceType)[keyof typeof TransactionDeviceType];
|
|
1006
|
+
|
|
1007
|
+
declare const TransactionDeviceType: {
|
|
1008
|
+
readonly HOST_BASED_POS_DEVICE: "HOST_BASED_POS_DEVICE";
|
|
1009
|
+
readonly TERMINAL_BASED_POS_DEVICE: "TERMINAL_BASED_POS_DEVICE";
|
|
1010
|
+
readonly SOFTWARE_POS_DEVICE: "SOFTWARE_POS_DEVICE";
|
|
1011
|
+
readonly ALL_OTHER_POS_DEVICES: "ALL_OTHER_POS_DEVICES";
|
|
1012
|
+
readonly UNKNOWN: "UNKNOWN";
|
|
1013
|
+
};
|
|
1014
|
+
|
|
1015
|
+
export declare const TransactionsDisplay: FC<TransactionsDisplayProps>;
|
|
1016
|
+
|
|
1017
|
+
export declare type TransactionsDisplayProps = {
|
|
1018
|
+
accountId: string;
|
|
1019
|
+
};
|
|
1020
|
+
|
|
1021
|
+
/**
|
|
1022
|
+
* List of validation info.
|
|
1023
|
+
* @minItems 0
|
|
1024
|
+
* @maxItems 10
|
|
1025
|
+
*/
|
|
1026
|
+
declare type ValidationResponse = ValidationResponseItem[];
|
|
1027
|
+
|
|
1028
|
+
declare type ValidationResponseItem = {
|
|
1029
|
+
/** Comments/basic response related to the workflow step of validation response. */
|
|
1030
|
+
comments?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
* @minItems 0
|
|
1033
|
+
* @maxItems 10
|
|
1034
|
+
*/
|
|
1035
|
+
documentRequestIds?: string[];
|
|
1036
|
+
/**
|
|
1037
|
+
* @minItems 0
|
|
1038
|
+
* @maxItems 100
|
|
1039
|
+
*/
|
|
1040
|
+
fields?: PartyField[];
|
|
1041
|
+
/**
|
|
1042
|
+
* @minItems 0
|
|
1043
|
+
* @maxItems 10
|
|
1044
|
+
*/
|
|
1045
|
+
identities?: string[];
|
|
1046
|
+
validationStatus?: ValidationStatus;
|
|
1047
|
+
validationType?: ValidationType;
|
|
1048
|
+
};
|
|
1049
|
+
|
|
1050
|
+
/**
|
|
1051
|
+
* Status of a party validation. Missing fields result in `NEEDS_INFO`.
|
|
1052
|
+
|
|
1053
|
+
*/
|
|
1054
|
+
declare type ValidationStatus = (typeof ValidationStatus)[keyof typeof ValidationStatus];
|
|
1055
|
+
|
|
1056
|
+
declare const ValidationStatus: {
|
|
1057
|
+
readonly NOT_STARTED: "NOT_STARTED";
|
|
1058
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
1059
|
+
readonly NOT_VALIDATED: "NOT_VALIDATED";
|
|
1060
|
+
readonly NEEDS_INFO: "NEEDS_INFO";
|
|
1061
|
+
readonly NEEDS_REVIEW: "NEEDS_REVIEW";
|
|
1062
|
+
readonly VALIDATED: "VALIDATED";
|
|
1063
|
+
};
|
|
1064
|
+
|
|
1065
|
+
declare type ValidationType = (typeof ValidationType)[keyof typeof ValidationType];
|
|
1066
|
+
|
|
1067
|
+
declare const ValidationType: {
|
|
1068
|
+
readonly ENTITY_VALIDATION: "ENTITY_VALIDATION";
|
|
1069
|
+
};
|
|
1070
|
+
|
|
1071
|
+
/**
|
|
1072
|
+
* The type of Visa debit card acceptance. Required when VISA is selected.
|
|
1073
|
+
*/
|
|
1074
|
+
declare type VisaDebitAcceptance = (typeof VisaDebitAcceptance)[keyof typeof VisaDebitAcceptance];
|
|
1075
|
+
|
|
1076
|
+
declare const VisaDebitAcceptance: {
|
|
1077
|
+
readonly DEBIT_NOT_ACCEPTED: "DEBIT_NOT_ACCEPTED";
|
|
1078
|
+
readonly DEBIT_ACCEPTED_CARD_PRESENT: "DEBIT_ACCEPTED_CARD_PRESENT";
|
|
1079
|
+
readonly DEBIT_ACCEPTED_CARD_NOT_PRESENT: "DEBIT_ACCEPTED_CARD_NOT_PRESENT";
|
|
1080
|
+
readonly DEBIT_ACCEPTED_ALL: "DEBIT_ACCEPTED_ALL";
|
|
1081
|
+
};
|
|
1082
|
+
|
|
1083
|
+
/**
|
|
1084
|
+
* Name/URL of the website
|
|
1085
|
+
* @minLength 1
|
|
1086
|
+
* @maxLength 500
|
|
1087
|
+
*/
|
|
1088
|
+
declare type Website = string;
|
|
1089
|
+
|
|
1090
|
+
/**
|
|
1091
|
+
* Whether the party has a website. False if opted out.
|
|
1092
|
+
*/
|
|
1093
|
+
declare type WebsiteAvailable = boolean;
|
|
1094
|
+
|
|
1095
|
+
/**
|
|
1096
|
+
* Year of company formation.
|
|
1097
|
+
* @minLength 4
|
|
1098
|
+
* @maxLength 4
|
|
1099
|
+
* @pattern \d{4}
|
|
1100
|
+
*/
|
|
1101
|
+
declare type YearOfFormation = string;
|
|
1102
|
+
|
|
1103
|
+
declare type yStepper = {
|
|
1104
|
+
children: ReactNode;
|
|
1105
|
+
};
|
|
1106
|
+
|
|
1107
|
+
export { }
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
declare namespace Calendar {
|
|
1111
|
+
var displayName: string;
|
|
1112
|
+
}
|
|
1113
|
+
|