rebilly-js-sdk 46.3.0 → 46.4.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.
@@ -344,6 +344,25 @@ declare module rebilly {
344
344
  type DeleteInvoiceTimelineResponse = operations['DeleteInvoiceTimeline']['responses']['204']
345
345
  type DeleteInvoiceTimelineResponsePromise = Promise<{fields: DeleteInvoiceTimelineResponse}>
346
346
 
347
+ type GetKycRequestCollectionRequest = operations['GetKycRequestCollection']['parameters']["query"] & (operations['GetKycRequestCollection']['parameters'] extends {path: {}} ? operations['GetKycRequestCollection']['parameters']["path"] : {})
348
+
349
+ type GetKycRequestCollectionResponse = operations['GetKycRequestCollection']['responses']['200']['content']['application/json'][0]
350
+ type GetKycRequestCollectionResponsePromise = Promise<{ items: {fields: GetKycRequestCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
351
+ type PostKycRequestRequest = operations['PostKycRequest']['requestBody']['content']['application/json']
352
+ type CreateKycRequestRequest = { id: String, data: PostKycRequestRequest, expand?: String }
353
+ type PostKycRequestResponse = operations['PostKycRequest']['responses']['201']['content']['application/json']
354
+ type PostKycRequestResponsePromise = Promise<{fields: PostKycRequestResponse}>
355
+
356
+ type GetKycRequestRequest = { id : String }
357
+
358
+ type GetKycRequestResponse = operations['GetKycRequest']['responses']['200']['content']['application/json']
359
+ type GetKycRequestResponsePromise = Promise<{fields: GetKycRequestResponse}>
360
+ type PatchKycRequestRequest = operations['PatchKycRequest']['requestBody']['content']['application/json']
361
+ type PatchKycRequestResponse = operations['PatchKycRequest']['responses']['200']['content']['application/json']
362
+ type PatchKycRequestResponsePromise = Promise<{fields: PatchKycRequestResponse}>
363
+ type DeleteKycRequestResponse = operations['DeleteKycRequest']['responses']['204']
364
+ type DeleteKycRequestResponsePromise = Promise<{fields: DeleteKycRequestResponse}>
365
+
347
366
  type GetKycDocumentCollectionRequest = operations['GetKycDocumentCollection']['parameters']["query"] & (operations['GetKycDocumentCollection']['parameters'] extends {path: {}} ? operations['GetKycDocumentCollection']['parameters']["path"] : {})
348
367
 
349
368
  type GetKycDocumentCollectionResponse = operations['GetKycDocumentCollection']['responses']['200']['content']['application/json'][0]
@@ -383,24 +402,9 @@ declare module rebilly {
383
402
  type PostKycDocumentStopReviewResponse = operations['PostKycDocumentStopReview']['responses']['201']['content']['application/json']
384
403
  type PostKycDocumentStopReviewResponsePromise = Promise<{fields: PostKycDocumentStopReviewResponse}>
385
404
 
386
- type GetKycRequestCollectionRequest = operations['GetKycRequestCollection']['parameters']["query"] & (operations['GetKycRequestCollection']['parameters'] extends {path: {}} ? operations['GetKycRequestCollection']['parameters']["path"] : {})
387
-
388
- type GetKycRequestCollectionResponse = operations['GetKycRequestCollection']['responses']['200']['content']['application/json'][0]
389
- type GetKycRequestCollectionResponsePromise = Promise<{ items: {fields: GetKycRequestCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
390
- type PostKycRequestRequest = operations['PostKycRequest']['requestBody']['content']['application/json']
391
- type CreateKycRequestRequest = { id: String, data: PostKycRequestRequest, expand?: String }
392
- type PostKycRequestResponse = operations['PostKycRequest']['responses']['201']['content']['application/json']
393
- type PostKycRequestResponsePromise = Promise<{fields: PostKycRequestResponse}>
394
-
395
- type GetKycRequestRequest = { id : String }
396
-
397
- type GetKycRequestResponse = operations['GetKycRequest']['responses']['200']['content']['application/json']
398
- type GetKycRequestResponsePromise = Promise<{fields: GetKycRequestResponse}>
399
- type PatchKycRequestRequest = operations['PatchKycRequest']['requestBody']['content']['application/json']
400
- type PatchKycRequestResponse = operations['PatchKycRequest']['responses']['200']['content']['application/json']
401
- type PatchKycRequestResponsePromise = Promise<{fields: PatchKycRequestResponse}>
402
- type DeleteKycRequestResponse = operations['DeleteKycRequest']['responses']['204']
403
- type DeleteKycRequestResponsePromise = Promise<{fields: DeleteKycRequestResponse}>
405
+ type PutKycSettingsRequest = operations['PutKycSettings']['requestBody']['content']['application/json']
406
+ type PutKycSettingsResponse = operations['PutKycSettings']['responses']['200']['content']['application/json']
407
+ type PutKycSettingsResponsePromise = Promise<{fields: PutKycSettingsResponse}>
404
408
 
405
409
  type GetPasswordTokenCollectionRequest = operations['GetPasswordTokenCollection']['parameters']["query"] & (operations['GetPasswordTokenCollection']['parameters'] extends {path: {}} ? operations['GetPasswordTokenCollection']['parameters']["path"] : {})
406
410
 
@@ -2288,6 +2292,33 @@ export interface corePaths {
2288
2292
  };
2289
2293
  };
2290
2294
  };
2295
+ "/kyc-requests": {
2296
+ /** Retrieve a list of KYC requests. */
2297
+ get: operations["GetKycRequestCollection"];
2298
+ /**
2299
+ * Create a KYC Request.
2300
+ * Then, redirect the customer to the `kycGatherer` link.
2301
+ * After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
2302
+ * Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
2303
+ * When the complete list of documents is received and accepted, the KYC request fulfilled webhook will be sent to subscribers.
2304
+ * If a `credit-file-proof` is successful with the dual process method, then corresponding `identity-proof` and `address-proof` documents are not requested.
2305
+ */
2306
+ post: operations["PostKycRequest"];
2307
+ };
2308
+ "/kyc-requests/{id}": {
2309
+ /** Retrieve a KYC request with specified identifier string. */
2310
+ get: operations["GetKycRequest"];
2311
+ /** Delete the KYC request with the predefined identifier string. */
2312
+ delete: operations["DeleteKycRequest"];
2313
+ /** Update a KYC request. */
2314
+ patch: operations["PatchKycRequest"];
2315
+ parameters: {
2316
+ path: {
2317
+ /** The resource identifier string. */
2318
+ id: coreComponents["parameters"]["resourceId"];
2319
+ };
2320
+ };
2321
+ };
2291
2322
  "/kyc-documents": {
2292
2323
  /** Retrieve a list of KYC documents. */
2293
2324
  get: operations["GetKycDocumentCollection"];
@@ -2366,30 +2397,9 @@ export interface corePaths {
2366
2397
  };
2367
2398
  };
2368
2399
  };
2369
- "/kyc-requests": {
2370
- /** Retrieve a list of KYC requests. */
2371
- get: operations["GetKycRequestCollection"];
2372
- /**
2373
- * Create a KYC Request.
2374
- * Then, redirect the customer to the `kycGatherer` link.
2375
- * After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
2376
- * Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
2377
- */
2378
- post: operations["PostKycRequest"];
2379
- };
2380
- "/kyc-requests/{id}": {
2381
- /** Retrieve a KYC request with specified identifier string. */
2382
- get: operations["GetKycRequest"];
2383
- /** Delete the KYC request with the predefined identifier string. */
2384
- delete: operations["DeleteKycRequest"];
2385
- /** Update a KYC request. */
2386
- patch: operations["PatchKycRequest"];
2387
- parameters: {
2388
- path: {
2389
- /** The resource identifier string. */
2390
- id: coreComponents["parameters"]["resourceId"];
2391
- };
2392
- };
2400
+ "/kyc-settings": {
2401
+ /** Update KYC settings. */
2402
+ put: operations["PutKycSettings"];
2393
2403
  };
2394
2404
  "/password-tokens": {
2395
2405
  /** Retrieve a list of tokens. */
@@ -3347,11 +3357,10 @@ export interface coreComponents {
3347
3357
  time: string;
3348
3358
  };
3349
3359
  /** Quantity per Customer restrictions. */
3350
- "redemptions-per-customer": coreComponents["schemas"]["CouponRestriction"] &
3351
- coreComponents["schemas"]["RedemptionRestriction"] & {
3352
- /** Restriction value. */
3353
- quantity: number;
3354
- };
3360
+ "redemptions-per-customer": coreComponents["schemas"]["CouponRestriction"] & {
3361
+ /** Restriction value. */
3362
+ quantity: number;
3363
+ };
3355
3364
  /** restrict-to-countries restrictions. */
3356
3365
  "restrict-to-countries": coreComponents["schemas"]["CouponRestriction"] &
3357
3366
  coreComponents["schemas"]["RedemptionRestriction"] & {
@@ -3387,11 +3396,10 @@ export interface coreComponents {
3387
3396
  subscriptionIds: string[];
3388
3397
  };
3389
3398
  /** total-redemptions restrictions. */
3390
- "total-redemptions": coreComponents["schemas"]["CouponRestriction"] &
3391
- coreComponents["schemas"]["RedemptionRestriction"] & {
3392
- /** Total redemptions quantity. */
3393
- quantity: number;
3394
- };
3399
+ "total-redemptions": coreComponents["schemas"]["CouponRestriction"] & {
3400
+ /** Total redemptions quantity. */
3401
+ quantity: number;
3402
+ };
3395
3403
  /** Coupons redemption log. */
3396
3404
  CouponRedemption: {
3397
3405
  id?: coreComponents["schemas"]["ResourceId"];
@@ -4578,6 +4586,8 @@ export interface coreComponents {
4578
4586
  kountFraudSessionId?: string;
4579
4587
  /** MerchantSessionID as generated by the PayPal Fraudnet SDK. */
4580
4588
  payPalMerchantSessionId?: string;
4589
+ /** A temporary identifier that is unique to the visitor's session and passed to ThreatMetrix. */
4590
+ threatMetrixSessionId?: string;
4581
4591
  };
4582
4592
  /** Risk metadata used for 3DS and risk scoring. */
4583
4593
  RiskMetadata: {
@@ -5433,6 +5443,10 @@ export interface coreComponents {
5433
5443
  /** Checkout.com secret API key. */
5434
5444
  secretKey: string;
5435
5445
  };
5446
+ settings?: {
5447
+ /** Mark as waiting-gateway/unknown instead of approved on pending payout. */
5448
+ markAsWaitingGatewayOnPendingPayout: boolean;
5449
+ };
5436
5450
  threeDSecureServer?: coreComponents["schemas"]["CheckoutCom3dsServers"];
5437
5451
  };
5438
5452
  /** Circle config. */
@@ -6810,6 +6824,8 @@ export interface coreComponents {
6810
6824
  merchantCode: string;
6811
6825
  /** Redsys Gateway secret code. */
6812
6826
  secretCode: string;
6827
+ /** Redsys Gateway merchant sha256 code. Required for Bizum payments. */
6828
+ sha256SecretCode?: string;
6813
6829
  };
6814
6830
  };
6815
6831
  /** Rotessa config. */
@@ -7627,6 +7643,8 @@ export interface coreComponents {
7627
7643
  expirationReminderNumber?: number | null;
7628
7644
  /** Payment instrument reference data. */
7629
7645
  referenceData?: { [key: string]: string };
7646
+ /** Digital wallet type. */
7647
+ digitalWallet?: ("Apple Pay" | "Google Pay") | null;
7630
7648
  /** The links related to resource. */
7631
7649
  _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
7632
7650
  Partial<coreComponents["schemas"]["CustomerLink"]> &
@@ -8263,8 +8281,8 @@ export interface coreComponents {
8263
8281
  firstName?: number;
8264
8282
  /** The weight of lastName. */
8265
8283
  lastName?: number;
8266
- /** The weight of expiryDate. */
8267
- expiryDate?: number;
8284
+ /** The weight of `expirationDate`. */
8285
+ expirationDate?: number;
8268
8286
  /** The weight of dateOfBirth. */
8269
8287
  dateOfBirth?: number;
8270
8288
  /** The weight of matchesDateOfBirth. */
@@ -8314,6 +8332,11 @@ export interface coreComponents {
8314
8332
  acceptAbove?: number;
8315
8333
  };
8316
8334
  };
8335
+ /** The settings for score calculation. */
8336
+ KycSettings: {
8337
+ identityProof?: coreComponents["schemas"]["KycSettingsIdentity"];
8338
+ addressProof?: coreComponents["schemas"]["KycSettingsAddress"];
8339
+ };
8317
8340
  OrganizationSettings: {
8318
8341
  /** The settings for tax calculation. */
8319
8342
  defaultTaxCalculator?: {
@@ -8322,11 +8345,7 @@ export interface coreComponents {
8322
8345
  /** The rate for flat tax calculation. */
8323
8346
  rate?: number | null;
8324
8347
  };
8325
- /** The settings for tax calculation. */
8326
- kyc?: {
8327
- "identity-proof"?: coreComponents["schemas"]["KycSettingsIdentity"];
8328
- "address-proof"?: coreComponents["schemas"]["KycSettingsAddress"];
8329
- };
8348
+ kyc?: coreComponents["schemas"]["KycSettings"];
8330
8349
  };
8331
8350
  Organization: {
8332
8351
  /** The organization identifier string. */
@@ -8791,7 +8810,8 @@ export interface coreComponents {
8791
8810
  | "identity-proof"
8792
8811
  | "address-proof"
8793
8812
  | "funds-proof"
8794
- | "purchase-proof";
8813
+ | "purchase-proof"
8814
+ | "credit-file-proof";
8795
8815
  KycDocumentSubtypes:
8796
8816
  | "passport"
8797
8817
  | "id-card"
@@ -8814,180 +8834,6 @@ export interface coreComponents {
8814
8834
  | "ewallet-holder-details"
8815
8835
  | "ewallet-transaction-statement"
8816
8836
  | "other";
8817
- KycDocumentRejectionReasonTypes:
8818
- | "document-unreadable"
8819
- | "document-expired"
8820
- | "document-not-matching"
8821
- | "underage-person"
8822
- | "other";
8823
- KycDocumentRejection: {
8824
- type?: coreComponents["schemas"]["KycDocumentRejectionReasonTypes"];
8825
- /** The rejection message. */
8826
- message?: string;
8827
- };
8828
- CommonKycDocument: {
8829
- id?: coreComponents["schemas"]["ResourceId"];
8830
- /** Linked file object id. */
8831
- fileId?: coreComponents["schemas"]["ResourceId"];
8832
- /**
8833
- * Linked file object id's.
8834
- *
8835
- * Files uploaded for identity-proof must have following corresponding tags attached `['kyc', 'id-front']`, `['kyc', 'id-back']`, `['kyc', 'face-proof']` in order to be properly recognized as identity-proof files.
8836
- */
8837
- fileIds?: coreComponents["schemas"]["ResourceId"][];
8838
- /** Document type submitted for validation, only identity-proof type is analyzed in an automated manner. */
8839
- documentType: coreComponents["schemas"]["KycDocumentTypes"];
8840
- /** Document subtype submitted for validation. */
8841
- documentSubtype?: coreComponents["schemas"]["KycDocumentSubtypes"];
8842
- /** Status of the validation. */
8843
- status: "pending" | "in-progress" | "accepted" | "rejected" | "archived";
8844
- rejectionReason?: coreComponents["schemas"]["KycDocumentRejection"];
8845
- /** KYC request identifier string. */
8846
- requestId?: coreComponents["schemas"]["ResourceId"] | null;
8847
- /** Creation date/time. */
8848
- createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8849
- /** Latest update date/time. */
8850
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8851
- /** Processing date/time. */
8852
- processedTime?: coreComponents["schemas"]["ServerTimestamp"];
8853
- /** The links related to resource. */
8854
- _links?: Partial<coreComponents["schemas"]["SelfLink"]>[];
8855
- };
8856
- KycDocument: coreComponents["schemas"]["CommonKycDocument"] & {
8857
- /** The customer ID. */
8858
- customerId?: coreComponents["schemas"]["ResourceId"];
8859
- /** Reviewer's user ID. */
8860
- reviewerId?: string | null;
8861
- /** Reviewer's first and last name. */
8862
- reviewerName?: string | null;
8863
- /** Date and time that manual review starts. */
8864
- reviewStartTime?: string | null;
8865
- /** Date and time of manual review. */
8866
- reviewTime?: string | null;
8867
- /** Reviewer notes. */
8868
- notes?: string | null;
8869
- /** A list of kyc document tags. */
8870
- tags?: coreComponents["schemas"]["Tag"][];
8871
- /** Reason for uploading. */
8872
- reason?: string;
8873
- /** The level of strictness for the document matches. */
8874
- matchLevel?: number;
8875
- /** The settings used to score the document. */
8876
- settings?: { [key: string]: any } | null;
8877
- };
8878
- IdentityMatches: {
8879
- /** Flag that indicates if there is an image that contains a face on it. */
8880
- containsImage?: boolean;
8881
- /** Flag that indicates if this looks like and ID. */
8882
- isIdentityDocument?: boolean;
8883
- /** If there is an exact match found online. */
8884
- isPublishedOnline?: boolean;
8885
- /** The customer first name if it was matched, null otherwise. */
8886
- firstName?: string;
8887
- /** The customer last name if it was matched, null otherwise. */
8888
- lastName?: string;
8889
- /** The date of birth found on the document, null if not found. */
8890
- dateOfBirth?: string;
8891
- /** The expiry date found on the document, null if not found. */
8892
- expiryDate?: string;
8893
- /** The issued date found on the document, null if not found. */
8894
- issueDate?: string;
8895
- /** Checks the minimal age, 21+ for USA and 18+ for all other countries. Null if dateOfBirth could not be determined. */
8896
- hasMinimalAge?: boolean;
8897
- /** The nationality found on the document, null otherwise. */
8898
- nationality?: string;
8899
- };
8900
- ProofOfIdentity: coreComponents["schemas"]["KycDocument"] & {
8901
- documentMatches?: {
8902
- /** The calculated score that represents the % of confidence that this ID represents the given customer. */
8903
- score?: number;
8904
- data?: coreComponents["schemas"]["IdentityMatches"];
8905
- };
8906
- parsedData?: {
8907
- /** The calculated score that represents the % of confidence that this ID represents the given customer. */
8908
- score?: number;
8909
- data?: coreComponents["schemas"]["IdentityMatches"];
8910
- };
8911
- settings?: coreComponents["schemas"]["KycSettingsIdentity"];
8912
- /** The links related to resource. */
8913
- _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
8914
- Partial<coreComponents["schemas"]["FileLink"]> &
8915
- Partial<coreComponents["schemas"]["CustomerLink"]>)[];
8916
- };
8917
- AddressMatches: {
8918
- /** The customer first name if it was matched, null otherwise. */
8919
- firstName?: string;
8920
- /** The customer last name if it was matched, null otherwise. */
8921
- lastName?: string;
8922
- /** The customer address if it was matched, null otherwise. */
8923
- line1?: string;
8924
- /** The customer city if it was matched, null otherwise. */
8925
- city?: string;
8926
- /** The customer region if it was matched, null otherwise. */
8927
- region?: string;
8928
- /** The customer postal code if it was matched, null otherwise. */
8929
- postalCode?: string;
8930
- /** The number of words in the document. */
8931
- wordCount?: number;
8932
- /** Flag that indicates if the word count passed the threshold. */
8933
- wordCountResult?: boolean;
8934
- /** The number of unique words in the document. */
8935
- uniqueWords?: number;
8936
- /** Flag that indicates if the unique words passed the threshold. */
8937
- uniqueWordsResult?: boolean;
8938
- /** The date on the document proving the document is recent. */
8939
- date?: string;
8940
- /** The phone of the company or agency that sent the document. */
8941
- phone?: string;
8942
- };
8943
- ProofOfAddress: coreComponents["schemas"]["KycDocument"] & {
8944
- documentMatches?: {
8945
- /** The calculated score that represents the % of confidence that this proof of address represents the given customer. */
8946
- score?: number;
8947
- data?: coreComponents["schemas"]["AddressMatches"];
8948
- };
8949
- parsedData?: {
8950
- /** The calculated score that represents the % of confidence that this proof of address represents the given customer. */
8951
- score?: number;
8952
- data?: coreComponents["schemas"]["AddressMatches"];
8953
- };
8954
- settings?: coreComponents["schemas"]["KycSettingsAddress"];
8955
- /** The links related to resource. */
8956
- _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
8957
- Partial<coreComponents["schemas"]["FileLink"]> &
8958
- Partial<coreComponents["schemas"]["CustomerLink"]>)[];
8959
- };
8960
- ProofOfFunds: coreComponents["schemas"]["KycDocument"];
8961
- PurchaseMatches: {
8962
- /** The customer first name if it was matched, null otherwise. */
8963
- firstName?: string;
8964
- /** The customer last name if it was matched, null otherwise. */
8965
- lastName?: string;
8966
- /** The payment instrument related to the document, null otherwise. */
8967
- paymentInstrumentId?: string;
8968
- };
8969
- PaymentInstrumentLink: coreComponents["schemas"]["Link"] & {
8970
- /** The link type. */
8971
- rel: "paymentInstrument";
8972
- };
8973
- ProofOfPurchase: coreComponents["schemas"]["KycDocument"] & {
8974
- documentMatches?: {
8975
- data?: coreComponents["schemas"]["PurchaseMatches"];
8976
- };
8977
- parsedData?: {
8978
- data?: coreComponents["schemas"]["PurchaseMatches"];
8979
- };
8980
- /** The links related to resource. */
8981
- _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
8982
- Partial<coreComponents["schemas"]["FileLink"]> &
8983
- Partial<coreComponents["schemas"]["CustomerLink"]> &
8984
- Partial<coreComponents["schemas"]["PaymentInstrumentLink"]>)[];
8985
- };
8986
- "KycDocument-2":
8987
- | coreComponents["schemas"]["ProofOfIdentity"]
8988
- | coreComponents["schemas"]["ProofOfAddress"]
8989
- | coreComponents["schemas"]["ProofOfFunds"]
8990
- | coreComponents["schemas"]["ProofOfPurchase"];
8991
8837
  CommonKycRequest: {
8992
8838
  id?: coreComponents["schemas"]["ResourceId"];
8993
8839
  /** Documents to be requested from customer. */
@@ -9038,6 +8884,67 @@ export interface coreComponents {
9038
8884
  /** The KYC gatherer URL to redirect the customer to complete the KYC process. */
9039
8885
  href: string;
9040
8886
  };
8887
+ KycDocumentRejectionReasonTypes:
8888
+ | "document-unreadable"
8889
+ | "document-expired"
8890
+ | "document-not-matching"
8891
+ | "underage-person"
8892
+ | "other";
8893
+ KycDocumentRejection: {
8894
+ type?: coreComponents["schemas"]["KycDocumentRejectionReasonTypes"];
8895
+ /** The rejection message. */
8896
+ message?: string;
8897
+ };
8898
+ CommonKycDocument: {
8899
+ id?: coreComponents["schemas"]["ResourceId"];
8900
+ /** Linked file object id. */
8901
+ fileId?: coreComponents["schemas"]["ResourceId"];
8902
+ /**
8903
+ * Linked file object id's.
8904
+ *
8905
+ * Files uploaded for identity-proof must have following corresponding tags attached `['kyc', 'id-front']`, `['kyc', 'id-back']`, `['kyc', 'face-proof']` in order to be properly recognized as identity-proof files.
8906
+ */
8907
+ fileIds?: coreComponents["schemas"]["ResourceId"][];
8908
+ /** Document type submitted for validation, only identity-proof type is analyzed in an automated manner. */
8909
+ documentType: coreComponents["schemas"]["KycDocumentTypes"];
8910
+ /** Document subtype submitted for validation. */
8911
+ documentSubtype?: coreComponents["schemas"]["KycDocumentSubtypes"];
8912
+ /** Status of the validation. */
8913
+ status: "pending" | "in-progress" | "accepted" | "rejected" | "archived";
8914
+ rejectionReason?: coreComponents["schemas"]["KycDocumentRejection"];
8915
+ /** KYC request identifier string. */
8916
+ requestId?: coreComponents["schemas"]["ResourceId"] | null;
8917
+ /** Creation date/time. */
8918
+ createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8919
+ /** Latest update date/time. */
8920
+ updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8921
+ /** Processing date/time. */
8922
+ processedTime?: coreComponents["schemas"]["ServerTimestamp"];
8923
+ /** The links related to resource. */
8924
+ _links?: Partial<coreComponents["schemas"]["SelfLink"]>[];
8925
+ };
8926
+ KycDocument: coreComponents["schemas"]["CommonKycDocument"] & {
8927
+ /** The customer ID. */
8928
+ customerId?: coreComponents["schemas"]["ResourceId"];
8929
+ /** Reviewer's user ID. */
8930
+ reviewerId?: string | null;
8931
+ /** Reviewer's first and last name. */
8932
+ reviewerName?: string | null;
8933
+ /** Date and time that manual review starts. */
8934
+ reviewStartTime?: string | null;
8935
+ /** Date and time of manual review. */
8936
+ reviewTime?: string | null;
8937
+ /** Reviewer notes. */
8938
+ notes?: string | null;
8939
+ /** A list of kyc document tags. */
8940
+ tags?: coreComponents["schemas"]["Tag"][];
8941
+ /** Reason for uploading. */
8942
+ reason?: string;
8943
+ /** The level of strictness for the document matches. */
8944
+ matchLevel?: number;
8945
+ /** The settings used to score the document. */
8946
+ settings?: { [key: string]: any } | null;
8947
+ };
9041
8948
  KycRequest: coreComponents["schemas"]["CommonKycRequest"] & {
9042
8949
  /** The customer ID. */
9043
8950
  customerId: coreComponents["schemas"]["ResourceId"];
@@ -9057,6 +8964,154 @@ export interface coreComponents {
9057
8964
  documents?: coreComponents["schemas"]["KycDocument"][];
9058
8965
  };
9059
8966
  };
8967
+ IdentityMatches: {
8968
+ /** Flag that indicates if there is an image that contains a face on it. */
8969
+ containsImage?: boolean;
8970
+ /** Flag that indicates if this looks like and ID. */
8971
+ isIdentityDocument?: boolean;
8972
+ /** If there is an exact match found online. */
8973
+ isPublishedOnline?: boolean;
8974
+ /** The customer first name if it was matched, null otherwise. */
8975
+ firstName?: string;
8976
+ /** The customer last name if it was matched, null otherwise. */
8977
+ lastName?: string;
8978
+ /** The date of birth found on the document, null if not found. */
8979
+ dateOfBirth?: string;
8980
+ /** The expiry date found on the document, null if not found. */
8981
+ expiryDate?: string;
8982
+ /** The expiration date found on the document, null if not found. */
8983
+ expirationDate?: string;
8984
+ /** The issued date found on the document, null if not found. */
8985
+ issueDate?: string;
8986
+ /** Checks the minimal age, 21+ for USA and 18+ for all other countries. Null if dateOfBirth could not be determined. */
8987
+ hasMinimalAge?: boolean;
8988
+ /** The nationality found on the document, null otherwise. */
8989
+ nationality?: string;
8990
+ };
8991
+ ProofOfIdentity: coreComponents["schemas"]["KycDocument"] & {
8992
+ documentMatches?: {
8993
+ /** The calculated score that represents the % of confidence that this ID represents the given customer. */
8994
+ score?: number;
8995
+ data?: coreComponents["schemas"]["IdentityMatches"];
8996
+ };
8997
+ parsedData?: {
8998
+ /** The calculated score that represents the % of confidence that this ID represents the given customer. */
8999
+ score?: number;
9000
+ data?: coreComponents["schemas"]["IdentityMatches"];
9001
+ };
9002
+ settings?: coreComponents["schemas"]["KycSettingsIdentity"];
9003
+ /** The links related to resource. */
9004
+ _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
9005
+ Partial<coreComponents["schemas"]["FileLink"]> &
9006
+ Partial<coreComponents["schemas"]["CustomerLink"]>)[];
9007
+ };
9008
+ AddressMatches: {
9009
+ /** The customer first name if it was matched, null otherwise. */
9010
+ firstName?: string;
9011
+ /** The customer last name if it was matched, null otherwise. */
9012
+ lastName?: string;
9013
+ /** The customer address if it was matched, null otherwise. */
9014
+ line1?: string;
9015
+ /** The customer city if it was matched, null otherwise. */
9016
+ city?: string;
9017
+ /** The customer region if it was matched, null otherwise. */
9018
+ region?: string;
9019
+ /** The customer postal code if it was matched, null otherwise. */
9020
+ postalCode?: string;
9021
+ /** The number of words in the document. */
9022
+ wordCount?: number;
9023
+ /** Flag that indicates if the word count passed the threshold. */
9024
+ wordCountResult?: boolean;
9025
+ /** The number of unique words in the document. */
9026
+ uniqueWords?: number;
9027
+ /** Flag that indicates if the unique words passed the threshold. */
9028
+ uniqueWordsResult?: boolean;
9029
+ /** The date on the document proving the document is recent. */
9030
+ date?: string;
9031
+ /** The phone of the company or agency that sent the document. */
9032
+ phone?: string;
9033
+ };
9034
+ ProofOfAddress: coreComponents["schemas"]["KycDocument"] & {
9035
+ documentMatches?: {
9036
+ /** The calculated score that represents the % of confidence that this proof of address represents the given customer. */
9037
+ score?: number;
9038
+ data?: coreComponents["schemas"]["AddressMatches"];
9039
+ };
9040
+ parsedData?: {
9041
+ /** The calculated score that represents the % of confidence that this proof of address represents the given customer. */
9042
+ score?: number;
9043
+ data?: coreComponents["schemas"]["AddressMatches"];
9044
+ };
9045
+ settings?: coreComponents["schemas"]["KycSettingsAddress"];
9046
+ /** The links related to resource. */
9047
+ _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
9048
+ Partial<coreComponents["schemas"]["FileLink"]> &
9049
+ Partial<coreComponents["schemas"]["CustomerLink"]>)[];
9050
+ };
9051
+ ProofOfFunds: coreComponents["schemas"]["KycDocument"];
9052
+ PurchaseMatches: {
9053
+ /** The customer first name if it was matched, null otherwise. */
9054
+ firstName?: string;
9055
+ /** The customer last name if it was matched, null otherwise. */
9056
+ lastName?: string;
9057
+ /** The payment instrument related to the document, null otherwise. */
9058
+ paymentInstrumentId?: string;
9059
+ };
9060
+ PaymentInstrumentLink: coreComponents["schemas"]["Link"] & {
9061
+ /** The link type. */
9062
+ rel: "paymentInstrument";
9063
+ };
9064
+ ProofOfPurchase: coreComponents["schemas"]["KycDocument"] & {
9065
+ documentMatches?: {
9066
+ data?: coreComponents["schemas"]["PurchaseMatches"];
9067
+ };
9068
+ parsedData?: {
9069
+ data?: coreComponents["schemas"]["PurchaseMatches"];
9070
+ };
9071
+ /** The links related to resource. */
9072
+ _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
9073
+ Partial<coreComponents["schemas"]["FileLink"]> &
9074
+ Partial<coreComponents["schemas"]["CustomerLink"]> &
9075
+ Partial<coreComponents["schemas"]["PaymentInstrumentLink"]>)[];
9076
+ };
9077
+ CreditFileMatches: {
9078
+ /** The credit bureau which is used to get credit file data. */
9079
+ creditBureau?: "equifax" | "experian" | "transunion";
9080
+ /** The credit file number on credit bureau. */
9081
+ creditFileNumber?: string;
9082
+ /** Return true if first name is matched otherwise false. */
9083
+ isFirstNameMatched?: boolean;
9084
+ /** Return true if last name is matched otherwise false. */
9085
+ isLastNameMatched?: boolean;
9086
+ /** Return true if address civic number is matched otherwise false. */
9087
+ isCivicNumberMatched?: boolean;
9088
+ /** Return true if street address is matched otherwise false. */
9089
+ isStreetMatched?: boolean;
9090
+ /** Return true if city is matched otherwise false. */
9091
+ isCityMatched?: boolean;
9092
+ /** Return true if postal code is matched otherwise false. */
9093
+ isPostalCodeMatched?: boolean;
9094
+ /** Return true if province is matched otherwise false. */
9095
+ isProvinceMatched?: boolean;
9096
+ /** Return true if date of birth is matched otherwise false. */
9097
+ isDobMatched?: boolean;
9098
+ /** Extra data from credit bureau. */
9099
+ referenceData?: { [key: string]: any };
9100
+ };
9101
+ ProofOfCreditFile: coreComponents["schemas"]["KycDocument"] & {
9102
+ documentMatches?: {
9103
+ data?: coreComponents["schemas"]["CreditFileMatches"];
9104
+ };
9105
+ /** The links related to resource. */
9106
+ _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
9107
+ Partial<coreComponents["schemas"]["CustomerLink"]>)[];
9108
+ };
9109
+ "KycDocument-2":
9110
+ | coreComponents["schemas"]["ProofOfIdentity"]
9111
+ | coreComponents["schemas"]["ProofOfAddress"]
9112
+ | coreComponents["schemas"]["ProofOfFunds"]
9113
+ | coreComponents["schemas"]["ProofOfPurchase"]
9114
+ | coreComponents["schemas"]["ProofOfCreditFile"];
9060
9115
  ResetPasswordToken: {
9061
9116
  /** The token's identifier string. */
9062
9117
  token?: string;
@@ -9157,6 +9212,7 @@ export interface coreComponents {
9157
9212
  | "Beeline"
9158
9213
  | "Belfius-direct-net"
9159
9214
  | "bitcoin"
9215
+ | "Bizum"
9160
9216
  | "Boleto"
9161
9217
  | "cash-deposit"
9162
9218
  | "CASHlib"
@@ -13139,6 +13195,120 @@ export interface operations {
13139
13195
  409: coreComponents["responses"]["Conflict"];
13140
13196
  };
13141
13197
  };
13198
+ /** Retrieve a list of KYC requests. */
13199
+ GetKycRequestCollection: {
13200
+ parameters: {
13201
+ query: {
13202
+ /** The collection items limit. */
13203
+ limit?: coreComponents["parameters"]["collectionLimit"];
13204
+ /** The collection items offset. */
13205
+ offset?: coreComponents["parameters"]["collectionOffset"];
13206
+ /**
13207
+ * The collection items filter requires a special format.
13208
+ * Use "," for multiple allowed values. Use ";" for multiple fields.
13209
+ * See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
13210
+ */
13211
+ filter?: coreComponents["parameters"]["collectionFilter"];
13212
+ /** The collection items sort field and order (prefix with "-" for descending sort). */
13213
+ sort?: coreComponents["parameters"]["collectionSort"];
13214
+ };
13215
+ };
13216
+ responses: {
13217
+ /** A list of KYC requests was retrieved successfully. */
13218
+ 200: {
13219
+ headers: {};
13220
+ content: {
13221
+ "application/json": coreComponents["schemas"]["KycRequest"][];
13222
+ };
13223
+ };
13224
+ 401: coreComponents["responses"]["Unauthorized"];
13225
+ 403: coreComponents["responses"]["Forbidden"];
13226
+ };
13227
+ };
13228
+ /**
13229
+ * Create a KYC Request.
13230
+ * Then, redirect the customer to the `kycGatherer` link.
13231
+ * After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
13232
+ * Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
13233
+ * When the complete list of documents is received and accepted, the KYC request fulfilled webhook will be sent to subscribers.
13234
+ * If a `credit-file-proof` is successful with the dual process method, then corresponding `identity-proof` and `address-proof` documents are not requested.
13235
+ */
13236
+ PostKycRequest: {
13237
+ responses: {
13238
+ /** KYC request was created. */
13239
+ 201: {
13240
+ content: {
13241
+ "application/json": coreComponents["schemas"]["KycRequest"];
13242
+ };
13243
+ };
13244
+ 401: coreComponents["responses"]["Unauthorized"];
13245
+ 403: coreComponents["responses"]["Forbidden"];
13246
+ 422: coreComponents["responses"]["ValidationError"];
13247
+ };
13248
+ /** KYC request resource. */
13249
+ requestBody: {
13250
+ content: {
13251
+ "application/json": coreComponents["schemas"]["KycRequest"];
13252
+ };
13253
+ };
13254
+ };
13255
+ /** Retrieve a KYC request with specified identifier string. */
13256
+ GetKycRequest: {
13257
+ parameters: {
13258
+ path: {
13259
+ /** The resource identifier string. */
13260
+ id: coreComponents["parameters"]["resourceId"];
13261
+ };
13262
+ };
13263
+ responses: {
13264
+ /** KYC request was retrieved successfully. */
13265
+ 200: {
13266
+ content: {
13267
+ "application/json": coreComponents["schemas"]["KycRequest"];
13268
+ };
13269
+ };
13270
+ 401: coreComponents["responses"]["Unauthorized"];
13271
+ 403: coreComponents["responses"]["Forbidden"];
13272
+ 404: coreComponents["responses"]["NotFound"];
13273
+ };
13274
+ };
13275
+ /** Delete the KYC request with the predefined identifier string. */
13276
+ DeleteKycRequest: {
13277
+ parameters: {
13278
+ path: {
13279
+ /** The resource identifier string. */
13280
+ id: coreComponents["parameters"]["resourceId"];
13281
+ };
13282
+ };
13283
+ responses: {
13284
+ /** The KYC request was deleted. */
13285
+ 204: never;
13286
+ 401: coreComponents["responses"]["Unauthorized"];
13287
+ 404: coreComponents["responses"]["NotFound"];
13288
+ };
13289
+ };
13290
+ /** Update a KYC request. */
13291
+ PatchKycRequest: {
13292
+ parameters: {
13293
+ path: {
13294
+ /** The resource identifier string. */
13295
+ id: coreComponents["parameters"]["resourceId"];
13296
+ };
13297
+ };
13298
+ responses: {
13299
+ /** KYC request was updated. */
13300
+ 200: {
13301
+ content: {
13302
+ "application/json": coreComponents["schemas"]["KycRequest"];
13303
+ };
13304
+ };
13305
+ 401: coreComponents["responses"]["Unauthorized"];
13306
+ 403: coreComponents["responses"]["Forbidden"];
13307
+ 404: coreComponents["responses"]["NotFound"];
13308
+ 422: coreComponents["responses"]["ValidationError"];
13309
+ };
13310
+ requestBody: coreComponents["requestBodies"]["PatchKycRequest"];
13311
+ };
13142
13312
  /** Retrieve a list of KYC documents. */
13143
13313
  GetKycDocumentCollection: {
13144
13314
  parameters: {
@@ -13375,118 +13545,26 @@ export interface operations {
13375
13545
  422: coreComponents["responses"]["ValidationError"];
13376
13546
  };
13377
13547
  };
13378
- /** Retrieve a list of KYC requests. */
13379
- GetKycRequestCollection: {
13380
- parameters: {
13381
- query: {
13382
- /** The collection items limit. */
13383
- limit?: coreComponents["parameters"]["collectionLimit"];
13384
- /** The collection items offset. */
13385
- offset?: coreComponents["parameters"]["collectionOffset"];
13386
- /**
13387
- * The collection items filter requires a special format.
13388
- * Use "," for multiple allowed values. Use ";" for multiple fields.
13389
- * See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
13390
- */
13391
- filter?: coreComponents["parameters"]["collectionFilter"];
13392
- /** The collection items sort field and order (prefix with "-" for descending sort). */
13393
- sort?: coreComponents["parameters"]["collectionSort"];
13394
- };
13395
- };
13548
+ /** Update KYC settings. */
13549
+ PutKycSettings: {
13396
13550
  responses: {
13397
- /** A list of KYC requests was retrieved successfully. */
13551
+ /** KYC settings were updated. */
13398
13552
  200: {
13399
- headers: {};
13400
13553
  content: {
13401
- "application/json": coreComponents["schemas"]["KycRequest"][];
13554
+ "application/json": coreComponents["schemas"]["KycSettings"];
13402
13555
  };
13403
13556
  };
13404
13557
  401: coreComponents["responses"]["Unauthorized"];
13405
13558
  403: coreComponents["responses"]["Forbidden"];
13559
+ 404: coreComponents["responses"]["NotFound"];
13406
13560
  };
13407
- };
13408
- /**
13409
- * Create a KYC Request.
13410
- * Then, redirect the customer to the `kycGatherer` link.
13411
- * After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
13412
- * Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
13413
- */
13414
- PostKycRequest: {
13415
- responses: {
13416
- /** Kyc request was created. */
13417
- 201: {
13418
- content: {
13419
- "application/json": coreComponents["schemas"]["KycRequest"];
13420
- };
13421
- };
13422
- 401: coreComponents["responses"]["Unauthorized"];
13423
- 403: coreComponents["responses"]["Forbidden"];
13424
- 422: coreComponents["responses"]["ValidationError"];
13425
- };
13426
- /** Kyc request resource. */
13561
+ /** The settings for KYC analysis. */
13427
13562
  requestBody: {
13428
13563
  content: {
13429
- "application/json": coreComponents["schemas"]["KycRequest"];
13564
+ "application/json": coreComponents["schemas"]["KycSettings"];
13430
13565
  };
13431
13566
  };
13432
13567
  };
13433
- /** Retrieve a KYC request with specified identifier string. */
13434
- GetKycRequest: {
13435
- parameters: {
13436
- path: {
13437
- /** The resource identifier string. */
13438
- id: coreComponents["parameters"]["resourceId"];
13439
- };
13440
- };
13441
- responses: {
13442
- /** KYC request was retrieved successfully. */
13443
- 200: {
13444
- content: {
13445
- "application/json": coreComponents["schemas"]["KycRequest"];
13446
- };
13447
- };
13448
- 401: coreComponents["responses"]["Unauthorized"];
13449
- 403: coreComponents["responses"]["Forbidden"];
13450
- 404: coreComponents["responses"]["NotFound"];
13451
- };
13452
- };
13453
- /** Delete the KYC request with the predefined identifier string. */
13454
- DeleteKycRequest: {
13455
- parameters: {
13456
- path: {
13457
- /** The resource identifier string. */
13458
- id: coreComponents["parameters"]["resourceId"];
13459
- };
13460
- };
13461
- responses: {
13462
- /** The KYC request was deleted. */
13463
- 204: never;
13464
- 401: coreComponents["responses"]["Unauthorized"];
13465
- 404: coreComponents["responses"]["NotFound"];
13466
- };
13467
- };
13468
- /** Update a KYC request. */
13469
- PatchKycRequest: {
13470
- parameters: {
13471
- path: {
13472
- /** The resource identifier string. */
13473
- id: coreComponents["parameters"]["resourceId"];
13474
- };
13475
- };
13476
- responses: {
13477
- /** KYC request was updated. */
13478
- 200: {
13479
- content: {
13480
- "application/json": coreComponents["schemas"]["KycRequest"];
13481
- };
13482
- };
13483
- 401: coreComponents["responses"]["Unauthorized"];
13484
- 403: coreComponents["responses"]["Forbidden"];
13485
- 404: coreComponents["responses"]["NotFound"];
13486
- 422: coreComponents["responses"]["ValidationError"];
13487
- };
13488
- requestBody: coreComponents["requestBodies"]["PatchKycRequest"];
13489
- };
13490
13568
  /** Retrieve a list of tokens. */
13491
13569
  GetPasswordTokenCollection: {
13492
13570
  parameters: {
@@ -16561,7 +16639,7 @@ export interface usersPaths {
16561
16639
  post: operations["PostOrganization"];
16562
16640
  };
16563
16641
  "/organizations/{id}": {
16564
- /** Retrieve a organization with specified identifier string. */
16642
+ /** Retrieve an organization with specified identifier string. */
16565
16643
  get: operations["GetOrganization"];
16566
16644
  /** Update an organization. */
16567
16645
  patch: operations["PatchOrganization"];
@@ -17874,6 +17952,8 @@ export interface usersComponents {
17874
17952
  kountFraudSessionId?: string;
17875
17953
  /** MerchantSessionID as generated by the PayPal Fraudnet SDK. */
17876
17954
  payPalMerchantSessionId?: string;
17955
+ /** A temporary identifier that is unique to the visitor's session and passed to ThreatMetrix. */
17956
+ threatMetrixSessionId?: string;
17877
17957
  };
17878
17958
  /** Risk metadata used for 3DS and risk scoring. */
17879
17959
  RiskMetadata: {
@@ -18729,6 +18809,10 @@ export interface usersComponents {
18729
18809
  /** Checkout.com secret API key. */
18730
18810
  secretKey: string;
18731
18811
  };
18812
+ settings?: {
18813
+ /** Mark as waiting-gateway/unknown instead of approved on pending payout. */
18814
+ markAsWaitingGatewayOnPendingPayout: boolean;
18815
+ };
18732
18816
  threeDSecureServer?: usersComponents["schemas"]["CheckoutCom3dsServers"];
18733
18817
  };
18734
18818
  /** Circle config. */
@@ -20106,6 +20190,8 @@ export interface usersComponents {
20106
20190
  merchantCode: string;
20107
20191
  /** Redsys Gateway secret code. */
20108
20192
  secretCode: string;
20193
+ /** Redsys Gateway merchant sha256 code. Required for Bizum payments. */
20194
+ sha256SecretCode?: string;
20109
20195
  };
20110
20196
  };
20111
20197
  /** Rotessa config. */
@@ -20923,6 +21009,8 @@ export interface usersComponents {
20923
21009
  expirationReminderNumber?: number | null;
20924
21010
  /** Payment instrument reference data. */
20925
21011
  referenceData?: { [key: string]: string };
21012
+ /** Digital wallet type. */
21013
+ digitalWallet?: ("Apple Pay" | "Google Pay") | null;
20926
21014
  /** The links related to resource. */
20927
21015
  _links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
20928
21016
  Partial<usersComponents["schemas"]["CustomerLink"]> &
@@ -21559,8 +21647,8 @@ export interface usersComponents {
21559
21647
  firstName?: number;
21560
21648
  /** The weight of lastName. */
21561
21649
  lastName?: number;
21562
- /** The weight of expiryDate. */
21563
- expiryDate?: number;
21650
+ /** The weight of `expirationDate`. */
21651
+ expirationDate?: number;
21564
21652
  /** The weight of dateOfBirth. */
21565
21653
  dateOfBirth?: number;
21566
21654
  /** The weight of matchesDateOfBirth. */
@@ -21610,6 +21698,11 @@ export interface usersComponents {
21610
21698
  acceptAbove?: number;
21611
21699
  };
21612
21700
  };
21701
+ /** The settings for score calculation. */
21702
+ KycSettings: {
21703
+ identityProof?: usersComponents["schemas"]["KycSettingsIdentity"];
21704
+ addressProof?: usersComponents["schemas"]["KycSettingsAddress"];
21705
+ };
21613
21706
  OrganizationSettings: {
21614
21707
  /** The settings for tax calculation. */
21615
21708
  defaultTaxCalculator?: {
@@ -21618,11 +21711,7 @@ export interface usersComponents {
21618
21711
  /** The rate for flat tax calculation. */
21619
21712
  rate?: number | null;
21620
21713
  };
21621
- /** The settings for tax calculation. */
21622
- kyc?: {
21623
- "identity-proof"?: usersComponents["schemas"]["KycSettingsIdentity"];
21624
- "address-proof"?: usersComponents["schemas"]["KycSettingsAddress"];
21625
- };
21714
+ kyc?: usersComponents["schemas"]["KycSettings"];
21626
21715
  };
21627
21716
  Organization: {
21628
21717
  /** The organization identifier string. */
@@ -21872,6 +21961,7 @@ export interface usersComponents {
21872
21961
  | "Beeline"
21873
21962
  | "Belfius-direct-net"
21874
21963
  | "bitcoin"
21964
+ | "Bizum"
21875
21965
  | "Boleto"
21876
21966
  | "cash-deposit"
21877
21967
  | "CASHlib"
@@ -27892,7 +27982,7 @@ export interface operations {
27892
27982
  };
27893
27983
  requestBody: usersComponents["requestBodies"]["PostOrganization"];
27894
27984
  };
27895
- /** Retrieve a organization with specified identifier string. */
27985
+ /** Retrieve an organization with specified identifier string. */
27896
27986
  GetOrganization: {
27897
27987
  parameters: {
27898
27988
  path: {
@@ -29999,6 +30089,8 @@ export interface storefrontComponents {
29999
30089
  kountFraudSessionId?: string;
30000
30090
  /** MerchantSessionID as generated by the PayPal Fraudnet SDK. */
30001
30091
  payPalMerchantSessionId?: string;
30092
+ /** A temporary identifier that is unique to the visitor's session and passed to ThreatMetrix. */
30093
+ threatMetrixSessionId?: string;
30002
30094
  };
30003
30095
  /** Risk metadata used for 3DS and risk scoring. */
30004
30096
  RiskMetadata: {
@@ -30709,7 +30801,8 @@ export interface storefrontComponents {
30709
30801
  | "identity-proof"
30710
30802
  | "address-proof"
30711
30803
  | "funds-proof"
30712
- | "purchase-proof";
30804
+ | "purchase-proof"
30805
+ | "credit-file-proof";
30713
30806
  KycDocumentSubtypes:
30714
30807
  | "passport"
30715
30808
  | "id-card"
@@ -30732,6 +30825,50 @@ export interface storefrontComponents {
30732
30825
  | "ewallet-holder-details"
30733
30826
  | "ewallet-transaction-statement"
30734
30827
  | "other";
30828
+ CommonKycRequest: {
30829
+ id?: storefrontComponents["schemas"]["ResourceId"];
30830
+ /** Documents to be requested from customer. */
30831
+ documents: {
30832
+ /** Document type to be requested from customer. */
30833
+ type: storefrontComponents["schemas"]["KycDocumentTypes"];
30834
+ /** Document subtype allowed for customer. */
30835
+ subtypes?: storefrontComponents["schemas"]["KycDocumentSubtypes"][];
30836
+ /** The number of document upload attempts. `0` treated as unlimited. */
30837
+ maxAttempts: number;
30838
+ /** If `true` uploading matching face photo (selfie) is required. */
30839
+ faceProofRequired?: boolean;
30840
+ }[];
30841
+ /** Status of the request. */
30842
+ status?:
30843
+ | "abandoned"
30844
+ | "expired"
30845
+ | "pending"
30846
+ | "fulfilled"
30847
+ | "failed"
30848
+ | "incomplete"
30849
+ | "in-progress";
30850
+ /**
30851
+ * The URL to redirect the customer when an upload is completed.
30852
+ * When the customer is redirected, Rebilly will append an `info` query parameter which may have one of the following values (example: `https://example.com?info=success`):
30853
+ *
30854
+ * - **back** - The customer clicked the `back to website` link;
30855
+ * - **token_expired** - The customer's token expired;
30856
+ * - **success** - The customer uploaded docs that were successfully analyzed;
30857
+ * - **manual** - The customer uploaded docs that will require manual review because the analyzer rejected them or couldn't process them;
30858
+ * - **partial** - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
30859
+ */
30860
+ redirectUrl?: string;
30861
+ /** Expiration date-time. Default value is one hour in the future. */
30862
+ expirationTime?: string;
30863
+ /** Creation date-time. */
30864
+ createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
30865
+ /** Latest update date-time. */
30866
+ updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
30867
+ };
30868
+ KycDocumentsLink: storefrontComponents["schemas"]["Link"] & {
30869
+ /** The link type. */
30870
+ rel: "kycDocuments";
30871
+ };
30735
30872
  KycDocumentRejectionReasonTypes:
30736
30873
  | "document-unreadable"
30737
30874
  | "document-expired"
@@ -30786,6 +30923,8 @@ export interface storefrontComponents {
30786
30923
  dateOfBirth?: string;
30787
30924
  /** The expiry date found on the document, null if not found. */
30788
30925
  expiryDate?: string;
30926
+ /** The expiration date found on the document, null if not found. */
30927
+ expirationDate?: string;
30789
30928
  /** The issued date found on the document, null if not found. */
30790
30929
  issueDate?: string;
30791
30930
  /** Checks the minimal age, 21+ for USA and 18+ for all other countries. Null if dateOfBirth could not be determined. */
@@ -30827,49 +30966,29 @@ export interface storefrontComponents {
30827
30966
  /** The payment instrument related to the document, null otherwise. */
30828
30967
  paymentInstrumentId?: string;
30829
30968
  };
30830
- CommonKycRequest: {
30831
- id?: storefrontComponents["schemas"]["ResourceId"];
30832
- /** Documents to be requested from customer. */
30833
- documents: {
30834
- /** Document type to be requested from customer. */
30835
- type: storefrontComponents["schemas"]["KycDocumentTypes"];
30836
- /** Document subtype allowed for customer. */
30837
- subtypes?: storefrontComponents["schemas"]["KycDocumentSubtypes"][];
30838
- /** The number of document upload attempts. `0` treated as unlimited. */
30839
- maxAttempts: number;
30840
- /** If `true` uploading matching face photo (selfie) is required. */
30841
- faceProofRequired?: boolean;
30842
- }[];
30843
- /** Status of the request. */
30844
- status?:
30845
- | "abandoned"
30846
- | "expired"
30847
- | "pending"
30848
- | "fulfilled"
30849
- | "failed"
30850
- | "incomplete"
30851
- | "in-progress";
30852
- /**
30853
- * The URL to redirect the customer when an upload is completed.
30854
- * When the customer is redirected, Rebilly will append an `info` query parameter which may have one of the following values (example: `https://example.com?info=success`):
30855
- *
30856
- * - **back** - The customer clicked the `back to website` link;
30857
- * - **token_expired** - The customer's token expired;
30858
- * - **success** - The customer uploaded docs that were successfully analyzed;
30859
- * - **manual** - The customer uploaded docs that will require manual review because the analyzer rejected them or couldn't process them;
30860
- * - **partial** - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
30861
- */
30862
- redirectUrl?: string;
30863
- /** Expiration date-time. Default value is one hour in the future. */
30864
- expirationTime?: string;
30865
- /** Creation date-time. */
30866
- createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
30867
- /** Latest update date-time. */
30868
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
30869
- };
30870
- KycDocumentsLink: storefrontComponents["schemas"]["Link"] & {
30871
- /** The link type. */
30872
- rel: "kycDocuments";
30969
+ CreditFileMatches: {
30970
+ /** The credit bureau which is used to get credit file data. */
30971
+ creditBureau?: "equifax" | "experian" | "transunion";
30972
+ /** The credit file number on credit bureau. */
30973
+ creditFileNumber?: string;
30974
+ /** Return true if first name is matched otherwise false. */
30975
+ isFirstNameMatched?: boolean;
30976
+ /** Return true if last name is matched otherwise false. */
30977
+ isLastNameMatched?: boolean;
30978
+ /** Return true if address civic number is matched otherwise false. */
30979
+ isCivicNumberMatched?: boolean;
30980
+ /** Return true if street address is matched otherwise false. */
30981
+ isStreetMatched?: boolean;
30982
+ /** Return true if city is matched otherwise false. */
30983
+ isCityMatched?: boolean;
30984
+ /** Return true if postal code is matched otherwise false. */
30985
+ isPostalCodeMatched?: boolean;
30986
+ /** Return true if province is matched otherwise false. */
30987
+ isProvinceMatched?: boolean;
30988
+ /** Return true if date of birth is matched otherwise false. */
30989
+ isDobMatched?: boolean;
30990
+ /** Extra data from credit bureau. */
30991
+ referenceData?: { [key: string]: any };
30873
30992
  };
30874
30993
  CommonPayPalAccount: {
30875
30994
  /** The payment instrument ID. */
@@ -30916,6 +31035,7 @@ export interface storefrontComponents {
30916
31035
  | "Beeline"
30917
31036
  | "Belfius-direct-net"
30918
31037
  | "bitcoin"
31038
+ | "Bizum"
30919
31039
  | "Boleto"
30920
31040
  | "cash-deposit"
30921
31041
  | "CASHlib"
@@ -31700,11 +31820,17 @@ export interface storefrontComponents {
31700
31820
  data?: storefrontComponents["schemas"]["PurchaseMatches"];
31701
31821
  };
31702
31822
  };
31823
+ "ProofOfCreditFile-2": storefrontComponents["schemas"]["CommonKycDocument"] & {
31824
+ documentMatches?: {
31825
+ data?: storefrontComponents["schemas"]["CreditFileMatches"];
31826
+ };
31827
+ };
31703
31828
  StorefrontKycDocument:
31704
31829
  | storefrontComponents["schemas"]["ProofOfIdentity-2"]
31705
31830
  | storefrontComponents["schemas"]["ProofOfAddress-2"]
31706
31831
  | storefrontComponents["schemas"]["ProofOfFunds-2"]
31707
- | storefrontComponents["schemas"]["ProofOfPurchase-2"];
31832
+ | storefrontComponents["schemas"]["ProofOfPurchase-2"]
31833
+ | storefrontComponents["schemas"]["ProofOfCreditFile-2"];
31708
31834
  StorefrontKycRequest: storefrontComponents["schemas"]["CommonKycRequest"] & {
31709
31835
  /** The links related to resource. */
31710
31836
  _links?: (Partial<storefrontComponents["schemas"]["SelfLink"]> &
@@ -33569,6 +33695,9 @@ declare module "resources/customers-resource" {
33569
33695
  id: any;
33570
33696
  targetCustomerId: any;
33571
33697
  }): any;
33698
+ getAml({ id }: {
33699
+ id: any;
33700
+ }): rebilly.GetCustomerAmlEntryCollectionResponsePromise;
33572
33701
  getLeadSource({ id }: {
33573
33702
  id: any;
33574
33703
  }): rebilly.GetCustomerLeadSourceResponsePromise;
@@ -34133,6 +34262,15 @@ declare module "resources/kyc-requests-resource" {
34133
34262
  }): any;
34134
34263
  };
34135
34264
  }
34265
+ declare module "resources/kyc-settings-resource" {
34266
+ export default function KycSettingsResource({ apiHandler }: {
34267
+ apiHandler: any;
34268
+ }): {
34269
+ updateKycSettings({ data }: {
34270
+ data: any;
34271
+ }): rebilly.PutKycSettingsResponsePromise;
34272
+ };
34273
+ }
34136
34274
  declare module "resources/lists-resource" {
34137
34275
  export default function ListsResource({ apiHandler }: {
34138
34276
  apiHandler: any;
@@ -35169,6 +35307,9 @@ declare module "resources/api-instance" {
35169
35307
  id: any;
35170
35308
  targetCustomerId: any;
35171
35309
  }): any;
35310
+ getAml({ id }: {
35311
+ id: any;
35312
+ }): rebilly.GetCustomerAmlEntryCollectionResponsePromise;
35172
35313
  getLeadSource({ id }: {
35173
35314
  id: any;
35174
35315
  }): rebilly.GetCustomerLeadSourceResponsePromise;
@@ -35742,6 +35883,11 @@ declare module "resources/api-instance" {
35742
35883
  data: any;
35743
35884
  }): any;
35744
35885
  };
35886
+ kycSettings: {
35887
+ updateKycSettings({ data }: {
35888
+ data: any;
35889
+ }): rebilly.PutKycSettingsResponsePromise;
35890
+ };
35745
35891
  lists: {
35746
35892
  getAll({ limit, offset, filter, sort, fields, q, }?: {
35747
35893
  limit?: number;