rebilly-js-sdk 46.2.0 → 46.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/rebilly-js-sdk.d.ts +1092 -595
- package/dist/rebilly-js-sdk.js +2 -2
- package/dist/rebilly-js-sdk.node.js +3 -3
- package/package.json +1 -1
package/dist/rebilly-js-sdk.d.ts
CHANGED
|
@@ -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
|
|
387
|
-
|
|
388
|
-
type
|
|
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
|
|
|
@@ -758,6 +762,28 @@ declare module rebilly {
|
|
|
758
762
|
type PostPreviewOrderResponse = operations['PostPreviewOrder']['responses']['200']['content']['application/json']
|
|
759
763
|
type PostPreviewOrderResponsePromise = Promise<{fields: PostPreviewOrderResponse}>
|
|
760
764
|
|
|
765
|
+
type GetCustomerEddScoreRequest = { id : String }
|
|
766
|
+
|
|
767
|
+
type GetCustomerEddScoreResponse = operations['GetCustomerEddScore']['responses']['200']['content']['application/json']
|
|
768
|
+
type GetCustomerEddScoreResponsePromise = Promise<{fields: GetCustomerEddScoreResponse}>
|
|
769
|
+
type PatchCustomerEddScoreRequest = operations['PatchCustomerEddScore']['requestBody']['content']['application/json']
|
|
770
|
+
type PatchCustomerEddScoreResponse = operations['PatchCustomerEddScore']['responses']['200']['content']['application/json']
|
|
771
|
+
type PatchCustomerEddScoreResponsePromise = Promise<{fields: PatchCustomerEddScoreResponse}>
|
|
772
|
+
|
|
773
|
+
type GetEddTimelineCollectionRequest = operations['GetEddTimelineCollection']['parameters']["query"] & (operations['GetEddTimelineCollection']['parameters'] extends {path: {}} ? operations['GetEddTimelineCollection']['parameters']["path"] : {}) & { id : String }
|
|
774
|
+
|
|
775
|
+
type GetEddTimelineCollectionResponse = operations['GetEddTimelineCollection']['responses']['200']['content']['application/json'][0]
|
|
776
|
+
type GetEddTimelineCollectionResponsePromise = Promise<{ items: {fields: GetEddTimelineCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
777
|
+
type PostEddTimelineRequest = operations['PostEddTimeline']['requestBody']['content']['application/json']
|
|
778
|
+
type CreateEddTimelineRequest = { id: String, data: PostEddTimelineRequest, expand?: String }
|
|
779
|
+
type PostEddTimelineResponse = operations['PostEddTimeline']['responses']['201']['content']['application/json']
|
|
780
|
+
type PostEddTimelineResponsePromise = Promise<{fields: PostEddTimelineResponse}>
|
|
781
|
+
|
|
782
|
+
type GetEddSearchResultsRequest = { id : String }
|
|
783
|
+
|
|
784
|
+
type GetEddSearchResultsResponse = operations['GetEddSearchResults']['responses']['200']['content']['application/json']
|
|
785
|
+
type GetEddSearchResultsResponsePromise = Promise<{fields: GetEddSearchResultsResponse}>
|
|
786
|
+
|
|
761
787
|
type GetApplicationInstanceRequest = { applicationId : String }
|
|
762
788
|
|
|
763
789
|
type GetApplicationInstanceResponse = operations['GetApplicationInstance']['responses']['200']['content']['application/json']
|
|
@@ -1884,7 +1910,7 @@ export interface corePaths {
|
|
|
1884
1910
|
};
|
|
1885
1911
|
"/coupons/{id}/expiration": {
|
|
1886
1912
|
/**
|
|
1887
|
-
* Set a coupon's
|
|
1913
|
+
* Set a coupon's expiration time with the specified coupon ID.
|
|
1888
1914
|
* The expiredTime of a coupon must be greater than its issuedTime.
|
|
1889
1915
|
* This cannot be performed on expired coupons.
|
|
1890
1916
|
*/
|
|
@@ -2288,6 +2314,33 @@ export interface corePaths {
|
|
|
2288
2314
|
};
|
|
2289
2315
|
};
|
|
2290
2316
|
};
|
|
2317
|
+
"/kyc-requests": {
|
|
2318
|
+
/** Retrieve a list of KYC requests. */
|
|
2319
|
+
get: operations["GetKycRequestCollection"];
|
|
2320
|
+
/**
|
|
2321
|
+
* Create a KYC Request.
|
|
2322
|
+
* Then, redirect the customer to the `kycGatherer` link.
|
|
2323
|
+
* After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
|
|
2324
|
+
* Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
|
|
2325
|
+
* When the complete list of documents is received and accepted, the KYC request fulfilled webhook will be sent to subscribers.
|
|
2326
|
+
* If a `credit-file-proof` is successful with the dual process method, then corresponding `identity-proof` and `address-proof` documents are not requested.
|
|
2327
|
+
*/
|
|
2328
|
+
post: operations["PostKycRequest"];
|
|
2329
|
+
};
|
|
2330
|
+
"/kyc-requests/{id}": {
|
|
2331
|
+
/** Retrieve a KYC request with specified identifier string. */
|
|
2332
|
+
get: operations["GetKycRequest"];
|
|
2333
|
+
/** Delete the KYC request with the predefined identifier string. */
|
|
2334
|
+
delete: operations["DeleteKycRequest"];
|
|
2335
|
+
/** Update a KYC request. */
|
|
2336
|
+
patch: operations["PatchKycRequest"];
|
|
2337
|
+
parameters: {
|
|
2338
|
+
path: {
|
|
2339
|
+
/** The resource identifier string. */
|
|
2340
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
2341
|
+
};
|
|
2342
|
+
};
|
|
2343
|
+
};
|
|
2291
2344
|
"/kyc-documents": {
|
|
2292
2345
|
/** Retrieve a list of KYC documents. */
|
|
2293
2346
|
get: operations["GetKycDocumentCollection"];
|
|
@@ -2366,30 +2419,9 @@ export interface corePaths {
|
|
|
2366
2419
|
};
|
|
2367
2420
|
};
|
|
2368
2421
|
};
|
|
2369
|
-
"/kyc-
|
|
2370
|
-
/**
|
|
2371
|
-
|
|
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
|
-
};
|
|
2422
|
+
"/kyc-settings": {
|
|
2423
|
+
/** Update KYC settings. */
|
|
2424
|
+
put: operations["PutKycSettings"];
|
|
2393
2425
|
};
|
|
2394
2426
|
"/password-tokens": {
|
|
2395
2427
|
/** Retrieve a list of tokens. */
|
|
@@ -2965,6 +2997,40 @@ export interface corePaths {
|
|
|
2965
2997
|
/** Use order preview before making an actual order. */
|
|
2966
2998
|
post: operations["PostPreviewOrder"];
|
|
2967
2999
|
};
|
|
3000
|
+
"/customers/{id}/edd-score": {
|
|
3001
|
+
/** Retrieve a EDD score of given customer. */
|
|
3002
|
+
get: operations["GetCustomerEddScore"];
|
|
3003
|
+
/** Update customer's EDD score data. */
|
|
3004
|
+
patch: operations["PatchCustomerEddScore"];
|
|
3005
|
+
parameters: {
|
|
3006
|
+
path: {
|
|
3007
|
+
/** The resource identifier string. */
|
|
3008
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
3009
|
+
};
|
|
3010
|
+
};
|
|
3011
|
+
};
|
|
3012
|
+
"/customers/{id}/edd-timeline": {
|
|
3013
|
+
/** Retrieve a list of EDD timeline messages. */
|
|
3014
|
+
get: operations["GetEddTimelineCollection"];
|
|
3015
|
+
/** Create a EDD Timeline comment or custom defined event. */
|
|
3016
|
+
post: operations["PostEddTimeline"];
|
|
3017
|
+
parameters: {
|
|
3018
|
+
path: {
|
|
3019
|
+
/** The resource identifier string. */
|
|
3020
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
3021
|
+
};
|
|
3022
|
+
};
|
|
3023
|
+
};
|
|
3024
|
+
"/customers/{id}/edd-search-results": {
|
|
3025
|
+
/** Retrieve a EDD search results of given customer. */
|
|
3026
|
+
get: operations["GetEddSearchResults"];
|
|
3027
|
+
parameters: {
|
|
3028
|
+
path: {
|
|
3029
|
+
/** The resource identifier string. */
|
|
3030
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
3031
|
+
};
|
|
3032
|
+
};
|
|
3033
|
+
};
|
|
2968
3034
|
}
|
|
2969
3035
|
|
|
2970
3036
|
export interface coreComponents {
|
|
@@ -3080,6 +3146,8 @@ export interface coreComponents {
|
|
|
3080
3146
|
extension?: string;
|
|
3081
3147
|
/** The File description. */
|
|
3082
3148
|
description?: string;
|
|
3149
|
+
/** The File source type. */
|
|
3150
|
+
sourceType?: ("upload" | "camera") | null;
|
|
3083
3151
|
/** The tags list. */
|
|
3084
3152
|
tags?: string[];
|
|
3085
3153
|
/** The mime type. */
|
|
@@ -3120,18 +3188,20 @@ export interface coreComponents {
|
|
|
3120
3188
|
/** Linked object type. */
|
|
3121
3189
|
relatedType:
|
|
3122
3190
|
| "customer"
|
|
3191
|
+
| "customer-timeline-comment"
|
|
3192
|
+
| "customer-edd-timeline-comment"
|
|
3123
3193
|
| "dispute"
|
|
3124
3194
|
| "gateway-timeline-comment"
|
|
3125
3195
|
| "invoice"
|
|
3196
|
+
| "invoice-timeline-comment"
|
|
3197
|
+
| "order-timeline-comment"
|
|
3126
3198
|
| "organization"
|
|
3127
3199
|
| "payment"
|
|
3128
3200
|
| "plan"
|
|
3129
3201
|
| "product"
|
|
3130
3202
|
| "subscription"
|
|
3131
3203
|
| "transaction"
|
|
3132
|
-
| "
|
|
3133
|
-
| "transaction-timeline-comment"
|
|
3134
|
-
| "order-timeline-comment";
|
|
3204
|
+
| "transaction-timeline-comment";
|
|
3135
3205
|
/** Linked object Id. */
|
|
3136
3206
|
relatedId: string;
|
|
3137
3207
|
/** The Original Attachment name. */
|
|
@@ -3150,35 +3220,42 @@ export interface coreComponents {
|
|
|
3150
3220
|
_embedded?: Partial<coreComponents["schemas"]["FileEmbed"]>[];
|
|
3151
3221
|
};
|
|
3152
3222
|
/** The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)]. */
|
|
3153
|
-
|
|
3154
|
-
/** The HTTP status code. */
|
|
3155
|
-
status?: number;
|
|
3156
|
-
/** A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
|
|
3157
|
-
title?: string;
|
|
3158
|
-
} & { [key: string]: any };
|
|
3159
|
-
DocumentedProblem: {
|
|
3223
|
+
BaseProblem: {
|
|
3160
3224
|
/** A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". */
|
|
3161
3225
|
type?: string;
|
|
3162
|
-
|
|
3163
|
-
|
|
3226
|
+
/** A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
|
|
3227
|
+
title?: string;
|
|
3164
3228
|
/** A human-readable explanation specific to this occurrence of the problem. */
|
|
3165
3229
|
detail?: string;
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3230
|
+
/** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
|
|
3231
|
+
instance?: string;
|
|
3232
|
+
} & { [key: string]: any };
|
|
3233
|
+
Unauthorized: { [key: string]: any } & {
|
|
3234
|
+
/** The HTTP status code. */
|
|
3235
|
+
status?: number;
|
|
3236
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
3237
|
+
Forbidden: { [key: string]: any } & {
|
|
3238
|
+
/** The HTTP status code. */
|
|
3239
|
+
status?: number;
|
|
3240
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
3241
|
+
Conflict: { [key: string]: any } & {
|
|
3242
|
+
/** The HTTP status code. */
|
|
3243
|
+
status?: number;
|
|
3244
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
3245
|
+
ValidationError: { [key: string]: any } & {
|
|
3246
|
+
/** The HTTP status code. */
|
|
3247
|
+
status?: number;
|
|
3248
|
+
} & coreComponents["schemas"]["BaseProblem"] & {
|
|
3249
|
+
invalidFields?: {
|
|
3250
|
+
/** The field name. Dot notation is used for nested object field names. */
|
|
3251
|
+
field?: string;
|
|
3252
|
+
message?: string;
|
|
3253
|
+
}[];
|
|
3254
|
+
};
|
|
3255
|
+
NotFound: {
|
|
3256
|
+
/** The HTTP status code. */
|
|
3257
|
+
status?: number;
|
|
3258
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
3182
3259
|
AuthenticationOptions: {
|
|
3183
3260
|
/** Allowed password pattern. */
|
|
3184
3261
|
passwordPattern?: string;
|
|
@@ -3338,11 +3415,10 @@ export interface coreComponents {
|
|
|
3338
3415
|
time: string;
|
|
3339
3416
|
};
|
|
3340
3417
|
/** Quantity per Customer restrictions. */
|
|
3341
|
-
"redemptions-per-customer": coreComponents["schemas"]["CouponRestriction"] &
|
|
3342
|
-
|
|
3343
|
-
|
|
3344
|
-
|
|
3345
|
-
};
|
|
3418
|
+
"redemptions-per-customer": coreComponents["schemas"]["CouponRestriction"] & {
|
|
3419
|
+
/** Restriction value. */
|
|
3420
|
+
quantity: number;
|
|
3421
|
+
};
|
|
3346
3422
|
/** restrict-to-countries restrictions. */
|
|
3347
3423
|
"restrict-to-countries": coreComponents["schemas"]["CouponRestriction"] &
|
|
3348
3424
|
coreComponents["schemas"]["RedemptionRestriction"] & {
|
|
@@ -3378,11 +3454,10 @@ export interface coreComponents {
|
|
|
3378
3454
|
subscriptionIds: string[];
|
|
3379
3455
|
};
|
|
3380
3456
|
/** total-redemptions restrictions. */
|
|
3381
|
-
"total-redemptions": coreComponents["schemas"]["CouponRestriction"] &
|
|
3382
|
-
|
|
3383
|
-
|
|
3384
|
-
|
|
3385
|
-
};
|
|
3457
|
+
"total-redemptions": coreComponents["schemas"]["CouponRestriction"] & {
|
|
3458
|
+
/** Total redemptions quantity. */
|
|
3459
|
+
quantity: number;
|
|
3460
|
+
};
|
|
3386
3461
|
/** Coupons redemption log. */
|
|
3387
3462
|
CouponRedemption: {
|
|
3388
3463
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
@@ -3442,9 +3517,29 @@ export interface coreComponents {
|
|
|
3442
3517
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
3443
3518
|
};
|
|
3444
3519
|
CouponExpiration: {
|
|
3445
|
-
/** The coupon's
|
|
3520
|
+
/** The coupon's expiration time, must be greater than the issued time. Null or empty string will immediately expire the coupon. */
|
|
3446
3521
|
expiredTime: string;
|
|
3447
3522
|
};
|
|
3523
|
+
/** The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)]. */
|
|
3524
|
+
BlankProblem: {
|
|
3525
|
+
/** The HTTP status code. */
|
|
3526
|
+
status?: number;
|
|
3527
|
+
/** A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
|
|
3528
|
+
title?: string;
|
|
3529
|
+
} & { [key: string]: any };
|
|
3530
|
+
DocumentedProblem: {
|
|
3531
|
+
/** A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". */
|
|
3532
|
+
type?: string;
|
|
3533
|
+
} & coreComponents["schemas"]["BlankProblem"];
|
|
3534
|
+
DetailedProblem: coreComponents["schemas"]["BlankProblem"] & {
|
|
3535
|
+
/** A human-readable explanation specific to this occurrence of the problem. */
|
|
3536
|
+
detail?: string;
|
|
3537
|
+
};
|
|
3538
|
+
Problem: coreComponents["schemas"]["DocumentedProblem"] &
|
|
3539
|
+
coreComponents["schemas"]["DetailedProblem"];
|
|
3540
|
+
Error: coreComponents["schemas"]["Problem"] & {
|
|
3541
|
+
error?: string;
|
|
3542
|
+
};
|
|
3448
3543
|
Credential: {
|
|
3449
3544
|
/** The credential identifier string. */
|
|
3450
3545
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
@@ -3858,6 +3953,8 @@ export interface coreComponents {
|
|
|
3858
3953
|
* The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
|
|
3859
3954
|
*/
|
|
3860
3955
|
revision?: number;
|
|
3956
|
+
/** Indicates if EDD is enabled for this customer. */
|
|
3957
|
+
isEddRequired: boolean;
|
|
3861
3958
|
/** The links related to resource. */
|
|
3862
3959
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
3863
3960
|
Partial<coreComponents["schemas"]["DefaultPaymentInstrumentLink"]> &
|
|
@@ -3879,7 +3976,11 @@ export interface coreComponents {
|
|
|
3879
3976
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
3880
3977
|
};
|
|
3881
3978
|
TimelineAction: {
|
|
3882
|
-
action?:
|
|
3979
|
+
action?:
|
|
3980
|
+
| "resend-email"
|
|
3981
|
+
| "redemption-cancel"
|
|
3982
|
+
| "ruleset-restore"
|
|
3983
|
+
| "show-edd-search-logs";
|
|
3883
3984
|
};
|
|
3884
3985
|
/** Cancel Redemption. */
|
|
3885
3986
|
"redemption-cancel": coreComponents["schemas"]["TimelineAction"] & {
|
|
@@ -3894,6 +3995,11 @@ export interface coreComponents {
|
|
|
3894
3995
|
/** Rulset version to restore. */
|
|
3895
3996
|
version?: number;
|
|
3896
3997
|
};
|
|
3998
|
+
/** Show EDD search logs action. */
|
|
3999
|
+
"show-edd-search-logs": coreComponents["schemas"]["TimelineAction"] & {
|
|
4000
|
+
searchLogId?: coreComponents["schemas"]["ResourceId"];
|
|
4001
|
+
type?: "arrest" | "bankruptcy" | "fraud" | "occupation";
|
|
4002
|
+
};
|
|
3897
4003
|
/** Additional information about Timeline message. */
|
|
3898
4004
|
TimelineTable: {
|
|
3899
4005
|
type?: "list" | "one-columns" | "two-columns" | "three-columns";
|
|
@@ -3997,6 +4103,7 @@ export interface coreComponents {
|
|
|
3997
4103
|
| "kyc-document-modified"
|
|
3998
4104
|
| "kyc-document-rejected"
|
|
3999
4105
|
| "kyc-document-reviewed"
|
|
4106
|
+
| "kyc-request-fulfilled"
|
|
4000
4107
|
| "lead-source-changed"
|
|
4001
4108
|
| "order-activated"
|
|
4002
4109
|
| "order-canceled"
|
|
@@ -4071,6 +4178,7 @@ export interface coreComponents {
|
|
|
4071
4178
|
/** The payment gateway name. */
|
|
4072
4179
|
GatewayName:
|
|
4073
4180
|
| "A1Gateway"
|
|
4181
|
+
| "ACI"
|
|
4074
4182
|
| "Adyen"
|
|
4075
4183
|
| "Airpay"
|
|
4076
4184
|
| "AmazonPay"
|
|
@@ -4121,6 +4229,7 @@ export interface coreComponents {
|
|
|
4121
4229
|
| "EPro"
|
|
4122
4230
|
| "eZeeWallet"
|
|
4123
4231
|
| "ezyEFT"
|
|
4232
|
+
| "FasterPay"
|
|
4124
4233
|
| "Finrax"
|
|
4125
4234
|
| "Flexepin"
|
|
4126
4235
|
| "FinTecSystems"
|
|
@@ -4219,7 +4328,6 @@ export interface coreComponents {
|
|
|
4219
4328
|
| "TestProcessor"
|
|
4220
4329
|
| "ToditoCash"
|
|
4221
4330
|
| "Truevo"
|
|
4222
|
-
| "TrustPay"
|
|
4223
4331
|
| "TrustsPay"
|
|
4224
4332
|
| "Trustly"
|
|
4225
4333
|
| "TWINT"
|
|
@@ -4331,6 +4439,7 @@ export interface coreComponents {
|
|
|
4331
4439
|
/** The acquirer name. */
|
|
4332
4440
|
AcquirerName:
|
|
4333
4441
|
| "Adyen"
|
|
4442
|
+
| "ACI"
|
|
4334
4443
|
| "Alipay"
|
|
4335
4444
|
| "AIB"
|
|
4336
4445
|
| "Airpay"
|
|
@@ -4547,6 +4656,8 @@ export interface coreComponents {
|
|
|
4547
4656
|
kountFraudSessionId?: string;
|
|
4548
4657
|
/** MerchantSessionID as generated by the PayPal Fraudnet SDK. */
|
|
4549
4658
|
payPalMerchantSessionId?: string;
|
|
4659
|
+
/** A temporary identifier that is unique to the visitor's session and passed to ThreatMetrix. */
|
|
4660
|
+
threatMetrixSessionId?: string;
|
|
4550
4661
|
};
|
|
4551
4662
|
/** Risk metadata used for 3DS and risk scoring. */
|
|
4552
4663
|
RiskMetadata: {
|
|
@@ -5048,6 +5159,28 @@ export interface coreComponents {
|
|
|
5048
5159
|
};
|
|
5049
5160
|
threeDSecureServer?: coreComponents["schemas"]["A1Gateway3dsServers"];
|
|
5050
5161
|
};
|
|
5162
|
+
/** ACI 3DS Servers. */
|
|
5163
|
+
ACI3dsServers: {
|
|
5164
|
+
name: "ThreeDSecureIO3dsServer";
|
|
5165
|
+
};
|
|
5166
|
+
/** ACI config. */
|
|
5167
|
+
ACI: coreComponents["schemas"]["GatewayAccount"] & {
|
|
5168
|
+
/** ACI credentials object. */
|
|
5169
|
+
credentials: {
|
|
5170
|
+
entityId: string;
|
|
5171
|
+
accessToken: string;
|
|
5172
|
+
};
|
|
5173
|
+
/** ACI settings object. */
|
|
5174
|
+
settings?: {
|
|
5175
|
+
/** ACI custom server URL. */
|
|
5176
|
+
url?: string;
|
|
5177
|
+
};
|
|
5178
|
+
threeDSecureServer?: coreComponents["schemas"]["ACI3dsServers"];
|
|
5179
|
+
};
|
|
5180
|
+
/** Adyen 3DS Servers. */
|
|
5181
|
+
Adyen3dsServers: {
|
|
5182
|
+
name: "ThreeDSecureIO3dsServer";
|
|
5183
|
+
};
|
|
5051
5184
|
/** Adyen config. */
|
|
5052
5185
|
Adyen: coreComponents["schemas"]["GatewayAccount"] & {
|
|
5053
5186
|
/** Adyen credentials object. */
|
|
@@ -5062,6 +5195,7 @@ export interface coreComponents {
|
|
|
5062
5195
|
/** Adyen post URL. */
|
|
5063
5196
|
url: string;
|
|
5064
5197
|
};
|
|
5198
|
+
threeDSecureServer?: coreComponents["schemas"]["Adyen3dsServers"];
|
|
5065
5199
|
};
|
|
5066
5200
|
/** Airpay config. */
|
|
5067
5201
|
Airpay: coreComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -5379,6 +5513,10 @@ export interface coreComponents {
|
|
|
5379
5513
|
/** Checkout.com secret API key. */
|
|
5380
5514
|
secretKey: string;
|
|
5381
5515
|
};
|
|
5516
|
+
settings?: {
|
|
5517
|
+
/** Mark as waiting-gateway/unknown instead of approved on pending payout. */
|
|
5518
|
+
markAsWaitingGatewayOnPendingPayout: boolean;
|
|
5519
|
+
};
|
|
5382
5520
|
threeDSecureServer?: coreComponents["schemas"]["CheckoutCom3dsServers"];
|
|
5383
5521
|
};
|
|
5384
5522
|
/** Circle config. */
|
|
@@ -6324,6 +6462,11 @@ export interface coreComponents {
|
|
|
6324
6462
|
credentials: {
|
|
6325
6463
|
apiKey: string;
|
|
6326
6464
|
};
|
|
6465
|
+
/** OnRamp settings object. */
|
|
6466
|
+
settings?: {
|
|
6467
|
+
/** Use OnRamp server to server API. */
|
|
6468
|
+
useServerToServerApi: boolean;
|
|
6469
|
+
};
|
|
6327
6470
|
};
|
|
6328
6471
|
/** Pagsmile Gateway config. */
|
|
6329
6472
|
Pagsmile: coreComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -6756,6 +6899,8 @@ export interface coreComponents {
|
|
|
6756
6899
|
merchantCode: string;
|
|
6757
6900
|
/** Redsys Gateway secret code. */
|
|
6758
6901
|
secretCode: string;
|
|
6902
|
+
/** Redsys Gateway merchant sha256 code. Required for Bizum payments. */
|
|
6903
|
+
sha256SecretCode?: string;
|
|
6759
6904
|
};
|
|
6760
6905
|
};
|
|
6761
6906
|
/** Rotessa config. */
|
|
@@ -7117,19 +7262,6 @@ export interface coreComponents {
|
|
|
7117
7262
|
};
|
|
7118
7263
|
threeDSecureServer?: coreComponents["schemas"]["Truevo3dsServers"];
|
|
7119
7264
|
};
|
|
7120
|
-
/** TrustPay 3DS Servers. */
|
|
7121
|
-
TrustPay3dsServers: {
|
|
7122
|
-
name: "ThreeDSecureIO3dsServer";
|
|
7123
|
-
};
|
|
7124
|
-
/** TrustPay config. */
|
|
7125
|
-
TrustPay: coreComponents["schemas"]["GatewayAccount"] & {
|
|
7126
|
-
/** TrustPay credentials object. */
|
|
7127
|
-
credentials: {
|
|
7128
|
-
entityId: string;
|
|
7129
|
-
accessToken: string;
|
|
7130
|
-
};
|
|
7131
|
-
threeDSecureServer?: coreComponents["schemas"]["TrustPay3dsServers"];
|
|
7132
|
-
};
|
|
7133
7265
|
/** TrustsPay config. */
|
|
7134
7266
|
TrustsPay: coreComponents["schemas"]["GatewayAccount"] & {
|
|
7135
7267
|
/** TrustsPay credentials object. */
|
|
@@ -7560,6 +7692,8 @@ export interface coreComponents {
|
|
|
7560
7692
|
billingAddress?: coreComponents["schemas"]["ContactObject"];
|
|
7561
7693
|
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
7562
7694
|
useAsBackup: boolean;
|
|
7695
|
+
/** URL to the billing portal where the card can be updated. */
|
|
7696
|
+
billingPortalUrl?: string;
|
|
7563
7697
|
/** Payment instrument created time. */
|
|
7564
7698
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
7565
7699
|
/** Payment instrument updated time. */
|
|
@@ -7584,6 +7718,8 @@ export interface coreComponents {
|
|
|
7584
7718
|
expirationReminderNumber?: number | null;
|
|
7585
7719
|
/** Payment instrument reference data. */
|
|
7586
7720
|
referenceData?: { [key: string]: string };
|
|
7721
|
+
/** Digital wallet type. */
|
|
7722
|
+
digitalWallet?: ("Apple Pay" | "Google Pay") | null;
|
|
7587
7723
|
/** The links related to resource. */
|
|
7588
7724
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
7589
7725
|
Partial<coreComponents["schemas"]["CustomerLink"]> &
|
|
@@ -8220,8 +8356,8 @@ export interface coreComponents {
|
|
|
8220
8356
|
firstName?: number;
|
|
8221
8357
|
/** The weight of lastName. */
|
|
8222
8358
|
lastName?: number;
|
|
8223
|
-
/** The weight of
|
|
8224
|
-
|
|
8359
|
+
/** The weight of `expirationDate`. */
|
|
8360
|
+
expirationDate?: number;
|
|
8225
8361
|
/** The weight of dateOfBirth. */
|
|
8226
8362
|
dateOfBirth?: number;
|
|
8227
8363
|
/** The weight of matchesDateOfBirth. */
|
|
@@ -8271,6 +8407,11 @@ export interface coreComponents {
|
|
|
8271
8407
|
acceptAbove?: number;
|
|
8272
8408
|
};
|
|
8273
8409
|
};
|
|
8410
|
+
/** The settings for score calculation. */
|
|
8411
|
+
KycSettings: {
|
|
8412
|
+
identityProof?: coreComponents["schemas"]["KycSettingsIdentity"];
|
|
8413
|
+
addressProof?: coreComponents["schemas"]["KycSettingsAddress"];
|
|
8414
|
+
};
|
|
8274
8415
|
OrganizationSettings: {
|
|
8275
8416
|
/** The settings for tax calculation. */
|
|
8276
8417
|
defaultTaxCalculator?: {
|
|
@@ -8279,11 +8420,7 @@ export interface coreComponents {
|
|
|
8279
8420
|
/** The rate for flat tax calculation. */
|
|
8280
8421
|
rate?: number | null;
|
|
8281
8422
|
};
|
|
8282
|
-
|
|
8283
|
-
kyc?: {
|
|
8284
|
-
"identity-proof"?: coreComponents["schemas"]["KycSettingsIdentity"];
|
|
8285
|
-
"address-proof"?: coreComponents["schemas"]["KycSettingsAddress"];
|
|
8286
|
-
};
|
|
8423
|
+
kyc?: coreComponents["schemas"]["KycSettings"];
|
|
8287
8424
|
};
|
|
8288
8425
|
Organization: {
|
|
8289
8426
|
/** The organization identifier string. */
|
|
@@ -8651,6 +8788,8 @@ export interface coreComponents {
|
|
|
8651
8788
|
name?: string;
|
|
8652
8789
|
/** The file description. */
|
|
8653
8790
|
description?: string;
|
|
8791
|
+
/** The File source type. */
|
|
8792
|
+
sourceType?: ("upload" | "camera") | null;
|
|
8654
8793
|
/** The tags list. */
|
|
8655
8794
|
tags?: string[];
|
|
8656
8795
|
};
|
|
@@ -8663,6 +8802,8 @@ export interface coreComponents {
|
|
|
8663
8802
|
name?: string;
|
|
8664
8803
|
/** The file description. */
|
|
8665
8804
|
description?: string;
|
|
8805
|
+
/** The File source type. */
|
|
8806
|
+
sourceType?: ("upload" | "camera") | null;
|
|
8666
8807
|
/** The tags list. */
|
|
8667
8808
|
tags?: string[];
|
|
8668
8809
|
};
|
|
@@ -8744,7 +8885,8 @@ export interface coreComponents {
|
|
|
8744
8885
|
| "identity-proof"
|
|
8745
8886
|
| "address-proof"
|
|
8746
8887
|
| "funds-proof"
|
|
8747
|
-
| "purchase-proof"
|
|
8888
|
+
| "purchase-proof"
|
|
8889
|
+
| "credit-file-proof";
|
|
8748
8890
|
KycDocumentSubtypes:
|
|
8749
8891
|
| "passport"
|
|
8750
8892
|
| "id-card"
|
|
@@ -8767,13 +8909,65 @@ export interface coreComponents {
|
|
|
8767
8909
|
| "ewallet-holder-details"
|
|
8768
8910
|
| "ewallet-transaction-statement"
|
|
8769
8911
|
| "other";
|
|
8912
|
+
CommonKycRequest: {
|
|
8913
|
+
id?: coreComponents["schemas"]["ResourceId"];
|
|
8914
|
+
/** Documents to be requested from customer. */
|
|
8915
|
+
documents: {
|
|
8916
|
+
/** Document type to be requested from customer. */
|
|
8917
|
+
type: coreComponents["schemas"]["KycDocumentTypes"];
|
|
8918
|
+
/** Document subtype allowed for customer. */
|
|
8919
|
+
subtypes?: coreComponents["schemas"]["KycDocumentSubtypes"][];
|
|
8920
|
+
/** The number of document upload attempts. `0` treated as unlimited. */
|
|
8921
|
+
maxAttempts: number;
|
|
8922
|
+
/** If `true` uploading matching face photo (selfie) is required. */
|
|
8923
|
+
faceProofRequired?: boolean;
|
|
8924
|
+
}[];
|
|
8925
|
+
/** Status of the request. */
|
|
8926
|
+
status?:
|
|
8927
|
+
| "gathering"
|
|
8928
|
+
| "attempted"
|
|
8929
|
+
| "partial"
|
|
8930
|
+
| "pending-review"
|
|
8931
|
+
| "fulfilled"
|
|
8932
|
+
| "failed"
|
|
8933
|
+
| "abandoned"
|
|
8934
|
+
| "expired";
|
|
8935
|
+
/**
|
|
8936
|
+
* The URL to redirect the customer when an upload is completed.
|
|
8937
|
+
* 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`):
|
|
8938
|
+
*
|
|
8939
|
+
* - **back** - The customer clicked the `back to website` link;
|
|
8940
|
+
* - **token_expired** - The customer's token expired;
|
|
8941
|
+
* - **success** - The customer uploaded docs that were successfully analyzed;
|
|
8942
|
+
* - **manual** - The customer uploaded docs that will require manual review because the analyzer rejected them or couldn't process them;
|
|
8943
|
+
* - **partial** - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
|
|
8944
|
+
*/
|
|
8945
|
+
redirectUrl?: string;
|
|
8946
|
+
/** Expiration date-time. Default value is one hour in the future. */
|
|
8947
|
+
expirationTime?: string;
|
|
8948
|
+
/** Creation date-time. */
|
|
8949
|
+
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8950
|
+
/** Latest update date-time. */
|
|
8951
|
+
updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8952
|
+
};
|
|
8953
|
+
KycDocumentsLink: coreComponents["schemas"]["Link"] & {
|
|
8954
|
+
/** The link type. */
|
|
8955
|
+
rel: "kycDocuments";
|
|
8956
|
+
};
|
|
8957
|
+
KycGathererLink: {
|
|
8958
|
+
/** The link type. */
|
|
8959
|
+
rel: "kycGatherer";
|
|
8960
|
+
/** The KYC gatherer URL to redirect the customer to complete the KYC process. */
|
|
8961
|
+
href: string;
|
|
8962
|
+
};
|
|
8963
|
+
KycDocumentRejectionReasonTypes:
|
|
8964
|
+
| "document-unreadable"
|
|
8965
|
+
| "document-expired"
|
|
8966
|
+
| "document-not-matching"
|
|
8967
|
+
| "underage-person"
|
|
8968
|
+
| "other";
|
|
8770
8969
|
KycDocumentRejection: {
|
|
8771
|
-
type?:
|
|
8772
|
-
| "document-unreadable"
|
|
8773
|
-
| "document-expired"
|
|
8774
|
-
| "document-not-matching"
|
|
8775
|
-
| "underage-person"
|
|
8776
|
-
| "other";
|
|
8970
|
+
type?: coreComponents["schemas"]["KycDocumentRejectionReasonTypes"];
|
|
8777
8971
|
/** The rejection message. */
|
|
8778
8972
|
message?: string;
|
|
8779
8973
|
};
|
|
@@ -8792,7 +8986,7 @@ export interface coreComponents {
|
|
|
8792
8986
|
/** Document subtype submitted for validation. */
|
|
8793
8987
|
documentSubtype?: coreComponents["schemas"]["KycDocumentSubtypes"];
|
|
8794
8988
|
/** Status of the validation. */
|
|
8795
|
-
status: "pending" | "in-progress" | "accepted" | "rejected";
|
|
8989
|
+
status: "pending" | "in-progress" | "accepted" | "rejected" | "archived";
|
|
8796
8990
|
rejectionReason?: coreComponents["schemas"]["KycDocumentRejection"];
|
|
8797
8991
|
/** KYC request identifier string. */
|
|
8798
8992
|
requestId?: coreComponents["schemas"]["ResourceId"] | null;
|
|
@@ -8813,9 +9007,9 @@ export interface coreComponents {
|
|
|
8813
9007
|
/** Reviewer's first and last name. */
|
|
8814
9008
|
reviewerName?: string | null;
|
|
8815
9009
|
/** Date and time that manual review starts. */
|
|
8816
|
-
reviewStartTime?:
|
|
9010
|
+
reviewStartTime?: string | null;
|
|
8817
9011
|
/** Date and time of manual review. */
|
|
8818
|
-
reviewTime?:
|
|
9012
|
+
reviewTime?: string | null;
|
|
8819
9013
|
/** Reviewer notes. */
|
|
8820
9014
|
notes?: string | null;
|
|
8821
9015
|
/** A list of kyc document tags. */
|
|
@@ -8827,6 +9021,25 @@ export interface coreComponents {
|
|
|
8827
9021
|
/** The settings used to score the document. */
|
|
8828
9022
|
settings?: { [key: string]: any } | null;
|
|
8829
9023
|
};
|
|
9024
|
+
KycRequest: coreComponents["schemas"]["CommonKycRequest"] & {
|
|
9025
|
+
/** The customer ID. */
|
|
9026
|
+
customerId: coreComponents["schemas"]["ResourceId"];
|
|
9027
|
+
/** Reason for uploading. */
|
|
9028
|
+
reason?: string;
|
|
9029
|
+
/**
|
|
9030
|
+
* The level of strictness for the document matches.
|
|
9031
|
+
* The value of `1` is less strict and `2` is strict.
|
|
9032
|
+
*/
|
|
9033
|
+
matchLevel: number;
|
|
9034
|
+
/** The links related to the resource. */
|
|
9035
|
+
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9036
|
+
Partial<coreComponents["schemas"]["KycDocumentsLink"]> &
|
|
9037
|
+
Partial<coreComponents["schemas"]["KycGathererLink"]>)[];
|
|
9038
|
+
/** Any embedded objects available that are requested by the `expand` querystring parameter. */
|
|
9039
|
+
_embedded?: {
|
|
9040
|
+
documents?: coreComponents["schemas"]["KycDocument"][];
|
|
9041
|
+
};
|
|
9042
|
+
};
|
|
8830
9043
|
IdentityMatches: {
|
|
8831
9044
|
/** Flag that indicates if there is an image that contains a face on it. */
|
|
8832
9045
|
containsImage?: boolean;
|
|
@@ -8842,6 +9055,8 @@ export interface coreComponents {
|
|
|
8842
9055
|
dateOfBirth?: string;
|
|
8843
9056
|
/** The expiry date found on the document, null if not found. */
|
|
8844
9057
|
expiryDate?: string;
|
|
9058
|
+
/** The expiration date found on the document, null if not found. */
|
|
9059
|
+
expirationDate?: string;
|
|
8845
9060
|
/** The issued date found on the document, null if not found. */
|
|
8846
9061
|
issueDate?: string;
|
|
8847
9062
|
/** Checks the minimal age, 21+ for USA and 18+ for all other countries. Null if dateOfBirth could not be determined. */
|
|
@@ -8935,73 +9150,44 @@ export interface coreComponents {
|
|
|
8935
9150
|
Partial<coreComponents["schemas"]["CustomerLink"]> &
|
|
8936
9151
|
Partial<coreComponents["schemas"]["PaymentInstrumentLink"]>)[];
|
|
8937
9152
|
};
|
|
9153
|
+
CreditFileMatches: {
|
|
9154
|
+
/** The credit bureau which is used to get credit file data. */
|
|
9155
|
+
creditBureau?: "equifax" | "experian" | "transunion";
|
|
9156
|
+
/** The credit file number on credit bureau. */
|
|
9157
|
+
creditFileNumber?: string;
|
|
9158
|
+
/** Return true if first name is matched otherwise false. */
|
|
9159
|
+
isFirstNameMatched?: boolean;
|
|
9160
|
+
/** Return true if last name is matched otherwise false. */
|
|
9161
|
+
isLastNameMatched?: boolean;
|
|
9162
|
+
/** Return true if address civic number is matched otherwise false. */
|
|
9163
|
+
isCivicNumberMatched?: boolean;
|
|
9164
|
+
/** Return true if street address is matched otherwise false. */
|
|
9165
|
+
isStreetMatched?: boolean;
|
|
9166
|
+
/** Return true if city is matched otherwise false. */
|
|
9167
|
+
isCityMatched?: boolean;
|
|
9168
|
+
/** Return true if postal code is matched otherwise false. */
|
|
9169
|
+
isPostalCodeMatched?: boolean;
|
|
9170
|
+
/** Return true if province is matched otherwise false. */
|
|
9171
|
+
isProvinceMatched?: boolean;
|
|
9172
|
+
/** Return true if date of birth is matched otherwise false. */
|
|
9173
|
+
isDobMatched?: boolean;
|
|
9174
|
+
/** Extra data from credit bureau. */
|
|
9175
|
+
referenceData?: { [key: string]: any };
|
|
9176
|
+
};
|
|
9177
|
+
ProofOfCreditFile: coreComponents["schemas"]["KycDocument"] & {
|
|
9178
|
+
documentMatches?: {
|
|
9179
|
+
data?: coreComponents["schemas"]["CreditFileMatches"];
|
|
9180
|
+
};
|
|
9181
|
+
/** The links related to resource. */
|
|
9182
|
+
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9183
|
+
Partial<coreComponents["schemas"]["CustomerLink"]>)[];
|
|
9184
|
+
};
|
|
8938
9185
|
"KycDocument-2":
|
|
8939
9186
|
| coreComponents["schemas"]["ProofOfIdentity"]
|
|
8940
9187
|
| coreComponents["schemas"]["ProofOfAddress"]
|
|
8941
9188
|
| coreComponents["schemas"]["ProofOfFunds"]
|
|
8942
|
-
| coreComponents["schemas"]["ProofOfPurchase"]
|
|
8943
|
-
|
|
8944
|
-
id?: coreComponents["schemas"]["ResourceId"];
|
|
8945
|
-
/** Documents to be requested from customer. */
|
|
8946
|
-
documents: {
|
|
8947
|
-
/** Document type to be requested from customer. */
|
|
8948
|
-
type: coreComponents["schemas"]["KycDocumentTypes"];
|
|
8949
|
-
/** Document subtype allowed for customer. */
|
|
8950
|
-
subtypes?: coreComponents["schemas"]["KycDocumentSubtypes"][];
|
|
8951
|
-
/** The number of document upload attempts. `0` treated as unlimited. */
|
|
8952
|
-
maxAttempts: number;
|
|
8953
|
-
/** If `true` uploading matching face photo (selfie) is required. */
|
|
8954
|
-
faceProofRequired?: boolean;
|
|
8955
|
-
}[];
|
|
8956
|
-
/** Status of the request. */
|
|
8957
|
-
status?: "unfulfilled" | "pending" | "rejected" | "fulfilled" | "expired";
|
|
8958
|
-
/**
|
|
8959
|
-
* The URL to redirect the customer when an upload is completed.
|
|
8960
|
-
* 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`):
|
|
8961
|
-
*
|
|
8962
|
-
* - **back** - The customer clicked the `back to website` link;
|
|
8963
|
-
* - **token_expired** - The customer's token expired;
|
|
8964
|
-
* - **success** - The customer uploaded docs that were successfully analyzed;
|
|
8965
|
-
* - **manual** - The customer uploaded docs that will require manual review because the analyzer rejected them or couldn't process them;
|
|
8966
|
-
* - **partial** - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
|
|
8967
|
-
*/
|
|
8968
|
-
redirectUrl?: string;
|
|
8969
|
-
/** Expiration date-time. Default value is one hour in the future. */
|
|
8970
|
-
expirationTime?: string;
|
|
8971
|
-
/** Creation date-time. */
|
|
8972
|
-
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8973
|
-
/** Latest update date-time. */
|
|
8974
|
-
updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8975
|
-
};
|
|
8976
|
-
KycDocumentsLink: coreComponents["schemas"]["Link"] & {
|
|
8977
|
-
/** The link type. */
|
|
8978
|
-
rel: "kycDocuments";
|
|
8979
|
-
};
|
|
8980
|
-
KycGathererLink: {
|
|
8981
|
-
/** The link type. */
|
|
8982
|
-
rel: "kycGatherer";
|
|
8983
|
-
/** The KYC gatherer URL to redirect the customer to complete the KYC process. */
|
|
8984
|
-
href: string;
|
|
8985
|
-
};
|
|
8986
|
-
KycRequest: coreComponents["schemas"]["CommonKycRequest"] & {
|
|
8987
|
-
/** The customer ID. */
|
|
8988
|
-
customerId: coreComponents["schemas"]["ResourceId"];
|
|
8989
|
-
/** Reason for uploading. */
|
|
8990
|
-
reason?: string;
|
|
8991
|
-
/**
|
|
8992
|
-
* The level of strictness for the document matches.
|
|
8993
|
-
* The value of `1` is less strict and `2` is strict.
|
|
8994
|
-
*/
|
|
8995
|
-
matchLevel: number;
|
|
8996
|
-
/** The links related to the resource. */
|
|
8997
|
-
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
8998
|
-
Partial<coreComponents["schemas"]["KycDocumentsLink"]> &
|
|
8999
|
-
Partial<coreComponents["schemas"]["KycGathererLink"]>)[];
|
|
9000
|
-
/** Any embedded objects available that are requested by the `expand` querystring parameter. */
|
|
9001
|
-
_embedded?: {
|
|
9002
|
-
documents?: coreComponents["schemas"]["KycDocument"][];
|
|
9003
|
-
};
|
|
9004
|
-
};
|
|
9189
|
+
| coreComponents["schemas"]["ProofOfPurchase"]
|
|
9190
|
+
| coreComponents["schemas"]["ProofOfCreditFile"];
|
|
9005
9191
|
ResetPasswordToken: {
|
|
9006
9192
|
/** The token's identifier string. */
|
|
9007
9193
|
token?: string;
|
|
@@ -9102,6 +9288,7 @@ export interface coreComponents {
|
|
|
9102
9288
|
| "Beeline"
|
|
9103
9289
|
| "Belfius-direct-net"
|
|
9104
9290
|
| "bitcoin"
|
|
9291
|
+
| "Bizum"
|
|
9105
9292
|
| "Boleto"
|
|
9106
9293
|
| "cash-deposit"
|
|
9107
9294
|
| "CASHlib"
|
|
@@ -9119,6 +9306,7 @@ export interface coreComponents {
|
|
|
9119
9306
|
| "EPS"
|
|
9120
9307
|
| "ePay.bg"
|
|
9121
9308
|
| "eZeeWallet"
|
|
9309
|
+
| "FasterPay"
|
|
9122
9310
|
| "Flexepin"
|
|
9123
9311
|
| "Giropay"
|
|
9124
9312
|
| "Gpaysafe"
|
|
@@ -10336,7 +10524,10 @@ export interface coreComponents {
|
|
|
10336
10524
|
/** The amount applied, in case the calculated fee is less than the required minimum. */
|
|
10337
10525
|
minAmount?: number;
|
|
10338
10526
|
};
|
|
10339
|
-
FeeFormula:
|
|
10527
|
+
FeeFormula: (
|
|
10528
|
+
| coreComponents["schemas"]["FixedFeeFormula"]
|
|
10529
|
+
| coreComponents["schemas"]["PercentageFormula"]
|
|
10530
|
+
) & {
|
|
10340
10531
|
type: "fixed-fee" | "percentage";
|
|
10341
10532
|
};
|
|
10342
10533
|
BaseFee: {
|
|
@@ -10464,6 +10655,7 @@ export interface coreComponents {
|
|
|
10464
10655
|
| "kyc-document-modified"
|
|
10465
10656
|
| "kyc-document-rejected"
|
|
10466
10657
|
| "kyc-document-reviewed"
|
|
10658
|
+
| "kyc-request-fulfilled"
|
|
10467
10659
|
| "lead-source-changed"
|
|
10468
10660
|
| "nsf-response-received"
|
|
10469
10661
|
| "offsite-payment-completed"
|
|
@@ -10498,10 +10690,87 @@ export interface coreComponents {
|
|
|
10498
10690
|
| "transaction-reconciled"
|
|
10499
10691
|
| "transaction-timeout-resolved"
|
|
10500
10692
|
| "waiting-gateway-transaction-completed";
|
|
10693
|
+
EddScore: "not-found" | "unlikely" | "unclear" | "probable" | "confirmed";
|
|
10694
|
+
EddData: {
|
|
10695
|
+
occupation?: coreComponents["schemas"]["EddScore"];
|
|
10696
|
+
arrest?: coreComponents["schemas"]["EddScore"];
|
|
10697
|
+
bankruptcy?: coreComponents["schemas"]["EddScore"];
|
|
10698
|
+
fraud?: coreComponents["schemas"]["EddScore"];
|
|
10699
|
+
};
|
|
10700
|
+
EddScoreDetails: {
|
|
10701
|
+
/** The url where score is taken from. */
|
|
10702
|
+
url?: string;
|
|
10703
|
+
/** The text where score is taken from. */
|
|
10704
|
+
details?: string;
|
|
10705
|
+
};
|
|
10706
|
+
EddOccupationSearchResultLink: coreComponents["schemas"]["Link"] & {
|
|
10707
|
+
/** The link type. */
|
|
10708
|
+
rel: "eddOccupationSearchResult";
|
|
10709
|
+
};
|
|
10710
|
+
EddFraudSearchResultLink: coreComponents["schemas"]["Link"] & {
|
|
10711
|
+
/** The link type. */
|
|
10712
|
+
rel: "eddFraudSearchResult";
|
|
10713
|
+
};
|
|
10714
|
+
EddArrestSearchResultLink: coreComponents["schemas"]["Link"] & {
|
|
10715
|
+
/** The link type. */
|
|
10716
|
+
rel: "eddArrestSearchResult";
|
|
10717
|
+
};
|
|
10718
|
+
EddBankruptcySearchResultLink: coreComponents["schemas"]["Link"] & {
|
|
10719
|
+
/** The link type. */
|
|
10720
|
+
rel: "eddBankruptcySearchResult";
|
|
10721
|
+
};
|
|
10722
|
+
Edd: {
|
|
10723
|
+
parsedScore?: coreComponents["schemas"]["EddData"] & {
|
|
10724
|
+
occupationDetails?: coreComponents["schemas"]["EddScoreDetails"];
|
|
10725
|
+
arrestDetails?: coreComponents["schemas"]["EddScoreDetails"];
|
|
10726
|
+
bankruptcyDetails?: coreComponents["schemas"]["EddScoreDetails"];
|
|
10727
|
+
fraudDetails?: coreComponents["schemas"]["EddScoreDetails"];
|
|
10728
|
+
};
|
|
10729
|
+
score?: coreComponents["schemas"]["EddData"];
|
|
10730
|
+
/** The EDD score next update time. */
|
|
10731
|
+
nextUpdateTime?: string | null;
|
|
10732
|
+
/** The EDD score updated time. */
|
|
10733
|
+
updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
10734
|
+
/** The links related to resource. */
|
|
10735
|
+
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
10736
|
+
Partial<coreComponents["schemas"]["EddOccupationSearchResultLink"]> &
|
|
10737
|
+
Partial<coreComponents["schemas"]["EddFraudSearchResultLink"]> &
|
|
10738
|
+
Partial<coreComponents["schemas"]["EddArrestSearchResultLink"]> &
|
|
10739
|
+
Partial<coreComponents["schemas"]["EddBankruptcySearchResultLink"]>)[];
|
|
10740
|
+
};
|
|
10741
|
+
EddTimeline: {
|
|
10742
|
+
/** The Timeline message identifier string. */
|
|
10743
|
+
id?: coreComponents["schemas"]["ResourceId"];
|
|
10744
|
+
/** Timeline message type. */
|
|
10745
|
+
type?:
|
|
10746
|
+
| "edd-search-performed"
|
|
10747
|
+
| "edd-score-manually-updated"
|
|
10748
|
+
| "timeline-comment-created";
|
|
10749
|
+
/** Shows who or what triggered the Timeline event. */
|
|
10750
|
+
triggeredBy?: "rebilly" | "app" | "direct-api";
|
|
10751
|
+
/** The message that describes the message details. */
|
|
10752
|
+
message?: string;
|
|
10753
|
+
extraData?: coreComponents["schemas"]["TimelineExtraData"];
|
|
10754
|
+
/** Timeline message time. */
|
|
10755
|
+
occurredTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
10756
|
+
/** The links related to resource. */
|
|
10757
|
+
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
10758
|
+
};
|
|
10759
|
+
EddSearchResult: {
|
|
10760
|
+
id?: coreComponents["schemas"]["ResourceId"];
|
|
10761
|
+
type?: "occupation" | "arrest" | "fraud" | "bankruptcy";
|
|
10762
|
+
results?: coreComponents["schemas"]["EddScoreDetails"][];
|
|
10763
|
+
/** The EDD search result created time. */
|
|
10764
|
+
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
10765
|
+
};
|
|
10501
10766
|
KycDocumentLink: coreComponents["schemas"]["Link"] & {
|
|
10502
10767
|
/** The link type. */
|
|
10503
10768
|
rel: "kycDocument";
|
|
10504
10769
|
};
|
|
10770
|
+
KycRequestLink: coreComponents["schemas"]["Link"] & {
|
|
10771
|
+
/** The link type. */
|
|
10772
|
+
rel: "kycRequest";
|
|
10773
|
+
};
|
|
10505
10774
|
SubscriptionPauseLink: coreComponents["schemas"]["Link"] & {
|
|
10506
10775
|
/** The link type. */
|
|
10507
10776
|
rel: "pause";
|
|
@@ -10511,31 +10780,31 @@ export interface coreComponents {
|
|
|
10511
10780
|
/** Unauthorized access, invalid credentials were used. */
|
|
10512
10781
|
Unauthorized: {
|
|
10513
10782
|
content: {
|
|
10514
|
-
"application/json": coreComponents["schemas"]["
|
|
10783
|
+
"application/json": coreComponents["schemas"]["Unauthorized"];
|
|
10515
10784
|
};
|
|
10516
10785
|
};
|
|
10517
10786
|
/** Access forbidden. */
|
|
10518
10787
|
Forbidden: {
|
|
10519
10788
|
content: {
|
|
10520
|
-
"application/json": coreComponents["schemas"]["
|
|
10789
|
+
"application/json": coreComponents["schemas"]["Forbidden"];
|
|
10521
10790
|
};
|
|
10522
10791
|
};
|
|
10523
10792
|
/** Conflict. */
|
|
10524
10793
|
Conflict: {
|
|
10525
10794
|
content: {
|
|
10526
|
-
"application/json": coreComponents["schemas"]["
|
|
10795
|
+
"application/json": coreComponents["schemas"]["Conflict"];
|
|
10527
10796
|
};
|
|
10528
10797
|
};
|
|
10529
10798
|
/** Invalid data was sent. */
|
|
10530
10799
|
ValidationError: {
|
|
10531
10800
|
content: {
|
|
10532
|
-
"application/json": coreComponents["schemas"]["
|
|
10801
|
+
"application/json": coreComponents["schemas"]["ValidationError"];
|
|
10533
10802
|
};
|
|
10534
10803
|
};
|
|
10535
10804
|
/** Resource was not found. */
|
|
10536
10805
|
NotFound: {
|
|
10537
10806
|
content: {
|
|
10538
|
-
"application/json": coreComponents["schemas"]["
|
|
10807
|
+
"application/json": coreComponents["schemas"]["NotFound"];
|
|
10539
10808
|
};
|
|
10540
10809
|
};
|
|
10541
10810
|
/** Customer. */
|
|
@@ -10897,6 +11166,26 @@ export interface coreComponents {
|
|
|
10897
11166
|
};
|
|
10898
11167
|
};
|
|
10899
11168
|
};
|
|
11169
|
+
/** KYC request webhook body resource. */
|
|
11170
|
+
KycRequest: {
|
|
11171
|
+
content: {
|
|
11172
|
+
"application/json": {
|
|
11173
|
+
/** The customer ID. */
|
|
11174
|
+
customerId?: string;
|
|
11175
|
+
/** The KYC request ID. */
|
|
11176
|
+
kycRequestId?: string;
|
|
11177
|
+
/** Rebilly webhooks event type. */
|
|
11178
|
+
eventType?: "kyc-request-fulfilled";
|
|
11179
|
+
_embedded?: {
|
|
11180
|
+
customer?: coreComponents["schemas"]["Customer"];
|
|
11181
|
+
kycRequest?: coreComponents["schemas"]["KycRequest"];
|
|
11182
|
+
};
|
|
11183
|
+
/** The links related to resource. */
|
|
11184
|
+
_links?: (Partial<coreComponents["schemas"]["CustomerLink"]> &
|
|
11185
|
+
Partial<coreComponents["schemas"]["KycRequestLink"]>)[];
|
|
11186
|
+
};
|
|
11187
|
+
};
|
|
11188
|
+
};
|
|
10900
11189
|
/** Order webhook request body resource. */
|
|
10901
11190
|
Subscription2: {
|
|
10902
11191
|
content: {
|
|
@@ -11371,12 +11660,7 @@ export interface operations {
|
|
|
11371
11660
|
};
|
|
11372
11661
|
401: coreComponents["responses"]["Unauthorized"];
|
|
11373
11662
|
403: coreComponents["responses"]["Forbidden"];
|
|
11374
|
-
|
|
11375
|
-
409: {
|
|
11376
|
-
content: {
|
|
11377
|
-
"application/json": coreComponents["schemas"]["Error"];
|
|
11378
|
-
};
|
|
11379
|
-
};
|
|
11663
|
+
409: coreComponents["responses"]["Conflict"];
|
|
11380
11664
|
422: coreComponents["responses"]["ValidationError"];
|
|
11381
11665
|
};
|
|
11382
11666
|
requestBody: coreComponents["requestBodies"]["Blocklist"];
|
|
@@ -11578,7 +11862,7 @@ export interface operations {
|
|
|
11578
11862
|
requestBody: coreComponents["requestBodies"]["Coupon"];
|
|
11579
11863
|
};
|
|
11580
11864
|
/**
|
|
11581
|
-
* Set a coupon's
|
|
11865
|
+
* Set a coupon's expiration time with the specified coupon ID.
|
|
11582
11866
|
* The expiredTime of a coupon must be greater than its issuedTime.
|
|
11583
11867
|
* This cannot be performed on expired coupons.
|
|
11584
11868
|
*/
|
|
@@ -13061,6 +13345,120 @@ export interface operations {
|
|
|
13061
13345
|
409: coreComponents["responses"]["Conflict"];
|
|
13062
13346
|
};
|
|
13063
13347
|
};
|
|
13348
|
+
/** Retrieve a list of KYC requests. */
|
|
13349
|
+
GetKycRequestCollection: {
|
|
13350
|
+
parameters: {
|
|
13351
|
+
query: {
|
|
13352
|
+
/** The collection items limit. */
|
|
13353
|
+
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
13354
|
+
/** The collection items offset. */
|
|
13355
|
+
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
13356
|
+
/**
|
|
13357
|
+
* The collection items filter requires a special format.
|
|
13358
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
13359
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
13360
|
+
*/
|
|
13361
|
+
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
13362
|
+
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
13363
|
+
sort?: coreComponents["parameters"]["collectionSort"];
|
|
13364
|
+
};
|
|
13365
|
+
};
|
|
13366
|
+
responses: {
|
|
13367
|
+
/** A list of KYC requests was retrieved successfully. */
|
|
13368
|
+
200: {
|
|
13369
|
+
headers: {};
|
|
13370
|
+
content: {
|
|
13371
|
+
"application/json": coreComponents["schemas"]["KycRequest"][];
|
|
13372
|
+
};
|
|
13373
|
+
};
|
|
13374
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
13375
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
13376
|
+
};
|
|
13377
|
+
};
|
|
13378
|
+
/**
|
|
13379
|
+
* Create a KYC Request.
|
|
13380
|
+
* Then, redirect the customer to the `kycGatherer` link.
|
|
13381
|
+
* After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
|
|
13382
|
+
* Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
|
|
13383
|
+
* When the complete list of documents is received and accepted, the KYC request fulfilled webhook will be sent to subscribers.
|
|
13384
|
+
* If a `credit-file-proof` is successful with the dual process method, then corresponding `identity-proof` and `address-proof` documents are not requested.
|
|
13385
|
+
*/
|
|
13386
|
+
PostKycRequest: {
|
|
13387
|
+
responses: {
|
|
13388
|
+
/** KYC request was created. */
|
|
13389
|
+
201: {
|
|
13390
|
+
content: {
|
|
13391
|
+
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
13392
|
+
};
|
|
13393
|
+
};
|
|
13394
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
13395
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
13396
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
13397
|
+
};
|
|
13398
|
+
/** KYC request resource. */
|
|
13399
|
+
requestBody: {
|
|
13400
|
+
content: {
|
|
13401
|
+
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
13402
|
+
};
|
|
13403
|
+
};
|
|
13404
|
+
};
|
|
13405
|
+
/** Retrieve a KYC request with specified identifier string. */
|
|
13406
|
+
GetKycRequest: {
|
|
13407
|
+
parameters: {
|
|
13408
|
+
path: {
|
|
13409
|
+
/** The resource identifier string. */
|
|
13410
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
13411
|
+
};
|
|
13412
|
+
};
|
|
13413
|
+
responses: {
|
|
13414
|
+
/** KYC request was retrieved successfully. */
|
|
13415
|
+
200: {
|
|
13416
|
+
content: {
|
|
13417
|
+
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
13418
|
+
};
|
|
13419
|
+
};
|
|
13420
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
13421
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
13422
|
+
404: coreComponents["responses"]["NotFound"];
|
|
13423
|
+
};
|
|
13424
|
+
};
|
|
13425
|
+
/** Delete the KYC request with the predefined identifier string. */
|
|
13426
|
+
DeleteKycRequest: {
|
|
13427
|
+
parameters: {
|
|
13428
|
+
path: {
|
|
13429
|
+
/** The resource identifier string. */
|
|
13430
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
13431
|
+
};
|
|
13432
|
+
};
|
|
13433
|
+
responses: {
|
|
13434
|
+
/** The KYC request was deleted. */
|
|
13435
|
+
204: never;
|
|
13436
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
13437
|
+
404: coreComponents["responses"]["NotFound"];
|
|
13438
|
+
};
|
|
13439
|
+
};
|
|
13440
|
+
/** Update a KYC request. */
|
|
13441
|
+
PatchKycRequest: {
|
|
13442
|
+
parameters: {
|
|
13443
|
+
path: {
|
|
13444
|
+
/** The resource identifier string. */
|
|
13445
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
13446
|
+
};
|
|
13447
|
+
};
|
|
13448
|
+
responses: {
|
|
13449
|
+
/** KYC request was updated. */
|
|
13450
|
+
200: {
|
|
13451
|
+
content: {
|
|
13452
|
+
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
13453
|
+
};
|
|
13454
|
+
};
|
|
13455
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
13456
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
13457
|
+
404: coreComponents["responses"]["NotFound"];
|
|
13458
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
13459
|
+
};
|
|
13460
|
+
requestBody: coreComponents["requestBodies"]["PatchKycRequest"];
|
|
13461
|
+
};
|
|
13064
13462
|
/** Retrieve a list of KYC documents. */
|
|
13065
13463
|
GetKycDocumentCollection: {
|
|
13066
13464
|
parameters: {
|
|
@@ -13297,118 +13695,26 @@ export interface operations {
|
|
|
13297
13695
|
422: coreComponents["responses"]["ValidationError"];
|
|
13298
13696
|
};
|
|
13299
13697
|
};
|
|
13300
|
-
/**
|
|
13301
|
-
|
|
13302
|
-
parameters: {
|
|
13303
|
-
query: {
|
|
13304
|
-
/** The collection items limit. */
|
|
13305
|
-
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
13306
|
-
/** The collection items offset. */
|
|
13307
|
-
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
13308
|
-
/**
|
|
13309
|
-
* The collection items filter requires a special format.
|
|
13310
|
-
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
13311
|
-
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
13312
|
-
*/
|
|
13313
|
-
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
13314
|
-
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
13315
|
-
sort?: coreComponents["parameters"]["collectionSort"];
|
|
13316
|
-
};
|
|
13317
|
-
};
|
|
13698
|
+
/** Update KYC settings. */
|
|
13699
|
+
PutKycSettings: {
|
|
13318
13700
|
responses: {
|
|
13319
|
-
/**
|
|
13701
|
+
/** KYC settings were updated. */
|
|
13320
13702
|
200: {
|
|
13321
|
-
headers: {};
|
|
13322
13703
|
content: {
|
|
13323
|
-
"application/json": coreComponents["schemas"]["
|
|
13704
|
+
"application/json": coreComponents["schemas"]["KycSettings"];
|
|
13324
13705
|
};
|
|
13325
13706
|
};
|
|
13326
13707
|
401: coreComponents["responses"]["Unauthorized"];
|
|
13327
13708
|
403: coreComponents["responses"]["Forbidden"];
|
|
13709
|
+
404: coreComponents["responses"]["NotFound"];
|
|
13328
13710
|
};
|
|
13329
|
-
|
|
13330
|
-
/**
|
|
13331
|
-
* Create a KYC Request.
|
|
13332
|
-
* Then, redirect the customer to the `kycGatherer` link.
|
|
13333
|
-
* After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
|
|
13334
|
-
* Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
|
|
13335
|
-
*/
|
|
13336
|
-
PostKycRequest: {
|
|
13337
|
-
responses: {
|
|
13338
|
-
/** Kyc request was created. */
|
|
13339
|
-
201: {
|
|
13340
|
-
content: {
|
|
13341
|
-
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
13342
|
-
};
|
|
13343
|
-
};
|
|
13344
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
13345
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
13346
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
13347
|
-
};
|
|
13348
|
-
/** Kyc request resource. */
|
|
13711
|
+
/** The settings for KYC analysis. */
|
|
13349
13712
|
requestBody: {
|
|
13350
13713
|
content: {
|
|
13351
|
-
"application/json": coreComponents["schemas"]["
|
|
13352
|
-
};
|
|
13353
|
-
};
|
|
13354
|
-
};
|
|
13355
|
-
/** Retrieve a KYC request with specified identifier string. */
|
|
13356
|
-
GetKycRequest: {
|
|
13357
|
-
parameters: {
|
|
13358
|
-
path: {
|
|
13359
|
-
/** The resource identifier string. */
|
|
13360
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
13361
|
-
};
|
|
13362
|
-
};
|
|
13363
|
-
responses: {
|
|
13364
|
-
/** KYC request was retrieved successfully. */
|
|
13365
|
-
200: {
|
|
13366
|
-
content: {
|
|
13367
|
-
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
13368
|
-
};
|
|
13714
|
+
"application/json": coreComponents["schemas"]["KycSettings"];
|
|
13369
13715
|
};
|
|
13370
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
13371
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
13372
|
-
404: coreComponents["responses"]["NotFound"];
|
|
13373
13716
|
};
|
|
13374
13717
|
};
|
|
13375
|
-
/** Delete the KYC request with the predefined identifier string. */
|
|
13376
|
-
DeleteKycRequest: {
|
|
13377
|
-
parameters: {
|
|
13378
|
-
path: {
|
|
13379
|
-
/** The resource identifier string. */
|
|
13380
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
13381
|
-
};
|
|
13382
|
-
};
|
|
13383
|
-
responses: {
|
|
13384
|
-
/** The KYC request was deleted. */
|
|
13385
|
-
204: never;
|
|
13386
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
13387
|
-
404: coreComponents["responses"]["NotFound"];
|
|
13388
|
-
};
|
|
13389
|
-
};
|
|
13390
|
-
/** Update a KYC request. */
|
|
13391
|
-
PatchKycRequest: {
|
|
13392
|
-
parameters: {
|
|
13393
|
-
path: {
|
|
13394
|
-
/** The resource identifier string. */
|
|
13395
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
13396
|
-
};
|
|
13397
|
-
};
|
|
13398
|
-
responses: {
|
|
13399
|
-
/** KYC request was updated. */
|
|
13400
|
-
200: {
|
|
13401
|
-
content: {
|
|
13402
|
-
"application/json": coreComponents["schemas"]["KycRequest"];
|
|
13403
|
-
};
|
|
13404
|
-
};
|
|
13405
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
13406
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
13407
|
-
404: coreComponents["responses"]["NotFound"];
|
|
13408
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
13409
|
-
};
|
|
13410
|
-
requestBody: coreComponents["requestBodies"]["PatchKycRequest"];
|
|
13411
|
-
};
|
|
13412
13718
|
/** Retrieve a list of tokens. */
|
|
13413
13719
|
GetPasswordTokenCollection: {
|
|
13414
13720
|
parameters: {
|
|
@@ -15630,6 +15936,136 @@ export interface operations {
|
|
|
15630
15936
|
};
|
|
15631
15937
|
};
|
|
15632
15938
|
};
|
|
15939
|
+
/** Retrieve a EDD score of given customer. */
|
|
15940
|
+
GetCustomerEddScore: {
|
|
15941
|
+
parameters: {
|
|
15942
|
+
path: {
|
|
15943
|
+
/** The resource identifier string. */
|
|
15944
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
15945
|
+
};
|
|
15946
|
+
};
|
|
15947
|
+
responses: {
|
|
15948
|
+
/** EDD score was retrieved successfully. */
|
|
15949
|
+
200: {
|
|
15950
|
+
content: {
|
|
15951
|
+
"application/json": coreComponents["schemas"]["Edd"];
|
|
15952
|
+
};
|
|
15953
|
+
};
|
|
15954
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
15955
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
15956
|
+
404: coreComponents["responses"]["NotFound"];
|
|
15957
|
+
};
|
|
15958
|
+
};
|
|
15959
|
+
/** Update customer's EDD score data. */
|
|
15960
|
+
PatchCustomerEddScore: {
|
|
15961
|
+
parameters: {
|
|
15962
|
+
path: {
|
|
15963
|
+
/** The resource identifier string. */
|
|
15964
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
15965
|
+
};
|
|
15966
|
+
};
|
|
15967
|
+
responses: {
|
|
15968
|
+
/** EDD score was updated. */
|
|
15969
|
+
200: {
|
|
15970
|
+
content: {
|
|
15971
|
+
"application/json": coreComponents["schemas"]["Edd"];
|
|
15972
|
+
};
|
|
15973
|
+
};
|
|
15974
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
15975
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
15976
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
15977
|
+
};
|
|
15978
|
+
requestBody: {
|
|
15979
|
+
content: {
|
|
15980
|
+
"application/json": {
|
|
15981
|
+
/** Customer's EDD score. */
|
|
15982
|
+
score: coreComponents["schemas"]["EddData"];
|
|
15983
|
+
};
|
|
15984
|
+
};
|
|
15985
|
+
};
|
|
15986
|
+
};
|
|
15987
|
+
/** Retrieve a list of EDD timeline messages. */
|
|
15988
|
+
GetEddTimelineCollection: {
|
|
15989
|
+
parameters: {
|
|
15990
|
+
path: {
|
|
15991
|
+
/** The resource identifier string. */
|
|
15992
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
15993
|
+
};
|
|
15994
|
+
query: {
|
|
15995
|
+
/** The collection items limit. */
|
|
15996
|
+
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
15997
|
+
/** The collection items offset. */
|
|
15998
|
+
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
15999
|
+
/**
|
|
16000
|
+
* The collection items filter requires a special format.
|
|
16001
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
16002
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
16003
|
+
*/
|
|
16004
|
+
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
16005
|
+
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
16006
|
+
sort?: coreComponents["parameters"]["collectionSort"];
|
|
16007
|
+
/** The partial search of the text fields. */
|
|
16008
|
+
q?: coreComponents["parameters"]["collectionQuery"];
|
|
16009
|
+
};
|
|
16010
|
+
};
|
|
16011
|
+
responses: {
|
|
16012
|
+
/** A list of EDD timeline messages was retrieved successfully. */
|
|
16013
|
+
200: {
|
|
16014
|
+
headers: {};
|
|
16015
|
+
content: {
|
|
16016
|
+
"application/json": coreComponents["schemas"]["EddTimeline"][];
|
|
16017
|
+
};
|
|
16018
|
+
};
|
|
16019
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
16020
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
16021
|
+
};
|
|
16022
|
+
};
|
|
16023
|
+
/** Create a EDD Timeline comment or custom defined event. */
|
|
16024
|
+
PostEddTimeline: {
|
|
16025
|
+
parameters: {
|
|
16026
|
+
path: {
|
|
16027
|
+
/** The resource identifier string. */
|
|
16028
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
16029
|
+
};
|
|
16030
|
+
};
|
|
16031
|
+
responses: {
|
|
16032
|
+
/** EDD Timeline comment was created. */
|
|
16033
|
+
201: {
|
|
16034
|
+
content: {
|
|
16035
|
+
"application/json": coreComponents["schemas"]["EddTimeline"];
|
|
16036
|
+
};
|
|
16037
|
+
};
|
|
16038
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
16039
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
16040
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
16041
|
+
};
|
|
16042
|
+
/** EDD Timeline resource. */
|
|
16043
|
+
requestBody: {
|
|
16044
|
+
content: {
|
|
16045
|
+
"application/json": coreComponents["schemas"]["EddTimeline"];
|
|
16046
|
+
};
|
|
16047
|
+
};
|
|
16048
|
+
};
|
|
16049
|
+
/** Retrieve a EDD search results of given customer. */
|
|
16050
|
+
GetEddSearchResults: {
|
|
16051
|
+
parameters: {
|
|
16052
|
+
path: {
|
|
16053
|
+
/** The resource identifier string. */
|
|
16054
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
16055
|
+
};
|
|
16056
|
+
};
|
|
16057
|
+
responses: {
|
|
16058
|
+
/** EDD search results were retrieved successfully. */
|
|
16059
|
+
200: {
|
|
16060
|
+
content: {
|
|
16061
|
+
"application/json": coreComponents["schemas"]["EddSearchResult"][];
|
|
16062
|
+
};
|
|
16063
|
+
};
|
|
16064
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
16065
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
16066
|
+
404: coreComponents["responses"]["NotFound"];
|
|
16067
|
+
};
|
|
16068
|
+
};
|
|
15633
16069
|
}
|
|
15634
16070
|
/**
|
|
15635
16071
|
* This file was auto-generated by openapi-typescript.
|
|
@@ -16483,7 +16919,7 @@ export interface usersPaths {
|
|
|
16483
16919
|
post: operations["PostOrganization"];
|
|
16484
16920
|
};
|
|
16485
16921
|
"/organizations/{id}": {
|
|
16486
|
-
/** Retrieve
|
|
16922
|
+
/** Retrieve an organization with specified identifier string. */
|
|
16487
16923
|
get: operations["GetOrganization"];
|
|
16488
16924
|
/** Update an organization. */
|
|
16489
16925
|
patch: operations["PatchOrganization"];
|
|
@@ -16760,35 +17196,42 @@ export interface usersComponents {
|
|
|
16760
17196
|
/** Read-only timestamp, automatically assigned on back-end. */
|
|
16761
17197
|
ServerTimestamp: string;
|
|
16762
17198
|
/** The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)]. */
|
|
16763
|
-
|
|
16764
|
-
/** The HTTP status code. */
|
|
16765
|
-
status?: number;
|
|
16766
|
-
/** A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
|
|
16767
|
-
title?: string;
|
|
16768
|
-
} & { [key: string]: any };
|
|
16769
|
-
DocumentedProblem: {
|
|
17199
|
+
BaseProblem: {
|
|
16770
17200
|
/** A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". */
|
|
16771
17201
|
type?: string;
|
|
16772
|
-
|
|
16773
|
-
|
|
17202
|
+
/** A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
|
|
17203
|
+
title?: string;
|
|
16774
17204
|
/** A human-readable explanation specific to this occurrence of the problem. */
|
|
16775
17205
|
detail?: string;
|
|
16776
|
-
|
|
16777
|
-
|
|
16778
|
-
|
|
16779
|
-
|
|
16780
|
-
|
|
16781
|
-
|
|
16782
|
-
|
|
16783
|
-
|
|
16784
|
-
|
|
16785
|
-
|
|
16786
|
-
|
|
16787
|
-
|
|
16788
|
-
|
|
16789
|
-
|
|
16790
|
-
|
|
16791
|
-
|
|
17206
|
+
/** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
|
|
17207
|
+
instance?: string;
|
|
17208
|
+
} & { [key: string]: any };
|
|
17209
|
+
Unauthorized: { [key: string]: any } & {
|
|
17210
|
+
/** The HTTP status code. */
|
|
17211
|
+
status?: number;
|
|
17212
|
+
} & usersComponents["schemas"]["BaseProblem"];
|
|
17213
|
+
Forbidden: { [key: string]: any } & {
|
|
17214
|
+
/** The HTTP status code. */
|
|
17215
|
+
status?: number;
|
|
17216
|
+
} & usersComponents["schemas"]["BaseProblem"];
|
|
17217
|
+
Conflict: { [key: string]: any } & {
|
|
17218
|
+
/** The HTTP status code. */
|
|
17219
|
+
status?: number;
|
|
17220
|
+
} & usersComponents["schemas"]["BaseProblem"];
|
|
17221
|
+
ValidationError: { [key: string]: any } & {
|
|
17222
|
+
/** The HTTP status code. */
|
|
17223
|
+
status?: number;
|
|
17224
|
+
} & usersComponents["schemas"]["BaseProblem"] & {
|
|
17225
|
+
invalidFields?: {
|
|
17226
|
+
/** The field name. Dot notation is used for nested object field names. */
|
|
17227
|
+
field?: string;
|
|
17228
|
+
message?: string;
|
|
17229
|
+
}[];
|
|
17230
|
+
};
|
|
17231
|
+
NotFound: {
|
|
17232
|
+
/** The HTTP status code. */
|
|
17233
|
+
status?: number;
|
|
17234
|
+
} & usersComponents["schemas"]["BaseProblem"];
|
|
16792
17235
|
ApiKeyScope: {
|
|
16793
17236
|
/** The array of account identifier strings. */
|
|
16794
17237
|
organizationId?: usersComponents["schemas"]["ResourceId"][];
|
|
@@ -16814,6 +17257,26 @@ export interface usersComponents {
|
|
|
16814
17257
|
CurrencyCode: string;
|
|
16815
17258
|
/** The context in which the discount applies. */
|
|
16816
17259
|
DiscountContext: "items" | "shipping" | "items-and-shipping";
|
|
17260
|
+
/** The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)]. */
|
|
17261
|
+
BlankProblem: {
|
|
17262
|
+
/** The HTTP status code. */
|
|
17263
|
+
status?: number;
|
|
17264
|
+
/** A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
|
|
17265
|
+
title?: string;
|
|
17266
|
+
} & { [key: string]: any };
|
|
17267
|
+
DocumentedProblem: {
|
|
17268
|
+
/** A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". */
|
|
17269
|
+
type?: string;
|
|
17270
|
+
} & usersComponents["schemas"]["BlankProblem"];
|
|
17271
|
+
DetailedProblem: usersComponents["schemas"]["BlankProblem"] & {
|
|
17272
|
+
/** A human-readable explanation specific to this occurrence of the problem. */
|
|
17273
|
+
detail?: string;
|
|
17274
|
+
};
|
|
17275
|
+
Problem: usersComponents["schemas"]["DocumentedProblem"] &
|
|
17276
|
+
usersComponents["schemas"]["DetailedProblem"];
|
|
17277
|
+
Error: usersComponents["schemas"]["Problem"] & {
|
|
17278
|
+
error?: string;
|
|
17279
|
+
};
|
|
16817
17280
|
/** The payment method. */
|
|
16818
17281
|
PaymentMethod:
|
|
16819
17282
|
| "payment-card"
|
|
@@ -17181,6 +17644,8 @@ export interface usersComponents {
|
|
|
17181
17644
|
* The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
|
|
17182
17645
|
*/
|
|
17183
17646
|
revision?: number;
|
|
17647
|
+
/** Indicates if EDD is enabled for this customer. */
|
|
17648
|
+
isEddRequired: boolean;
|
|
17184
17649
|
/** The links related to resource. */
|
|
17185
17650
|
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
17186
17651
|
Partial<usersComponents["schemas"]["DefaultPaymentInstrumentLink"]> &
|
|
@@ -17190,7 +17655,11 @@ export interface usersComponents {
|
|
|
17190
17655
|
_embedded?: Partial<usersComponents["schemas"]["LeadSourceEmbed"]>[];
|
|
17191
17656
|
};
|
|
17192
17657
|
TimelineAction: {
|
|
17193
|
-
action?:
|
|
17658
|
+
action?:
|
|
17659
|
+
| "resend-email"
|
|
17660
|
+
| "redemption-cancel"
|
|
17661
|
+
| "ruleset-restore"
|
|
17662
|
+
| "show-edd-search-logs";
|
|
17194
17663
|
};
|
|
17195
17664
|
/** Cancel Redemption. */
|
|
17196
17665
|
"redemption-cancel": usersComponents["schemas"]["TimelineAction"] & {
|
|
@@ -17205,6 +17674,11 @@ export interface usersComponents {
|
|
|
17205
17674
|
/** Rulset version to restore. */
|
|
17206
17675
|
version?: number;
|
|
17207
17676
|
};
|
|
17677
|
+
/** Show EDD search logs action. */
|
|
17678
|
+
"show-edd-search-logs": usersComponents["schemas"]["TimelineAction"] & {
|
|
17679
|
+
searchLogId?: usersComponents["schemas"]["ResourceId"];
|
|
17680
|
+
type?: "arrest" | "bankruptcy" | "fraud" | "occupation";
|
|
17681
|
+
};
|
|
17208
17682
|
/** Additional information about Timeline message. */
|
|
17209
17683
|
TimelineTable: {
|
|
17210
17684
|
type?: "list" | "one-columns" | "two-columns" | "three-columns";
|
|
@@ -17292,6 +17766,7 @@ export interface usersComponents {
|
|
|
17292
17766
|
/** The payment gateway name. */
|
|
17293
17767
|
GatewayName:
|
|
17294
17768
|
| "A1Gateway"
|
|
17769
|
+
| "ACI"
|
|
17295
17770
|
| "Adyen"
|
|
17296
17771
|
| "Airpay"
|
|
17297
17772
|
| "AmazonPay"
|
|
@@ -17342,6 +17817,7 @@ export interface usersComponents {
|
|
|
17342
17817
|
| "EPro"
|
|
17343
17818
|
| "eZeeWallet"
|
|
17344
17819
|
| "ezyEFT"
|
|
17820
|
+
| "FasterPay"
|
|
17345
17821
|
| "Finrax"
|
|
17346
17822
|
| "Flexepin"
|
|
17347
17823
|
| "FinTecSystems"
|
|
@@ -17440,7 +17916,6 @@ export interface usersComponents {
|
|
|
17440
17916
|
| "TestProcessor"
|
|
17441
17917
|
| "ToditoCash"
|
|
17442
17918
|
| "Truevo"
|
|
17443
|
-
| "TrustPay"
|
|
17444
17919
|
| "TrustsPay"
|
|
17445
17920
|
| "Trustly"
|
|
17446
17921
|
| "TWINT"
|
|
@@ -17552,6 +18027,7 @@ export interface usersComponents {
|
|
|
17552
18027
|
/** The acquirer name. */
|
|
17553
18028
|
AcquirerName:
|
|
17554
18029
|
| "Adyen"
|
|
18030
|
+
| "ACI"
|
|
17555
18031
|
| "Alipay"
|
|
17556
18032
|
| "AIB"
|
|
17557
18033
|
| "Airpay"
|
|
@@ -17768,6 +18244,8 @@ export interface usersComponents {
|
|
|
17768
18244
|
kountFraudSessionId?: string;
|
|
17769
18245
|
/** MerchantSessionID as generated by the PayPal Fraudnet SDK. */
|
|
17770
18246
|
payPalMerchantSessionId?: string;
|
|
18247
|
+
/** A temporary identifier that is unique to the visitor's session and passed to ThreatMetrix. */
|
|
18248
|
+
threatMetrixSessionId?: string;
|
|
17771
18249
|
};
|
|
17772
18250
|
/** Risk metadata used for 3DS and risk scoring. */
|
|
17773
18251
|
RiskMetadata: {
|
|
@@ -18269,6 +18747,28 @@ export interface usersComponents {
|
|
|
18269
18747
|
};
|
|
18270
18748
|
threeDSecureServer?: usersComponents["schemas"]["A1Gateway3dsServers"];
|
|
18271
18749
|
};
|
|
18750
|
+
/** ACI 3DS Servers. */
|
|
18751
|
+
ACI3dsServers: {
|
|
18752
|
+
name: "ThreeDSecureIO3dsServer";
|
|
18753
|
+
};
|
|
18754
|
+
/** ACI config. */
|
|
18755
|
+
ACI: usersComponents["schemas"]["GatewayAccount"] & {
|
|
18756
|
+
/** ACI credentials object. */
|
|
18757
|
+
credentials: {
|
|
18758
|
+
entityId: string;
|
|
18759
|
+
accessToken: string;
|
|
18760
|
+
};
|
|
18761
|
+
/** ACI settings object. */
|
|
18762
|
+
settings?: {
|
|
18763
|
+
/** ACI custom server URL. */
|
|
18764
|
+
url?: string;
|
|
18765
|
+
};
|
|
18766
|
+
threeDSecureServer?: usersComponents["schemas"]["ACI3dsServers"];
|
|
18767
|
+
};
|
|
18768
|
+
/** Adyen 3DS Servers. */
|
|
18769
|
+
Adyen3dsServers: {
|
|
18770
|
+
name: "ThreeDSecureIO3dsServer";
|
|
18771
|
+
};
|
|
18272
18772
|
/** Adyen config. */
|
|
18273
18773
|
Adyen: usersComponents["schemas"]["GatewayAccount"] & {
|
|
18274
18774
|
/** Adyen credentials object. */
|
|
@@ -18283,6 +18783,7 @@ export interface usersComponents {
|
|
|
18283
18783
|
/** Adyen post URL. */
|
|
18284
18784
|
url: string;
|
|
18285
18785
|
};
|
|
18786
|
+
threeDSecureServer?: usersComponents["schemas"]["Adyen3dsServers"];
|
|
18286
18787
|
};
|
|
18287
18788
|
/** Airpay config. */
|
|
18288
18789
|
Airpay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -18600,6 +19101,10 @@ export interface usersComponents {
|
|
|
18600
19101
|
/** Checkout.com secret API key. */
|
|
18601
19102
|
secretKey: string;
|
|
18602
19103
|
};
|
|
19104
|
+
settings?: {
|
|
19105
|
+
/** Mark as waiting-gateway/unknown instead of approved on pending payout. */
|
|
19106
|
+
markAsWaitingGatewayOnPendingPayout: boolean;
|
|
19107
|
+
};
|
|
18603
19108
|
threeDSecureServer?: usersComponents["schemas"]["CheckoutCom3dsServers"];
|
|
18604
19109
|
};
|
|
18605
19110
|
/** Circle config. */
|
|
@@ -19545,6 +20050,11 @@ export interface usersComponents {
|
|
|
19545
20050
|
credentials: {
|
|
19546
20051
|
apiKey: string;
|
|
19547
20052
|
};
|
|
20053
|
+
/** OnRamp settings object. */
|
|
20054
|
+
settings?: {
|
|
20055
|
+
/** Use OnRamp server to server API. */
|
|
20056
|
+
useServerToServerApi: boolean;
|
|
20057
|
+
};
|
|
19548
20058
|
};
|
|
19549
20059
|
/** Pagsmile Gateway config. */
|
|
19550
20060
|
Pagsmile: usersComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -19977,6 +20487,8 @@ export interface usersComponents {
|
|
|
19977
20487
|
merchantCode: string;
|
|
19978
20488
|
/** Redsys Gateway secret code. */
|
|
19979
20489
|
secretCode: string;
|
|
20490
|
+
/** Redsys Gateway merchant sha256 code. Required for Bizum payments. */
|
|
20491
|
+
sha256SecretCode?: string;
|
|
19980
20492
|
};
|
|
19981
20493
|
};
|
|
19982
20494
|
/** Rotessa config. */
|
|
@@ -20338,19 +20850,6 @@ export interface usersComponents {
|
|
|
20338
20850
|
};
|
|
20339
20851
|
threeDSecureServer?: usersComponents["schemas"]["Truevo3dsServers"];
|
|
20340
20852
|
};
|
|
20341
|
-
/** TrustPay 3DS Servers. */
|
|
20342
|
-
TrustPay3dsServers: {
|
|
20343
|
-
name: "ThreeDSecureIO3dsServer";
|
|
20344
|
-
};
|
|
20345
|
-
/** TrustPay config. */
|
|
20346
|
-
TrustPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
20347
|
-
/** TrustPay credentials object. */
|
|
20348
|
-
credentials: {
|
|
20349
|
-
entityId: string;
|
|
20350
|
-
accessToken: string;
|
|
20351
|
-
};
|
|
20352
|
-
threeDSecureServer?: usersComponents["schemas"]["TrustPay3dsServers"];
|
|
20353
|
-
};
|
|
20354
20853
|
/** TrustsPay config. */
|
|
20355
20854
|
TrustsPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
20356
20855
|
/** TrustsPay credentials object. */
|
|
@@ -20781,6 +21280,8 @@ export interface usersComponents {
|
|
|
20781
21280
|
billingAddress?: usersComponents["schemas"]["ContactObject"];
|
|
20782
21281
|
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
20783
21282
|
useAsBackup: boolean;
|
|
21283
|
+
/** URL to the billing portal where the card can be updated. */
|
|
21284
|
+
billingPortalUrl?: string;
|
|
20784
21285
|
/** Payment instrument created time. */
|
|
20785
21286
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
20786
21287
|
/** Payment instrument updated time. */
|
|
@@ -20805,6 +21306,8 @@ export interface usersComponents {
|
|
|
20805
21306
|
expirationReminderNumber?: number | null;
|
|
20806
21307
|
/** Payment instrument reference data. */
|
|
20807
21308
|
referenceData?: { [key: string]: string };
|
|
21309
|
+
/** Digital wallet type. */
|
|
21310
|
+
digitalWallet?: ("Apple Pay" | "Google Pay") | null;
|
|
20808
21311
|
/** The links related to resource. */
|
|
20809
21312
|
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
20810
21313
|
Partial<usersComponents["schemas"]["CustomerLink"]> &
|
|
@@ -21441,8 +21944,8 @@ export interface usersComponents {
|
|
|
21441
21944
|
firstName?: number;
|
|
21442
21945
|
/** The weight of lastName. */
|
|
21443
21946
|
lastName?: number;
|
|
21444
|
-
/** The weight of
|
|
21445
|
-
|
|
21947
|
+
/** The weight of `expirationDate`. */
|
|
21948
|
+
expirationDate?: number;
|
|
21446
21949
|
/** The weight of dateOfBirth. */
|
|
21447
21950
|
dateOfBirth?: number;
|
|
21448
21951
|
/** The weight of matchesDateOfBirth. */
|
|
@@ -21492,6 +21995,11 @@ export interface usersComponents {
|
|
|
21492
21995
|
acceptAbove?: number;
|
|
21493
21996
|
};
|
|
21494
21997
|
};
|
|
21998
|
+
/** The settings for score calculation. */
|
|
21999
|
+
KycSettings: {
|
|
22000
|
+
identityProof?: usersComponents["schemas"]["KycSettingsIdentity"];
|
|
22001
|
+
addressProof?: usersComponents["schemas"]["KycSettingsAddress"];
|
|
22002
|
+
};
|
|
21495
22003
|
OrganizationSettings: {
|
|
21496
22004
|
/** The settings for tax calculation. */
|
|
21497
22005
|
defaultTaxCalculator?: {
|
|
@@ -21500,11 +22008,7 @@ export interface usersComponents {
|
|
|
21500
22008
|
/** The rate for flat tax calculation. */
|
|
21501
22009
|
rate?: number | null;
|
|
21502
22010
|
};
|
|
21503
|
-
|
|
21504
|
-
kyc?: {
|
|
21505
|
-
"identity-proof"?: usersComponents["schemas"]["KycSettingsIdentity"];
|
|
21506
|
-
"address-proof"?: usersComponents["schemas"]["KycSettingsAddress"];
|
|
21507
|
-
};
|
|
22011
|
+
kyc?: usersComponents["schemas"]["KycSettings"];
|
|
21508
22012
|
};
|
|
21509
22013
|
Organization: {
|
|
21510
22014
|
/** The organization identifier string. */
|
|
@@ -21754,6 +22258,7 @@ export interface usersComponents {
|
|
|
21754
22258
|
| "Beeline"
|
|
21755
22259
|
| "Belfius-direct-net"
|
|
21756
22260
|
| "bitcoin"
|
|
22261
|
+
| "Bizum"
|
|
21757
22262
|
| "Boleto"
|
|
21758
22263
|
| "cash-deposit"
|
|
21759
22264
|
| "CASHlib"
|
|
@@ -21771,6 +22276,7 @@ export interface usersComponents {
|
|
|
21771
22276
|
| "EPS"
|
|
21772
22277
|
| "ePay.bg"
|
|
21773
22278
|
| "eZeeWallet"
|
|
22279
|
+
| "FasterPay"
|
|
21774
22280
|
| "Flexepin"
|
|
21775
22281
|
| "Giropay"
|
|
21776
22282
|
| "Gpaysafe"
|
|
@@ -23104,6 +23610,16 @@ export interface usersComponents {
|
|
|
23104
23610
|
/** Email. */
|
|
23105
23611
|
email: string;
|
|
23106
23612
|
};
|
|
23613
|
+
ValidationErrorExtensions: {
|
|
23614
|
+
invalidFields?: {
|
|
23615
|
+
/** The field name. Dot notation is used for nested object field names. */
|
|
23616
|
+
field?: string;
|
|
23617
|
+
message?: string;
|
|
23618
|
+
}[];
|
|
23619
|
+
};
|
|
23620
|
+
/** Invalid data was sent. */
|
|
23621
|
+
InvalidError: usersComponents["schemas"]["Error"] &
|
|
23622
|
+
usersComponents["schemas"]["ValidationErrorExtensions"];
|
|
23107
23623
|
GatewayAccountDowntimeSchedule: {
|
|
23108
23624
|
/** The gateway account downtime schedule identifier string. */
|
|
23109
23625
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
@@ -23551,6 +24067,7 @@ export interface usersComponents {
|
|
|
23551
24067
|
| "kyc-document-modified"
|
|
23552
24068
|
| "kyc-document-rejected"
|
|
23553
24069
|
| "kyc-document-reviewed"
|
|
24070
|
+
| "kyc-request-fulfilled"
|
|
23554
24071
|
| "lead-source-changed"
|
|
23555
24072
|
| "nsf-response-received"
|
|
23556
24073
|
| "offsite-payment-completed"
|
|
@@ -23945,31 +24462,31 @@ export interface usersComponents {
|
|
|
23945
24462
|
/** Unauthorized access, invalid credentials were used. */
|
|
23946
24463
|
Unauthorized: {
|
|
23947
24464
|
content: {
|
|
23948
|
-
"application/json": usersComponents["schemas"]["
|
|
24465
|
+
"application/json": usersComponents["schemas"]["Unauthorized"];
|
|
23949
24466
|
};
|
|
23950
24467
|
};
|
|
23951
24468
|
/** Access forbidden. */
|
|
23952
24469
|
Forbidden: {
|
|
23953
24470
|
content: {
|
|
23954
|
-
"application/json": usersComponents["schemas"]["
|
|
24471
|
+
"application/json": usersComponents["schemas"]["Forbidden"];
|
|
23955
24472
|
};
|
|
23956
24473
|
};
|
|
23957
24474
|
/** Conflict. */
|
|
23958
24475
|
Conflict: {
|
|
23959
24476
|
content: {
|
|
23960
|
-
"application/json": usersComponents["schemas"]["
|
|
24477
|
+
"application/json": usersComponents["schemas"]["Conflict"];
|
|
23961
24478
|
};
|
|
23962
24479
|
};
|
|
23963
24480
|
/** Invalid data was sent. */
|
|
23964
24481
|
ValidationError: {
|
|
23965
24482
|
content: {
|
|
23966
|
-
"application/json": usersComponents["schemas"]["
|
|
24483
|
+
"application/json": usersComponents["schemas"]["ValidationError"];
|
|
23967
24484
|
};
|
|
23968
24485
|
};
|
|
23969
24486
|
/** Resource was not found. */
|
|
23970
24487
|
NotFound: {
|
|
23971
24488
|
content: {
|
|
23972
|
-
"application/json": usersComponents["schemas"]["
|
|
24489
|
+
"application/json": usersComponents["schemas"]["NotFound"];
|
|
23973
24490
|
};
|
|
23974
24491
|
};
|
|
23975
24492
|
};
|
|
@@ -24462,12 +24979,7 @@ export interface operations {
|
|
|
24462
24979
|
responses: {
|
|
24463
24980
|
/** User account was activated. */
|
|
24464
24981
|
204: never;
|
|
24465
|
-
|
|
24466
|
-
422: {
|
|
24467
|
-
content: {
|
|
24468
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
24469
|
-
};
|
|
24470
|
-
};
|
|
24982
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
24471
24983
|
};
|
|
24472
24984
|
};
|
|
24473
24985
|
/** Retrieve a list of API keys. */
|
|
@@ -24505,12 +25017,7 @@ export interface operations {
|
|
|
24505
25017
|
};
|
|
24506
25018
|
401: usersComponents["responses"]["Unauthorized"];
|
|
24507
25019
|
403: usersComponents["responses"]["Forbidden"];
|
|
24508
|
-
|
|
24509
|
-
422: {
|
|
24510
|
-
content: {
|
|
24511
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
24512
|
-
};
|
|
24513
|
-
};
|
|
25020
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
24514
25021
|
};
|
|
24515
25022
|
requestBody: usersComponents["requestBodies"]["ApiKey"];
|
|
24516
25023
|
};
|
|
@@ -24576,12 +25083,7 @@ export interface operations {
|
|
|
24576
25083
|
401: usersComponents["responses"]["Unauthorized"];
|
|
24577
25084
|
403: usersComponents["responses"]["Forbidden"];
|
|
24578
25085
|
404: usersComponents["responses"]["NotFound"];
|
|
24579
|
-
|
|
24580
|
-
409: {
|
|
24581
|
-
content: {
|
|
24582
|
-
"application/json": usersComponents["schemas"]["Error"];
|
|
24583
|
-
};
|
|
24584
|
-
};
|
|
25086
|
+
409: usersComponents["responses"]["Conflict"];
|
|
24585
25087
|
};
|
|
24586
25088
|
};
|
|
24587
25089
|
/**
|
|
@@ -26309,12 +26811,7 @@ export interface operations {
|
|
|
26309
26811
|
401: usersComponents["responses"]["Unauthorized"];
|
|
26310
26812
|
403: usersComponents["responses"]["Forbidden"];
|
|
26311
26813
|
404: usersComponents["responses"]["NotFound"];
|
|
26312
|
-
|
|
26313
|
-
422: {
|
|
26314
|
-
content: {
|
|
26315
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
26316
|
-
};
|
|
26317
|
-
};
|
|
26814
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
26318
26815
|
};
|
|
26319
26816
|
requestBody: usersComponents["requestBodies"]["RuleSet"];
|
|
26320
26817
|
};
|
|
@@ -26604,12 +27101,7 @@ export interface operations {
|
|
|
26604
27101
|
401: usersComponents["responses"]["Unauthorized"];
|
|
26605
27102
|
403: usersComponents["responses"]["Forbidden"];
|
|
26606
27103
|
404: usersComponents["responses"]["NotFound"];
|
|
26607
|
-
|
|
26608
|
-
422: {
|
|
26609
|
-
content: {
|
|
26610
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
26611
|
-
};
|
|
26612
|
-
};
|
|
27104
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
26613
27105
|
};
|
|
26614
27106
|
requestBody: usersComponents["requestBodies"]["RuleSetDraft"];
|
|
26615
27107
|
};
|
|
@@ -26664,12 +27156,7 @@ export interface operations {
|
|
|
26664
27156
|
401: usersComponents["responses"]["Unauthorized"];
|
|
26665
27157
|
403: usersComponents["responses"]["Forbidden"];
|
|
26666
27158
|
404: usersComponents["responses"]["NotFound"];
|
|
26667
|
-
|
|
26668
|
-
422: {
|
|
26669
|
-
content: {
|
|
26670
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
26671
|
-
};
|
|
26672
|
-
};
|
|
27159
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
26673
27160
|
};
|
|
26674
27161
|
requestBody: usersComponents["requestBodies"]["RuleSetDraft"];
|
|
26675
27162
|
};
|
|
@@ -26695,12 +27182,7 @@ export interface operations {
|
|
|
26695
27182
|
responses: {
|
|
26696
27183
|
/** Email sent successfully. */
|
|
26697
27184
|
204: never;
|
|
26698
|
-
|
|
26699
|
-
422: {
|
|
26700
|
-
content: {
|
|
26701
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
26702
|
-
};
|
|
26703
|
-
};
|
|
27185
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
26704
27186
|
};
|
|
26705
27187
|
/** Forgot password resource. */
|
|
26706
27188
|
requestBody: {
|
|
@@ -26807,12 +27289,7 @@ export interface operations {
|
|
|
26807
27289
|
401: usersComponents["responses"]["Unauthorized"];
|
|
26808
27290
|
403: usersComponents["responses"]["Forbidden"];
|
|
26809
27291
|
404: usersComponents["responses"]["NotFound"];
|
|
26810
|
-
|
|
26811
|
-
422: {
|
|
26812
|
-
content: {
|
|
26813
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
26814
|
-
};
|
|
26815
|
-
};
|
|
27292
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
26816
27293
|
};
|
|
26817
27294
|
requestBody: usersComponents["requestBodies"]["GatewayAccount"];
|
|
26818
27295
|
};
|
|
@@ -26851,12 +27328,7 @@ export interface operations {
|
|
|
26851
27328
|
401: usersComponents["responses"]["Unauthorized"];
|
|
26852
27329
|
403: usersComponents["responses"]["Forbidden"];
|
|
26853
27330
|
404: usersComponents["responses"]["NotFound"];
|
|
26854
|
-
|
|
26855
|
-
422: {
|
|
26856
|
-
content: {
|
|
26857
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
26858
|
-
};
|
|
26859
|
-
};
|
|
27331
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
26860
27332
|
};
|
|
26861
27333
|
requestBody: usersComponents["requestBodies"]["GatewayAccount"];
|
|
26862
27334
|
};
|
|
@@ -26961,12 +27433,7 @@ export interface operations {
|
|
|
26961
27433
|
401: usersComponents["responses"]["Unauthorized"];
|
|
26962
27434
|
403: usersComponents["responses"]["Forbidden"];
|
|
26963
27435
|
409: usersComponents["responses"]["Conflict"];
|
|
26964
|
-
|
|
26965
|
-
422: {
|
|
26966
|
-
content: {
|
|
26967
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
26968
|
-
};
|
|
26969
|
-
};
|
|
27436
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
26970
27437
|
};
|
|
26971
27438
|
requestBody: usersComponents["requestBodies"]["GatewayAccountDowntimeSchedule"];
|
|
26972
27439
|
};
|
|
@@ -27013,12 +27480,7 @@ export interface operations {
|
|
|
27013
27480
|
403: usersComponents["responses"]["Forbidden"];
|
|
27014
27481
|
404: usersComponents["responses"]["NotFound"];
|
|
27015
27482
|
409: usersComponents["responses"]["Conflict"];
|
|
27016
|
-
|
|
27017
|
-
422: {
|
|
27018
|
-
content: {
|
|
27019
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
27020
|
-
};
|
|
27021
|
-
};
|
|
27483
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
27022
27484
|
};
|
|
27023
27485
|
requestBody: usersComponents["requestBodies"]["GatewayAccountDowntimeSchedule"];
|
|
27024
27486
|
};
|
|
@@ -27135,12 +27597,7 @@ export interface operations {
|
|
|
27135
27597
|
403: usersComponents["responses"]["Forbidden"];
|
|
27136
27598
|
404: usersComponents["responses"]["NotFound"];
|
|
27137
27599
|
409: usersComponents["responses"]["Conflict"];
|
|
27138
|
-
|
|
27139
|
-
422: {
|
|
27140
|
-
content: {
|
|
27141
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
27142
|
-
};
|
|
27143
|
-
};
|
|
27600
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
27144
27601
|
};
|
|
27145
27602
|
requestBody: {
|
|
27146
27603
|
content: {
|
|
@@ -27223,12 +27680,7 @@ export interface operations {
|
|
|
27223
27680
|
};
|
|
27224
27681
|
401: usersComponents["responses"]["Unauthorized"];
|
|
27225
27682
|
403: usersComponents["responses"]["Forbidden"];
|
|
27226
|
-
|
|
27227
|
-
422: {
|
|
27228
|
-
content: {
|
|
27229
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
27230
|
-
};
|
|
27231
|
-
};
|
|
27683
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
27232
27684
|
};
|
|
27233
27685
|
/** Gateway Account Timeline resource. */
|
|
27234
27686
|
requestBody: {
|
|
@@ -27342,12 +27794,7 @@ export interface operations {
|
|
|
27342
27794
|
401: usersComponents["responses"]["Unauthorized"];
|
|
27343
27795
|
403: usersComponents["responses"]["Forbidden"];
|
|
27344
27796
|
404: usersComponents["responses"]["NotFound"];
|
|
27345
|
-
|
|
27346
|
-
422: {
|
|
27347
|
-
content: {
|
|
27348
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
27349
|
-
};
|
|
27350
|
-
};
|
|
27797
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
27351
27798
|
};
|
|
27352
27799
|
requestBody: {
|
|
27353
27800
|
content: {
|
|
@@ -27470,12 +27917,7 @@ export interface operations {
|
|
|
27470
27917
|
"application/json": usersComponents["schemas"]["Segment"];
|
|
27471
27918
|
};
|
|
27472
27919
|
};
|
|
27473
|
-
|
|
27474
|
-
403: {
|
|
27475
|
-
content: {
|
|
27476
|
-
"application/json": usersComponents["schemas"]["Error"];
|
|
27477
|
-
};
|
|
27478
|
-
};
|
|
27920
|
+
403: usersComponents["responses"]["Forbidden"];
|
|
27479
27921
|
404: usersComponents["responses"]["NotFound"];
|
|
27480
27922
|
422: usersComponents["responses"]["ValidationError"];
|
|
27481
27923
|
};
|
|
@@ -27496,12 +27938,7 @@ export interface operations {
|
|
|
27496
27938
|
responses: {
|
|
27497
27939
|
/** Segment was deleted successfully. */
|
|
27498
27940
|
204: never;
|
|
27499
|
-
|
|
27500
|
-
403: {
|
|
27501
|
-
content: {
|
|
27502
|
-
"application/json": usersComponents["schemas"]["Error"];
|
|
27503
|
-
};
|
|
27504
|
-
};
|
|
27941
|
+
403: usersComponents["responses"]["Forbidden"];
|
|
27505
27942
|
404: usersComponents["responses"]["NotFound"];
|
|
27506
27943
|
};
|
|
27507
27944
|
};
|
|
@@ -27584,12 +28021,7 @@ export interface operations {
|
|
|
27584
28021
|
};
|
|
27585
28022
|
401: usersComponents["responses"]["Unauthorized"];
|
|
27586
28023
|
403: usersComponents["responses"]["Forbidden"];
|
|
27587
|
-
|
|
27588
|
-
422: {
|
|
27589
|
-
content: {
|
|
27590
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
27591
|
-
};
|
|
27592
|
-
};
|
|
28024
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
27593
28025
|
};
|
|
27594
28026
|
requestBody: usersComponents["requestBodies"]["List"];
|
|
27595
28027
|
};
|
|
@@ -27843,17 +28275,12 @@ export interface operations {
|
|
|
27843
28275
|
};
|
|
27844
28276
|
401: usersComponents["responses"]["Unauthorized"];
|
|
27845
28277
|
403: usersComponents["responses"]["Forbidden"];
|
|
27846
|
-
|
|
27847
|
-
409: {
|
|
27848
|
-
content: {
|
|
27849
|
-
"application/json": usersComponents["schemas"]["Error"];
|
|
27850
|
-
};
|
|
27851
|
-
};
|
|
28278
|
+
409: usersComponents["responses"]["Conflict"];
|
|
27852
28279
|
422: usersComponents["responses"]["ValidationError"];
|
|
27853
28280
|
};
|
|
27854
28281
|
requestBody: usersComponents["requestBodies"]["PostOrganization"];
|
|
27855
28282
|
};
|
|
27856
|
-
/** Retrieve
|
|
28283
|
+
/** Retrieve an organization with specified identifier string. */
|
|
27857
28284
|
GetOrganization: {
|
|
27858
28285
|
parameters: {
|
|
27859
28286
|
path: {
|
|
@@ -27992,12 +28419,7 @@ export interface operations {
|
|
|
27992
28419
|
};
|
|
27993
28420
|
401: usersComponents["responses"]["Unauthorized"];
|
|
27994
28421
|
403: usersComponents["responses"]["Forbidden"];
|
|
27995
|
-
|
|
27996
|
-
422: {
|
|
27997
|
-
content: {
|
|
27998
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
27999
|
-
};
|
|
28000
|
-
};
|
|
28422
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28001
28423
|
};
|
|
28002
28424
|
requestBody: {
|
|
28003
28425
|
content: {
|
|
@@ -28037,12 +28459,7 @@ export interface operations {
|
|
|
28037
28459
|
};
|
|
28038
28460
|
401: usersComponents["responses"]["Unauthorized"];
|
|
28039
28461
|
403: usersComponents["responses"]["Forbidden"];
|
|
28040
|
-
|
|
28041
|
-
422: {
|
|
28042
|
-
content: {
|
|
28043
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
28044
|
-
};
|
|
28045
|
-
};
|
|
28462
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28046
28463
|
};
|
|
28047
28464
|
/** Test email resource. */
|
|
28048
28465
|
requestBody: {
|
|
@@ -28062,12 +28479,7 @@ export interface operations {
|
|
|
28062
28479
|
};
|
|
28063
28480
|
401: usersComponents["responses"]["Unauthorized"];
|
|
28064
28481
|
403: usersComponents["responses"]["Forbidden"];
|
|
28065
|
-
|
|
28066
|
-
422: {
|
|
28067
|
-
content: {
|
|
28068
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
28069
|
-
};
|
|
28070
|
-
};
|
|
28482
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28071
28483
|
};
|
|
28072
28484
|
/** Test webhook resource. */
|
|
28073
28485
|
requestBody: {
|
|
@@ -28225,12 +28637,7 @@ export interface operations {
|
|
|
28225
28637
|
"application/json": usersComponents["schemas"]["User"];
|
|
28226
28638
|
};
|
|
28227
28639
|
};
|
|
28228
|
-
|
|
28229
|
-
422: {
|
|
28230
|
-
content: {
|
|
28231
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
28232
|
-
};
|
|
28233
|
-
};
|
|
28640
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28234
28641
|
};
|
|
28235
28642
|
/** ResetPassword resource. */
|
|
28236
28643
|
requestBody: {
|
|
@@ -28403,12 +28810,7 @@ export interface operations {
|
|
|
28403
28810
|
};
|
|
28404
28811
|
401: usersComponents["responses"]["Unauthorized"];
|
|
28405
28812
|
403: usersComponents["responses"]["Forbidden"];
|
|
28406
|
-
|
|
28407
|
-
422: {
|
|
28408
|
-
content: {
|
|
28409
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
28410
|
-
};
|
|
28411
|
-
};
|
|
28813
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28412
28814
|
};
|
|
28413
28815
|
/** Signin resource. */
|
|
28414
28816
|
requestBody: {
|
|
@@ -28426,12 +28828,7 @@ export interface operations {
|
|
|
28426
28828
|
"application/json": usersComponents["schemas"]["User"];
|
|
28427
28829
|
};
|
|
28428
28830
|
};
|
|
28429
|
-
|
|
28430
|
-
422: {
|
|
28431
|
-
content: {
|
|
28432
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
28433
|
-
};
|
|
28434
|
-
};
|
|
28831
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28435
28832
|
};
|
|
28436
28833
|
/** Signup resource. */
|
|
28437
28834
|
requestBody: {
|
|
@@ -28644,12 +29041,7 @@ export interface operations {
|
|
|
28644
29041
|
};
|
|
28645
29042
|
401: usersComponents["responses"]["Unauthorized"];
|
|
28646
29043
|
403: usersComponents["responses"]["Forbidden"];
|
|
28647
|
-
|
|
28648
|
-
422: {
|
|
28649
|
-
content: {
|
|
28650
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
28651
|
-
};
|
|
28652
|
-
};
|
|
29044
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28653
29045
|
};
|
|
28654
29046
|
requestBody: usersComponents["requestBodies"]["User"];
|
|
28655
29047
|
};
|
|
@@ -28780,12 +29172,7 @@ export interface operations {
|
|
|
28780
29172
|
};
|
|
28781
29173
|
401: usersComponents["responses"]["Unauthorized"];
|
|
28782
29174
|
403: usersComponents["responses"]["Forbidden"];
|
|
28783
|
-
|
|
28784
|
-
422: {
|
|
28785
|
-
content: {
|
|
28786
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
28787
|
-
};
|
|
28788
|
-
};
|
|
29175
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28789
29176
|
};
|
|
28790
29177
|
requestBody: usersComponents["requestBodies"]["GlobalWebhook"];
|
|
28791
29178
|
};
|
|
@@ -28884,12 +29271,7 @@ export interface operations {
|
|
|
28884
29271
|
};
|
|
28885
29272
|
401: usersComponents["responses"]["Unauthorized"];
|
|
28886
29273
|
403: usersComponents["responses"]["Forbidden"];
|
|
28887
|
-
|
|
28888
|
-
422: {
|
|
28889
|
-
content: {
|
|
28890
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
28891
|
-
};
|
|
28892
|
-
};
|
|
29274
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28893
29275
|
};
|
|
28894
29276
|
requestBody: usersComponents["requestBodies"]["Website"];
|
|
28895
29277
|
};
|
|
@@ -28937,12 +29319,7 @@ export interface operations {
|
|
|
28937
29319
|
401: usersComponents["responses"]["Unauthorized"];
|
|
28938
29320
|
403: usersComponents["responses"]["Forbidden"];
|
|
28939
29321
|
404: usersComponents["responses"]["NotFound"];
|
|
28940
|
-
|
|
28941
|
-
422: {
|
|
28942
|
-
content: {
|
|
28943
|
-
"application/json": usersComponents["schemas"]["InvalidError"];
|
|
28944
|
-
};
|
|
28945
|
-
};
|
|
29322
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
28946
29323
|
};
|
|
28947
29324
|
requestBody: usersComponents["requestBodies"]["Website"];
|
|
28948
29325
|
};
|
|
@@ -28960,8 +29337,7 @@ export interface operations {
|
|
|
28960
29337
|
401: usersComponents["responses"]["Unauthorized"];
|
|
28961
29338
|
403: usersComponents["responses"]["Forbidden"];
|
|
28962
29339
|
404: usersComponents["responses"]["NotFound"];
|
|
28963
|
-
|
|
28964
|
-
409: unknown;
|
|
29340
|
+
409: usersComponents["responses"]["Conflict"];
|
|
28965
29341
|
};
|
|
28966
29342
|
};
|
|
28967
29343
|
}
|
|
@@ -29285,35 +29661,42 @@ export interface storefrontComponents {
|
|
|
29285
29661
|
/** Read-only timestamp, automatically assigned on back-end. */
|
|
29286
29662
|
ServerTimestamp: string;
|
|
29287
29663
|
/** The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)]. */
|
|
29288
|
-
|
|
29289
|
-
/** The HTTP status code. */
|
|
29290
|
-
status?: number;
|
|
29291
|
-
/** A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
|
|
29292
|
-
title?: string;
|
|
29293
|
-
} & { [key: string]: any };
|
|
29294
|
-
DocumentedProblem: {
|
|
29664
|
+
BaseProblem: {
|
|
29295
29665
|
/** A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". */
|
|
29296
29666
|
type?: string;
|
|
29297
|
-
|
|
29298
|
-
|
|
29667
|
+
/** A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */
|
|
29668
|
+
title?: string;
|
|
29299
29669
|
/** A human-readable explanation specific to this occurrence of the problem. */
|
|
29300
29670
|
detail?: string;
|
|
29301
|
-
|
|
29302
|
-
|
|
29303
|
-
|
|
29304
|
-
|
|
29305
|
-
|
|
29306
|
-
|
|
29307
|
-
|
|
29308
|
-
|
|
29309
|
-
|
|
29310
|
-
|
|
29311
|
-
|
|
29312
|
-
|
|
29313
|
-
|
|
29314
|
-
|
|
29315
|
-
|
|
29316
|
-
|
|
29671
|
+
/** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
|
|
29672
|
+
instance?: string;
|
|
29673
|
+
} & { [key: string]: any };
|
|
29674
|
+
Unauthorized: { [key: string]: any } & {
|
|
29675
|
+
/** The HTTP status code. */
|
|
29676
|
+
status?: number;
|
|
29677
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
29678
|
+
Forbidden: { [key: string]: any } & {
|
|
29679
|
+
/** The HTTP status code. */
|
|
29680
|
+
status?: number;
|
|
29681
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
29682
|
+
Conflict: { [key: string]: any } & {
|
|
29683
|
+
/** The HTTP status code. */
|
|
29684
|
+
status?: number;
|
|
29685
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
29686
|
+
ValidationError: { [key: string]: any } & {
|
|
29687
|
+
/** The HTTP status code. */
|
|
29688
|
+
status?: number;
|
|
29689
|
+
} & storefrontComponents["schemas"]["BaseProblem"] & {
|
|
29690
|
+
invalidFields?: {
|
|
29691
|
+
/** The field name. Dot notation is used for nested object field names. */
|
|
29692
|
+
field?: string;
|
|
29693
|
+
message?: string;
|
|
29694
|
+
}[];
|
|
29695
|
+
};
|
|
29696
|
+
NotFound: {
|
|
29697
|
+
/** The HTTP status code. */
|
|
29698
|
+
status?: number;
|
|
29699
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
29317
29700
|
CustomerLink: storefrontComponents["schemas"]["Link"] & {
|
|
29318
29701
|
/** The link type. */
|
|
29319
29702
|
rel: "customer" | "targetCustomer";
|
|
@@ -29689,6 +30072,8 @@ export interface storefrontComponents {
|
|
|
29689
30072
|
* The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
|
|
29690
30073
|
*/
|
|
29691
30074
|
revision?: number;
|
|
30075
|
+
/** Indicates if EDD is enabled for this customer. */
|
|
30076
|
+
isEddRequired: boolean;
|
|
29692
30077
|
/** The links related to resource. */
|
|
29693
30078
|
_links?: (Partial<storefrontComponents["schemas"]["SelfLink"]> &
|
|
29694
30079
|
Partial<storefrontComponents["schemas"]["DefaultPaymentInstrumentLink"]> &
|
|
@@ -29720,6 +30105,7 @@ export interface storefrontComponents {
|
|
|
29720
30105
|
/** The payment gateway name. */
|
|
29721
30106
|
GatewayName:
|
|
29722
30107
|
| "A1Gateway"
|
|
30108
|
+
| "ACI"
|
|
29723
30109
|
| "Adyen"
|
|
29724
30110
|
| "Airpay"
|
|
29725
30111
|
| "AmazonPay"
|
|
@@ -29770,6 +30156,7 @@ export interface storefrontComponents {
|
|
|
29770
30156
|
| "EPro"
|
|
29771
30157
|
| "eZeeWallet"
|
|
29772
30158
|
| "ezyEFT"
|
|
30159
|
+
| "FasterPay"
|
|
29773
30160
|
| "Finrax"
|
|
29774
30161
|
| "Flexepin"
|
|
29775
30162
|
| "FinTecSystems"
|
|
@@ -29868,7 +30255,6 @@ export interface storefrontComponents {
|
|
|
29868
30255
|
| "TestProcessor"
|
|
29869
30256
|
| "ToditoCash"
|
|
29870
30257
|
| "Truevo"
|
|
29871
|
-
| "TrustPay"
|
|
29872
30258
|
| "TrustsPay"
|
|
29873
30259
|
| "Trustly"
|
|
29874
30260
|
| "TWINT"
|
|
@@ -30004,6 +30390,8 @@ export interface storefrontComponents {
|
|
|
30004
30390
|
kountFraudSessionId?: string;
|
|
30005
30391
|
/** MerchantSessionID as generated by the PayPal Fraudnet SDK. */
|
|
30006
30392
|
payPalMerchantSessionId?: string;
|
|
30393
|
+
/** A temporary identifier that is unique to the visitor's session and passed to ThreatMetrix. */
|
|
30394
|
+
threatMetrixSessionId?: string;
|
|
30007
30395
|
};
|
|
30008
30396
|
/** Risk metadata used for 3DS and risk scoring. */
|
|
30009
30397
|
RiskMetadata: {
|
|
@@ -30135,6 +30523,8 @@ export interface storefrontComponents {
|
|
|
30135
30523
|
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
30136
30524
|
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
30137
30525
|
useAsBackup: boolean;
|
|
30526
|
+
/** URL to the billing portal where the card can be updated. */
|
|
30527
|
+
billingPortalUrl?: string;
|
|
30138
30528
|
/** Payment instrument created time. */
|
|
30139
30529
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
30140
30530
|
/** Payment instrument updated time. */
|
|
@@ -30712,7 +31102,8 @@ export interface storefrontComponents {
|
|
|
30712
31102
|
| "identity-proof"
|
|
30713
31103
|
| "address-proof"
|
|
30714
31104
|
| "funds-proof"
|
|
30715
|
-
| "purchase-proof"
|
|
31105
|
+
| "purchase-proof"
|
|
31106
|
+
| "credit-file-proof";
|
|
30716
31107
|
KycDocumentSubtypes:
|
|
30717
31108
|
| "passport"
|
|
30718
31109
|
| "id-card"
|
|
@@ -30735,13 +31126,59 @@ export interface storefrontComponents {
|
|
|
30735
31126
|
| "ewallet-holder-details"
|
|
30736
31127
|
| "ewallet-transaction-statement"
|
|
30737
31128
|
| "other";
|
|
31129
|
+
CommonKycRequest: {
|
|
31130
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
31131
|
+
/** Documents to be requested from customer. */
|
|
31132
|
+
documents: {
|
|
31133
|
+
/** Document type to be requested from customer. */
|
|
31134
|
+
type: storefrontComponents["schemas"]["KycDocumentTypes"];
|
|
31135
|
+
/** Document subtype allowed for customer. */
|
|
31136
|
+
subtypes?: storefrontComponents["schemas"]["KycDocumentSubtypes"][];
|
|
31137
|
+
/** The number of document upload attempts. `0` treated as unlimited. */
|
|
31138
|
+
maxAttempts: number;
|
|
31139
|
+
/** If `true` uploading matching face photo (selfie) is required. */
|
|
31140
|
+
faceProofRequired?: boolean;
|
|
31141
|
+
}[];
|
|
31142
|
+
/** Status of the request. */
|
|
31143
|
+
status?:
|
|
31144
|
+
| "gathering"
|
|
31145
|
+
| "attempted"
|
|
31146
|
+
| "partial"
|
|
31147
|
+
| "pending-review"
|
|
31148
|
+
| "fulfilled"
|
|
31149
|
+
| "failed"
|
|
31150
|
+
| "abandoned"
|
|
31151
|
+
| "expired";
|
|
31152
|
+
/**
|
|
31153
|
+
* The URL to redirect the customer when an upload is completed.
|
|
31154
|
+
* 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`):
|
|
31155
|
+
*
|
|
31156
|
+
* - **back** - The customer clicked the `back to website` link;
|
|
31157
|
+
* - **token_expired** - The customer's token expired;
|
|
31158
|
+
* - **success** - The customer uploaded docs that were successfully analyzed;
|
|
31159
|
+
* - **manual** - The customer uploaded docs that will require manual review because the analyzer rejected them or couldn't process them;
|
|
31160
|
+
* - **partial** - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
|
|
31161
|
+
*/
|
|
31162
|
+
redirectUrl?: string;
|
|
31163
|
+
/** Expiration date-time. Default value is one hour in the future. */
|
|
31164
|
+
expirationTime?: string;
|
|
31165
|
+
/** Creation date-time. */
|
|
31166
|
+
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
31167
|
+
/** Latest update date-time. */
|
|
31168
|
+
updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
31169
|
+
};
|
|
31170
|
+
KycDocumentsLink: storefrontComponents["schemas"]["Link"] & {
|
|
31171
|
+
/** The link type. */
|
|
31172
|
+
rel: "kycDocuments";
|
|
31173
|
+
};
|
|
31174
|
+
KycDocumentRejectionReasonTypes:
|
|
31175
|
+
| "document-unreadable"
|
|
31176
|
+
| "document-expired"
|
|
31177
|
+
| "document-not-matching"
|
|
31178
|
+
| "underage-person"
|
|
31179
|
+
| "other";
|
|
30738
31180
|
KycDocumentRejection: {
|
|
30739
|
-
type?:
|
|
30740
|
-
| "document-unreadable"
|
|
30741
|
-
| "document-expired"
|
|
30742
|
-
| "document-not-matching"
|
|
30743
|
-
| "underage-person"
|
|
30744
|
-
| "other";
|
|
31181
|
+
type?: storefrontComponents["schemas"]["KycDocumentRejectionReasonTypes"];
|
|
30745
31182
|
/** The rejection message. */
|
|
30746
31183
|
message?: string;
|
|
30747
31184
|
};
|
|
@@ -30760,7 +31197,7 @@ export interface storefrontComponents {
|
|
|
30760
31197
|
/** Document subtype submitted for validation. */
|
|
30761
31198
|
documentSubtype?: storefrontComponents["schemas"]["KycDocumentSubtypes"];
|
|
30762
31199
|
/** Status of the validation. */
|
|
30763
|
-
status: "pending" | "in-progress" | "accepted" | "rejected";
|
|
31200
|
+
status: "pending" | "in-progress" | "accepted" | "rejected" | "archived";
|
|
30764
31201
|
rejectionReason?: storefrontComponents["schemas"]["KycDocumentRejection"];
|
|
30765
31202
|
/** KYC request identifier string. */
|
|
30766
31203
|
requestId?: storefrontComponents["schemas"]["ResourceId"] | null;
|
|
@@ -30788,6 +31225,8 @@ export interface storefrontComponents {
|
|
|
30788
31225
|
dateOfBirth?: string;
|
|
30789
31226
|
/** The expiry date found on the document, null if not found. */
|
|
30790
31227
|
expiryDate?: string;
|
|
31228
|
+
/** The expiration date found on the document, null if not found. */
|
|
31229
|
+
expirationDate?: string;
|
|
30791
31230
|
/** The issued date found on the document, null if not found. */
|
|
30792
31231
|
issueDate?: string;
|
|
30793
31232
|
/** Checks the minimal age, 21+ for USA and 18+ for all other countries. Null if dateOfBirth could not be determined. */
|
|
@@ -30829,42 +31268,29 @@ export interface storefrontComponents {
|
|
|
30829
31268
|
/** The payment instrument related to the document, null otherwise. */
|
|
30830
31269
|
paymentInstrumentId?: string;
|
|
30831
31270
|
};
|
|
30832
|
-
|
|
30833
|
-
|
|
30834
|
-
|
|
30835
|
-
|
|
30836
|
-
|
|
30837
|
-
|
|
30838
|
-
|
|
30839
|
-
|
|
30840
|
-
|
|
30841
|
-
|
|
30842
|
-
|
|
30843
|
-
|
|
30844
|
-
|
|
30845
|
-
/**
|
|
30846
|
-
|
|
30847
|
-
/**
|
|
30848
|
-
|
|
30849
|
-
|
|
30850
|
-
|
|
30851
|
-
|
|
30852
|
-
|
|
30853
|
-
|
|
30854
|
-
|
|
30855
|
-
* - **partial** - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
|
|
30856
|
-
*/
|
|
30857
|
-
redirectUrl?: string;
|
|
30858
|
-
/** Expiration date-time. Default value is one hour in the future. */
|
|
30859
|
-
expirationTime?: string;
|
|
30860
|
-
/** Creation date-time. */
|
|
30861
|
-
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
30862
|
-
/** Latest update date-time. */
|
|
30863
|
-
updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
30864
|
-
};
|
|
30865
|
-
KycDocumentsLink: storefrontComponents["schemas"]["Link"] & {
|
|
30866
|
-
/** The link type. */
|
|
30867
|
-
rel: "kycDocuments";
|
|
31271
|
+
CreditFileMatches: {
|
|
31272
|
+
/** The credit bureau which is used to get credit file data. */
|
|
31273
|
+
creditBureau?: "equifax" | "experian" | "transunion";
|
|
31274
|
+
/** The credit file number on credit bureau. */
|
|
31275
|
+
creditFileNumber?: string;
|
|
31276
|
+
/** Return true if first name is matched otherwise false. */
|
|
31277
|
+
isFirstNameMatched?: boolean;
|
|
31278
|
+
/** Return true if last name is matched otherwise false. */
|
|
31279
|
+
isLastNameMatched?: boolean;
|
|
31280
|
+
/** Return true if address civic number is matched otherwise false. */
|
|
31281
|
+
isCivicNumberMatched?: boolean;
|
|
31282
|
+
/** Return true if street address is matched otherwise false. */
|
|
31283
|
+
isStreetMatched?: boolean;
|
|
31284
|
+
/** Return true if city is matched otherwise false. */
|
|
31285
|
+
isCityMatched?: boolean;
|
|
31286
|
+
/** Return true if postal code is matched otherwise false. */
|
|
31287
|
+
isPostalCodeMatched?: boolean;
|
|
31288
|
+
/** Return true if province is matched otherwise false. */
|
|
31289
|
+
isProvinceMatched?: boolean;
|
|
31290
|
+
/** Return true if date of birth is matched otherwise false. */
|
|
31291
|
+
isDobMatched?: boolean;
|
|
31292
|
+
/** Extra data from credit bureau. */
|
|
31293
|
+
referenceData?: { [key: string]: any };
|
|
30868
31294
|
};
|
|
30869
31295
|
CommonPayPalAccount: {
|
|
30870
31296
|
/** The payment instrument ID. */
|
|
@@ -30911,6 +31337,7 @@ export interface storefrontComponents {
|
|
|
30911
31337
|
| "Beeline"
|
|
30912
31338
|
| "Belfius-direct-net"
|
|
30913
31339
|
| "bitcoin"
|
|
31340
|
+
| "Bizum"
|
|
30914
31341
|
| "Boleto"
|
|
30915
31342
|
| "cash-deposit"
|
|
30916
31343
|
| "CASHlib"
|
|
@@ -30928,6 +31355,7 @@ export interface storefrontComponents {
|
|
|
30928
31355
|
| "EPS"
|
|
30929
31356
|
| "ePay.bg"
|
|
30930
31357
|
| "eZeeWallet"
|
|
31358
|
+
| "FasterPay"
|
|
30931
31359
|
| "Flexepin"
|
|
30932
31360
|
| "Giropay"
|
|
30933
31361
|
| "Gpaysafe"
|
|
@@ -31695,11 +32123,17 @@ export interface storefrontComponents {
|
|
|
31695
32123
|
data?: storefrontComponents["schemas"]["PurchaseMatches"];
|
|
31696
32124
|
};
|
|
31697
32125
|
};
|
|
32126
|
+
"ProofOfCreditFile-2": storefrontComponents["schemas"]["CommonKycDocument"] & {
|
|
32127
|
+
documentMatches?: {
|
|
32128
|
+
data?: storefrontComponents["schemas"]["CreditFileMatches"];
|
|
32129
|
+
};
|
|
32130
|
+
};
|
|
31698
32131
|
StorefrontKycDocument:
|
|
31699
32132
|
| storefrontComponents["schemas"]["ProofOfIdentity-2"]
|
|
31700
32133
|
| storefrontComponents["schemas"]["ProofOfAddress-2"]
|
|
31701
32134
|
| storefrontComponents["schemas"]["ProofOfFunds-2"]
|
|
31702
|
-
| storefrontComponents["schemas"]["ProofOfPurchase-2"]
|
|
32135
|
+
| storefrontComponents["schemas"]["ProofOfPurchase-2"]
|
|
32136
|
+
| storefrontComponents["schemas"]["ProofOfCreditFile-2"];
|
|
31703
32137
|
StorefrontKycRequest: storefrontComponents["schemas"]["CommonKycRequest"] & {
|
|
31704
32138
|
/** The links related to resource. */
|
|
31705
32139
|
_links?: (Partial<storefrontComponents["schemas"]["SelfLink"]> &
|
|
@@ -31825,31 +32259,31 @@ export interface storefrontComponents {
|
|
|
31825
32259
|
/** Unauthorized access, invalid credentials were used. */
|
|
31826
32260
|
Unauthorized: {
|
|
31827
32261
|
content: {
|
|
31828
|
-
"application/json": storefrontComponents["schemas"]["
|
|
32262
|
+
"application/json": storefrontComponents["schemas"]["Unauthorized"];
|
|
31829
32263
|
};
|
|
31830
32264
|
};
|
|
31831
32265
|
/** Access forbidden. */
|
|
31832
32266
|
Forbidden: {
|
|
31833
32267
|
content: {
|
|
31834
|
-
"application/json": storefrontComponents["schemas"]["
|
|
32268
|
+
"application/json": storefrontComponents["schemas"]["Forbidden"];
|
|
31835
32269
|
};
|
|
31836
32270
|
};
|
|
31837
32271
|
/** Conflict. */
|
|
31838
32272
|
Conflict: {
|
|
31839
32273
|
content: {
|
|
31840
|
-
"application/json": storefrontComponents["schemas"]["
|
|
32274
|
+
"application/json": storefrontComponents["schemas"]["Conflict"];
|
|
31841
32275
|
};
|
|
31842
32276
|
};
|
|
31843
32277
|
/** Invalid data was sent. */
|
|
31844
32278
|
ValidationError: {
|
|
31845
32279
|
content: {
|
|
31846
|
-
"application/json": storefrontComponents["schemas"]["
|
|
32280
|
+
"application/json": storefrontComponents["schemas"]["ValidationError"];
|
|
31847
32281
|
};
|
|
31848
32282
|
};
|
|
31849
32283
|
/** Resource was not found. */
|
|
31850
32284
|
NotFound: {
|
|
31851
32285
|
content: {
|
|
31852
|
-
"application/json": storefrontComponents["schemas"]["
|
|
32286
|
+
"application/json": storefrontComponents["schemas"]["NotFound"];
|
|
31853
32287
|
};
|
|
31854
32288
|
};
|
|
31855
32289
|
};
|
|
@@ -32645,12 +33079,7 @@ export interface operations {
|
|
|
32645
33079
|
};
|
|
32646
33080
|
401: storefrontComponents["responses"]["Unauthorized"];
|
|
32647
33081
|
403: storefrontComponents["responses"]["Forbidden"];
|
|
32648
|
-
|
|
32649
|
-
404: {
|
|
32650
|
-
content: {
|
|
32651
|
-
"application/json": storefrontComponents["schemas"]["Error"];
|
|
32652
|
-
};
|
|
32653
|
-
};
|
|
33082
|
+
404: storefrontComponents["responses"]["NotFound"];
|
|
32654
33083
|
};
|
|
32655
33084
|
};
|
|
32656
33085
|
/**
|
|
@@ -33569,6 +33998,7 @@ declare module "resources/customers-resource" {
|
|
|
33569
33998
|
id: any;
|
|
33570
33999
|
targetCustomerId: any;
|
|
33571
34000
|
}): any;
|
|
34001
|
+
getAml({ id }: rebilly.GetCustomerAmlEntryCollectionRequest): rebilly.GetCustomerAmlEntryCollectionResponsePromise;
|
|
33572
34002
|
getLeadSource({ id }: {
|
|
33573
34003
|
id: any;
|
|
33574
34004
|
}): rebilly.GetCustomerLeadSourceResponsePromise;
|
|
@@ -33597,6 +34027,21 @@ declare module "resources/customers-resource" {
|
|
|
33597
34027
|
messageId: any;
|
|
33598
34028
|
}): any;
|
|
33599
34029
|
getAllUpcomingInvoices({ id, expand }: rebilly.GetCustomerUpcomingInvoiceCollectionRequest): rebilly.GetCustomerUpcomingInvoiceCollectionResponsePromise;
|
|
34030
|
+
getCustomerEddScore({ id }: {
|
|
34031
|
+
id: any;
|
|
34032
|
+
}): rebilly.GetCustomerEddScoreResponsePromise;
|
|
34033
|
+
patchCustomerEddScore({ id, data }: {
|
|
34034
|
+
id: any;
|
|
34035
|
+
data: any;
|
|
34036
|
+
}): any;
|
|
34037
|
+
getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.GetEddTimelineCollectionRequest): rebilly.GetEddTimelineCollectionResponsePromise;
|
|
34038
|
+
createEddTimelineComment({ id, data }: {
|
|
34039
|
+
id: any;
|
|
34040
|
+
data: any;
|
|
34041
|
+
}): any;
|
|
34042
|
+
GetEddSearchResults({ id }: {
|
|
34043
|
+
id: any;
|
|
34044
|
+
}): rebilly.GetEddSearchResultsResponsePromise;
|
|
33600
34045
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
33601
34046
|
limit?: any;
|
|
33602
34047
|
offset?: any;
|
|
@@ -33614,6 +34059,9 @@ declare module "resources/digital-wallets-resource" {
|
|
|
33614
34059
|
create({ data }: {
|
|
33615
34060
|
data: any;
|
|
33616
34061
|
}): any;
|
|
34062
|
+
validate({ data }: {
|
|
34063
|
+
data: any;
|
|
34064
|
+
}): any;
|
|
33617
34065
|
};
|
|
33618
34066
|
}
|
|
33619
34067
|
declare module "resources/disputes-resource" {
|
|
@@ -33859,6 +34307,7 @@ declare module "resources/files-resource" {
|
|
|
33859
34307
|
name?: string;
|
|
33860
34308
|
extension?: string;
|
|
33861
34309
|
description?: string;
|
|
34310
|
+
sourceType?: "camera" | "upload";
|
|
33862
34311
|
tags?: string[];
|
|
33863
34312
|
mime?: "image/png" | "image/jpeg" | "image/gif" | "application/pdf" | "audio/mpeg";
|
|
33864
34313
|
size?: number;
|
|
@@ -34132,6 +34581,15 @@ declare module "resources/kyc-requests-resource" {
|
|
|
34132
34581
|
}): any;
|
|
34133
34582
|
};
|
|
34134
34583
|
}
|
|
34584
|
+
declare module "resources/kyc-settings-resource" {
|
|
34585
|
+
export default function KycSettingsResource({ apiHandler }: {
|
|
34586
|
+
apiHandler: any;
|
|
34587
|
+
}): {
|
|
34588
|
+
updateKycSettings({ data }: {
|
|
34589
|
+
data: any;
|
|
34590
|
+
}): rebilly.PutKycSettingsResponsePromise;
|
|
34591
|
+
};
|
|
34592
|
+
}
|
|
34135
34593
|
declare module "resources/lists-resource" {
|
|
34136
34594
|
export default function ListsResource({ apiHandler }: {
|
|
34137
34595
|
apiHandler: any;
|
|
@@ -34281,6 +34739,9 @@ declare module "resources/previews-resource" {
|
|
|
34281
34739
|
webhook({ data }: {
|
|
34282
34740
|
data: any;
|
|
34283
34741
|
}): any;
|
|
34742
|
+
order({ data }: {
|
|
34743
|
+
data: any;
|
|
34744
|
+
}): any;
|
|
34284
34745
|
};
|
|
34285
34746
|
}
|
|
34286
34747
|
declare module "resources/products-resource" {
|
|
@@ -35168,6 +35629,7 @@ declare module "resources/api-instance" {
|
|
|
35168
35629
|
id: any;
|
|
35169
35630
|
targetCustomerId: any;
|
|
35170
35631
|
}): any;
|
|
35632
|
+
getAml({ id }: rebilly.GetCustomerAmlEntryCollectionRequest): rebilly.GetCustomerAmlEntryCollectionResponsePromise;
|
|
35171
35633
|
getLeadSource({ id }: {
|
|
35172
35634
|
id: any;
|
|
35173
35635
|
}): rebilly.GetCustomerLeadSourceResponsePromise;
|
|
@@ -35196,6 +35658,21 @@ declare module "resources/api-instance" {
|
|
|
35196
35658
|
messageId: any;
|
|
35197
35659
|
}): any;
|
|
35198
35660
|
getAllUpcomingInvoices({ id, expand }: rebilly.GetCustomerUpcomingInvoiceCollectionRequest): rebilly.GetCustomerUpcomingInvoiceCollectionResponsePromise;
|
|
35661
|
+
getCustomerEddScore({ id }: {
|
|
35662
|
+
id: any;
|
|
35663
|
+
}): rebilly.GetCustomerEddScoreResponsePromise;
|
|
35664
|
+
patchCustomerEddScore({ id, data }: {
|
|
35665
|
+
id: any;
|
|
35666
|
+
data: any;
|
|
35667
|
+
}): any;
|
|
35668
|
+
getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.GetEddTimelineCollectionRequest): rebilly.GetEddTimelineCollectionResponsePromise;
|
|
35669
|
+
createEddTimelineComment({ id, data }: {
|
|
35670
|
+
id: any;
|
|
35671
|
+
data: any;
|
|
35672
|
+
}): any;
|
|
35673
|
+
GetEddSearchResults({ id }: {
|
|
35674
|
+
id: any;
|
|
35675
|
+
}): rebilly.GetEddSearchResultsResponsePromise;
|
|
35199
35676
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
35200
35677
|
limit?: any;
|
|
35201
35678
|
offset?: any;
|
|
@@ -35209,6 +35686,9 @@ declare module "resources/api-instance" {
|
|
|
35209
35686
|
create({ data }: {
|
|
35210
35687
|
data: any;
|
|
35211
35688
|
}): any;
|
|
35689
|
+
validate({ data }: {
|
|
35690
|
+
data: any;
|
|
35691
|
+
}): any;
|
|
35212
35692
|
};
|
|
35213
35693
|
disputes: {
|
|
35214
35694
|
getAll({ filter, sort, limit, offset, q, expand, }?: {
|
|
@@ -35464,6 +35944,7 @@ declare module "resources/api-instance" {
|
|
|
35464
35944
|
name?: string;
|
|
35465
35945
|
extension?: string;
|
|
35466
35946
|
description?: string;
|
|
35947
|
+
sourceType?: "camera" | "upload";
|
|
35467
35948
|
tags?: string[];
|
|
35468
35949
|
mime?: "image/png" | "image/jpeg" | "image/gif" | "application/pdf" | "audio/mpeg";
|
|
35469
35950
|
size?: number;
|
|
@@ -35740,6 +36221,11 @@ declare module "resources/api-instance" {
|
|
|
35740
36221
|
data: any;
|
|
35741
36222
|
}): any;
|
|
35742
36223
|
};
|
|
36224
|
+
kycSettings: {
|
|
36225
|
+
updateKycSettings({ data }: {
|
|
36226
|
+
data: any;
|
|
36227
|
+
}): rebilly.PutKycSettingsResponsePromise;
|
|
36228
|
+
};
|
|
35743
36229
|
lists: {
|
|
35744
36230
|
getAll({ limit, offset, filter, sort, fields, q, }?: {
|
|
35745
36231
|
limit?: number;
|
|
@@ -35886,6 +36372,9 @@ declare module "resources/api-instance" {
|
|
|
35886
36372
|
webhook({ data }: {
|
|
35887
36373
|
data: any;
|
|
35888
36374
|
}): any;
|
|
36375
|
+
order({ data }: {
|
|
36376
|
+
data: any;
|
|
36377
|
+
}): any;
|
|
35889
36378
|
};
|
|
35890
36379
|
products: {
|
|
35891
36380
|
getAll({ filter, sort, limit, offset, q, }?: {
|
|
@@ -36473,6 +36962,10 @@ declare module "resources/experimental/reports-resource" {
|
|
|
36473
36962
|
periodStart: any;
|
|
36474
36963
|
periodEnd: any;
|
|
36475
36964
|
}): any;
|
|
36965
|
+
getKycRejectionSummary({ periodStart, periodEnd }?: {
|
|
36966
|
+
periodStart: any;
|
|
36967
|
+
periodEnd: any;
|
|
36968
|
+
}): any;
|
|
36476
36969
|
getRulesMatchedSummary({ eventType, periodStart, periodEnd, limit, offset, tz }?: {
|
|
36477
36970
|
eventType: any;
|
|
36478
36971
|
periodStart: any;
|
|
@@ -36716,6 +37209,10 @@ declare module "resources/experimental/experimental-resources" {
|
|
|
36716
37209
|
periodStart: any;
|
|
36717
37210
|
periodEnd: any;
|
|
36718
37211
|
}): any;
|
|
37212
|
+
getKycRejectionSummary({ periodStart, periodEnd }?: {
|
|
37213
|
+
periodStart: any;
|
|
37214
|
+
periodEnd: any;
|
|
37215
|
+
}): any;
|
|
36719
37216
|
getRulesMatchedSummary({ eventType, periodStart, periodEnd, limit, offset, tz }?: {
|
|
36720
37217
|
eventType: any;
|
|
36721
37218
|
periodStart: any;
|