rebilly-js-sdk 62.145.4 → 62.147.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -3
- package/dist/rebilly-js-sdk.d.cts +371 -50
- package/dist/rebilly-js-sdk.d.mts +371 -50
- package/dist/rebilly-js-sdk.d.ts +371 -50
- package/dist/rebilly-js-sdk.es.mjs +129 -113
- package/dist/rebilly-js-sdk.umd.js +2 -2
- package/package.json +1 -1
- package/src/resources/aml-checks-resource.js +3 -5
- package/src/resources/payout-request-batches-resource.js +18 -0
|
@@ -31,8 +31,8 @@ declare namespace rebilly {
|
|
|
31
31
|
type GetAmlCheckCollectionResponse = operations['GetAmlCheckCollection']['responses']['200']['content']['application/json'][0]
|
|
32
32
|
type GetAmlCheckCollectionResponsePromise = Promise<{ items: {fields: GetAmlCheckCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
33
33
|
|
|
34
|
-
type GetAmlCheckRequest =
|
|
35
|
-
|
|
34
|
+
type GetAmlCheckRequest = { id: string }
|
|
35
|
+
|
|
36
36
|
type GetAmlCheckResponse = operations['GetAmlCheck']['responses']['200']['content']['application/json']
|
|
37
37
|
type GetAmlCheckResponsePromise = Promise<{fields: GetAmlCheckResponse}>
|
|
38
38
|
|
|
@@ -1772,6 +1772,8 @@ declare namespace rebilly {
|
|
|
1772
1772
|
type PatchPayoutRequestBatchRequest = operations['PatchPayoutRequestBatch']['requestBody']['content']['application/json']
|
|
1773
1773
|
type PatchPayoutRequestBatchResponse = operations['PatchPayoutRequestBatch']['responses']['200']['content']['application/json']
|
|
1774
1774
|
type PatchPayoutRequestBatchResponsePromise = Promise<{fields: PatchPayoutRequestBatchResponse}>
|
|
1775
|
+
type DeletePayoutRequestBatchResponse = operations['DeletePayoutRequestBatch']['responses']['204']
|
|
1776
|
+
type DeletePayoutRequestBatchResponsePromise = Promise<{fields: DeletePayoutRequestBatchResponse}>
|
|
1775
1777
|
|
|
1776
1778
|
type PostPayoutRequestBatchAutoAllocateResponse = operations['PostPayoutRequestBatchAutoAllocate']['responses']['200']['content']['application/json']
|
|
1777
1779
|
type PostPayoutRequestBatchAutoAllocateResponsePromise = Promise<{fields: PostPayoutRequestBatchAutoAllocateResponse}>
|
|
@@ -1784,6 +1786,19 @@ declare namespace rebilly {
|
|
|
1784
1786
|
type PostPayoutRequestBatchBlockResponse = operations['PostPayoutRequestBatchBlock']['responses']['200']['content']['application/json']
|
|
1785
1787
|
type PostPayoutRequestBatchBlockResponsePromise = Promise<{fields: PostPayoutRequestBatchBlockResponse}>
|
|
1786
1788
|
|
|
1789
|
+
type PostPayoutRequestsToBatchRequest = operations['PostPayoutRequestsToBatch']['requestBody']['content']['application/json']
|
|
1790
|
+
type CreatePayoutRequestsToBatchRequest = { id?: string, data: PostPayoutRequestsToBatchRequest, expand?: string }
|
|
1791
|
+
type PostPayoutRequestsToBatchResponse = operations['PostPayoutRequestsToBatch']['responses']['200']['content']['application/json']
|
|
1792
|
+
type PostPayoutRequestsToBatchResponsePromise = Promise<{fields: PostPayoutRequestsToBatchResponse}>
|
|
1793
|
+
|
|
1794
|
+
type PostRemovePayoutRequestsFromBatchRequest = operations['PostRemovePayoutRequestsFromBatch']['requestBody']['content']['application/json']
|
|
1795
|
+
type CreateRemovePayoutRequestsFromBatchRequest = { id?: string, data: PostRemovePayoutRequestsFromBatchRequest, expand?: string }
|
|
1796
|
+
type PostRemovePayoutRequestsFromBatchResponse = operations['PostRemovePayoutRequestsFromBatch']['responses']['200']['content']['application/json']
|
|
1797
|
+
type PostRemovePayoutRequestsFromBatchResponsePromise = Promise<{fields: PostRemovePayoutRequestsFromBatchResponse}>
|
|
1798
|
+
|
|
1799
|
+
type PostPayoutRequestBatchUnblockResponse = operations['PostPayoutRequestBatchUnblock']['responses']['200']['content']['application/json']
|
|
1800
|
+
type PostPayoutRequestBatchUnblockResponsePromise = Promise<{fields: PostPayoutRequestBatchUnblockResponse}>
|
|
1801
|
+
|
|
1787
1802
|
type GetPayoutRequestBatchPreviewRequest = operations['GetPayoutRequestBatchPreview']['parameters']
|
|
1788
1803
|
|
|
1789
1804
|
type GetPayoutRequestBatchPreviewResponse = operations['GetPayoutRequestBatchPreview']['responses']['200']['content']['application/json']
|
|
@@ -5544,6 +5559,12 @@ export interface corePaths {
|
|
|
5544
5559
|
"/payout-request-batches/{id}": {
|
|
5545
5560
|
/** Retrieves a payout request batch with a specified ID. */
|
|
5546
5561
|
get: operations["GetPayoutRequestBatch"];
|
|
5562
|
+
/**
|
|
5563
|
+
* Deletes a payout request batch with a specified ID and clears the `batchId` field from every payout request in the batch.
|
|
5564
|
+
* This operation preserves every payout request, status, and blocked state.
|
|
5565
|
+
* This operation is atomic. It clears all `batchId` fields or leaves them all unchanged.
|
|
5566
|
+
*/
|
|
5567
|
+
delete: operations["DeletePayoutRequestBatch"];
|
|
5547
5568
|
/**
|
|
5548
5569
|
* Partially updates a payout request batch with a specified ID.
|
|
5549
5570
|
* Use this operation to update the description and allocation order.
|
|
@@ -5599,6 +5620,69 @@ export interface corePaths {
|
|
|
5599
5620
|
};
|
|
5600
5621
|
};
|
|
5601
5622
|
};
|
|
5623
|
+
"/payout-request-batches/{id}/payout-requests": {
|
|
5624
|
+
/**
|
|
5625
|
+
* Adds payout requests to a batch with a specified ID.
|
|
5626
|
+
* Accepts payout requests in any status, with or without allocations.
|
|
5627
|
+
* A batch contains a maximum of 1000 payout requests.
|
|
5628
|
+
*
|
|
5629
|
+
* Provide exactly one of the following fields:
|
|
5630
|
+
* - `payoutRequestIds` to add specific payout requests.
|
|
5631
|
+
* - `filter` to add payout requests that match the filter when the operation runs.
|
|
5632
|
+
*
|
|
5633
|
+
* If any explicitly specified payout request is already associated with a batch,
|
|
5634
|
+
* the operation returns a `409 Conflict` response.
|
|
5635
|
+
* Filter results exclude payout requests that are already associated with a batch.
|
|
5636
|
+
* If more payout requests match the filter than the batch can contain,
|
|
5637
|
+
* the operation adds only the oldest matching requests up to the batch limit,
|
|
5638
|
+
* sorted by creation time.
|
|
5639
|
+
* If adding explicitly specified payout requests would increase the batch to more than 1000 requests,
|
|
5640
|
+
* the operation returns a `409 Conflict` response.
|
|
5641
|
+
* If the batch has reached its payout request limit,
|
|
5642
|
+
* the operation returns a `409 Conflict` response for either selection method.
|
|
5643
|
+
* This operation is atomic. If a conflict occurs, the operation adds no payout requests to the batch.
|
|
5644
|
+
*/
|
|
5645
|
+
post: operations["PostPayoutRequestsToBatch"];
|
|
5646
|
+
parameters: {
|
|
5647
|
+
path: {
|
|
5648
|
+
/** ID of the resource. */
|
|
5649
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
5650
|
+
};
|
|
5651
|
+
};
|
|
5652
|
+
};
|
|
5653
|
+
"/payout-request-batches/{id}/payout-requests/remove": {
|
|
5654
|
+
/**
|
|
5655
|
+
* Removes specified payout requests from a batch with a specified ID by clearing `batchId` on each request.
|
|
5656
|
+
* This operation preserves each payout request, status, and blocked state.
|
|
5657
|
+
* Removes requests regardless of status or allocations.
|
|
5658
|
+
*
|
|
5659
|
+
* This operation is atomic.
|
|
5660
|
+
* If any payout request is not associated with the specified batch,
|
|
5661
|
+
* the operation clears no associations with the batch.
|
|
5662
|
+
*/
|
|
5663
|
+
post: operations["PostRemovePayoutRequestsFromBatch"];
|
|
5664
|
+
parameters: {
|
|
5665
|
+
path: {
|
|
5666
|
+
/** ID of the resource. */
|
|
5667
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
5668
|
+
};
|
|
5669
|
+
};
|
|
5670
|
+
};
|
|
5671
|
+
"/payout-request-batches/{id}/unblock": {
|
|
5672
|
+
/**
|
|
5673
|
+
* Unblocks every blocked payout request in a batch with a specified ID.
|
|
5674
|
+
* Leaves payout requests without a block unchanged.
|
|
5675
|
+
* Processes all requests in the batch, up to the 1000-request batch limit, without changing batch membership.
|
|
5676
|
+
* This operation is atomic.
|
|
5677
|
+
*/
|
|
5678
|
+
post: operations["PostPayoutRequestBatchUnblock"];
|
|
5679
|
+
parameters: {
|
|
5680
|
+
path: {
|
|
5681
|
+
/** ID of the resource. */
|
|
5682
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
5683
|
+
};
|
|
5684
|
+
};
|
|
5685
|
+
};
|
|
5602
5686
|
"/payout-request-batches/preview": {
|
|
5603
5687
|
/**
|
|
5604
5688
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
@@ -6368,10 +6452,6 @@ export interface coreComponents {
|
|
|
6368
6452
|
/** Type of link. */
|
|
6369
6453
|
rel?: "self" | "customer";
|
|
6370
6454
|
}[];
|
|
6371
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
6372
|
-
_embedded?: {
|
|
6373
|
-
customer?: { [key: string]: any };
|
|
6374
|
-
};
|
|
6375
6455
|
};
|
|
6376
6456
|
/** AML check review. */
|
|
6377
6457
|
AmlCheckReview: {
|
|
@@ -10877,10 +10957,15 @@ export interface coreComponents {
|
|
|
10877
10957
|
/** Proof of funds document matches. */
|
|
10878
10958
|
documentMatches?: {
|
|
10879
10959
|
version?: coreComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
10960
|
+
score?: coreComponents["schemas"]["KycDocumentMatchesScore"];
|
|
10961
|
+
checkList?: coreComponents["schemas"]["KycDocumentCheckList"];
|
|
10880
10962
|
data?: coreComponents["schemas"]["FundsMatches"];
|
|
10881
10963
|
} | null;
|
|
10964
|
+
/** Parsed data. */
|
|
10882
10965
|
parsedData?: {
|
|
10883
10966
|
version?: coreComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
10967
|
+
score?: coreComponents["schemas"]["KycDocumentMatchesScore"];
|
|
10968
|
+
checkList?: coreComponents["schemas"]["KycDocumentCheckList"];
|
|
10884
10969
|
data?: coreComponents["schemas"]["FundsMatches"];
|
|
10885
10970
|
} | null;
|
|
10886
10971
|
/** Related links. */
|
|
@@ -10971,11 +11056,15 @@ export interface coreComponents {
|
|
|
10971
11056
|
/** Proof of purchase document matches. */
|
|
10972
11057
|
documentMatches?: {
|
|
10973
11058
|
version?: coreComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
11059
|
+
score?: coreComponents["schemas"]["KycDocumentMatchesScore"];
|
|
11060
|
+
checkList?: coreComponents["schemas"]["KycDocumentCheckList"];
|
|
10974
11061
|
data?: coreComponents["schemas"]["PurchaseMatches"];
|
|
10975
11062
|
} | null;
|
|
10976
11063
|
/** Parsed data. */
|
|
10977
11064
|
parsedData?: {
|
|
10978
11065
|
version?: coreComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
11066
|
+
score?: coreComponents["schemas"]["KycDocumentMatchesScore"];
|
|
11067
|
+
checkList?: coreComponents["schemas"]["KycDocumentCheckList"];
|
|
10979
11068
|
data?: coreComponents["schemas"]["PurchaseMatches"];
|
|
10980
11069
|
} | null;
|
|
10981
11070
|
/** Related links. */
|
|
@@ -11111,8 +11200,16 @@ export interface coreComponents {
|
|
|
11111
11200
|
/** Proof of credit document matches. */
|
|
11112
11201
|
documentMatches?: {
|
|
11113
11202
|
version?: coreComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
11203
|
+
score?: coreComponents["schemas"]["KycDocumentMatchesScore"];
|
|
11204
|
+
checkList?: coreComponents["schemas"]["KycDocumentCheckList"];
|
|
11114
11205
|
data?: coreComponents["schemas"]["CreditFileMatches"];
|
|
11206
|
+
} | null;
|
|
11207
|
+
/** Parsed data. */
|
|
11208
|
+
parsedData?: {
|
|
11209
|
+
version?: coreComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
11210
|
+
score?: coreComponents["schemas"]["KycDocumentMatchesScore"];
|
|
11115
11211
|
checkList?: coreComponents["schemas"]["KycDocumentCheckList"];
|
|
11212
|
+
data?: coreComponents["schemas"]["CreditFileMatches"];
|
|
11116
11213
|
} | null;
|
|
11117
11214
|
/** Related links. */
|
|
11118
11215
|
_links?: {
|
|
@@ -22643,10 +22740,6 @@ export interface coreComponents {
|
|
|
22643
22740
|
userId?: string;
|
|
22644
22741
|
/** Total number of payout requests in the batch. */
|
|
22645
22742
|
totalCount?: number;
|
|
22646
|
-
/** Number of payout requests successfully processed. */
|
|
22647
|
-
successCount?: number;
|
|
22648
|
-
/** Number of payout requests that failed to process. */
|
|
22649
|
-
failureCount?: number;
|
|
22650
22743
|
/** Number of unique customers in the batch. */
|
|
22651
22744
|
customerCount?: number;
|
|
22652
22745
|
/** Total payout amount grouped by currency in the batch. */
|
|
@@ -25619,6 +25712,11 @@ export interface coreComponents {
|
|
|
25619
25712
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
25620
25713
|
/** Date and time when the KYC document is processed. */
|
|
25621
25714
|
processedTime?: string;
|
|
25715
|
+
/** Document matches. */
|
|
25716
|
+
documentMatches?: {
|
|
25717
|
+
version?: coreComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
25718
|
+
data?: coreComponents["schemas"]["FundsMatches"];
|
|
25719
|
+
} | null;
|
|
25622
25720
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
25623
25721
|
};
|
|
25624
25722
|
StorefrontProofOfPurchaseKycDocument: {
|
|
@@ -30010,14 +30108,6 @@ export interface operations {
|
|
|
30010
30108
|
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
30011
30109
|
/** Use this field to perform a partial search of text fields. */
|
|
30012
30110
|
q?: coreComponents["parameters"]["collectionQuery"];
|
|
30013
|
-
/**
|
|
30014
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
30015
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
30016
|
-
*
|
|
30017
|
-
* For more information, see
|
|
30018
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
30019
|
-
*/
|
|
30020
|
-
expand?: coreComponents["parameters"]["collectionExpand"];
|
|
30021
30111
|
};
|
|
30022
30112
|
};
|
|
30023
30113
|
responses: {
|
|
@@ -30042,16 +30132,6 @@ export interface operations {
|
|
|
30042
30132
|
/** ID of the resource. */
|
|
30043
30133
|
id: coreComponents["parameters"]["resourceId"];
|
|
30044
30134
|
};
|
|
30045
|
-
query: {
|
|
30046
|
-
/**
|
|
30047
|
-
* Expands a request to include embedded objects within the `_embedded`
|
|
30048
|
-
* property of the response. This field accepts a comma-separated list of objects.
|
|
30049
|
-
*
|
|
30050
|
-
* For more information, see
|
|
30051
|
-
* [Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
|
|
30052
|
-
*/
|
|
30053
|
-
expand?: coreComponents["parameters"]["collectionExpand"];
|
|
30054
|
-
};
|
|
30055
30135
|
};
|
|
30056
30136
|
responses: {
|
|
30057
30137
|
/** AML check retrieved. */
|
|
@@ -42276,6 +42356,27 @@ export interface operations {
|
|
|
42276
42356
|
429: coreComponents["responses"]["TooManyRequests"];
|
|
42277
42357
|
};
|
|
42278
42358
|
};
|
|
42359
|
+
/**
|
|
42360
|
+
* Deletes a payout request batch with a specified ID and clears the `batchId` field from every payout request in the batch.
|
|
42361
|
+
* This operation preserves every payout request, status, and blocked state.
|
|
42362
|
+
* This operation is atomic. It clears all `batchId` fields or leaves them all unchanged.
|
|
42363
|
+
*/
|
|
42364
|
+
DeletePayoutRequestBatch: {
|
|
42365
|
+
parameters: {
|
|
42366
|
+
path: {
|
|
42367
|
+
/** ID of the resource. */
|
|
42368
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
42369
|
+
};
|
|
42370
|
+
};
|
|
42371
|
+
responses: {
|
|
42372
|
+
/** Payout request batch deleted. */
|
|
42373
|
+
204: never;
|
|
42374
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
42375
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
42376
|
+
404: coreComponents["responses"]["NotFound"];
|
|
42377
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
42378
|
+
};
|
|
42379
|
+
};
|
|
42279
42380
|
/**
|
|
42280
42381
|
* Partially updates a payout request batch with a specified ID.
|
|
42281
42382
|
* Use this operation to update the description and allocation order.
|
|
@@ -42397,6 +42498,160 @@ export interface operations {
|
|
|
42397
42498
|
};
|
|
42398
42499
|
};
|
|
42399
42500
|
};
|
|
42501
|
+
/**
|
|
42502
|
+
* Adds payout requests to a batch with a specified ID.
|
|
42503
|
+
* Accepts payout requests in any status, with or without allocations.
|
|
42504
|
+
* A batch contains a maximum of 1000 payout requests.
|
|
42505
|
+
*
|
|
42506
|
+
* Provide exactly one of the following fields:
|
|
42507
|
+
* - `payoutRequestIds` to add specific payout requests.
|
|
42508
|
+
* - `filter` to add payout requests that match the filter when the operation runs.
|
|
42509
|
+
*
|
|
42510
|
+
* If any explicitly specified payout request is already associated with a batch,
|
|
42511
|
+
* the operation returns a `409 Conflict` response.
|
|
42512
|
+
* Filter results exclude payout requests that are already associated with a batch.
|
|
42513
|
+
* If more payout requests match the filter than the batch can contain,
|
|
42514
|
+
* the operation adds only the oldest matching requests up to the batch limit,
|
|
42515
|
+
* sorted by creation time.
|
|
42516
|
+
* If adding explicitly specified payout requests would increase the batch to more than 1000 requests,
|
|
42517
|
+
* the operation returns a `409 Conflict` response.
|
|
42518
|
+
* If the batch has reached its payout request limit,
|
|
42519
|
+
* the operation returns a `409 Conflict` response for either selection method.
|
|
42520
|
+
* This operation is atomic. If a conflict occurs, the operation adds no payout requests to the batch.
|
|
42521
|
+
*/
|
|
42522
|
+
PostPayoutRequestsToBatch: {
|
|
42523
|
+
parameters: {
|
|
42524
|
+
path: {
|
|
42525
|
+
/** ID of the resource. */
|
|
42526
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
42527
|
+
};
|
|
42528
|
+
};
|
|
42529
|
+
responses: {
|
|
42530
|
+
/** Payout requests added to the batch. */
|
|
42531
|
+
200: {
|
|
42532
|
+
headers: {};
|
|
42533
|
+
content: {
|
|
42534
|
+
"application/json": coreComponents["schemas"]["PayoutRequestBatch"];
|
|
42535
|
+
};
|
|
42536
|
+
};
|
|
42537
|
+
/** Invalid filter provided or no payout requests match the filter. */
|
|
42538
|
+
400: {
|
|
42539
|
+
content: {
|
|
42540
|
+
"application/json": coreComponents["schemas"]["Problem"];
|
|
42541
|
+
};
|
|
42542
|
+
};
|
|
42543
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
42544
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
42545
|
+
404: coreComponents["responses"]["NotFound"];
|
|
42546
|
+
/** Batch limit reached or would be exceeded, or one or more explicitly specified payout requests are already associated with a batch. */
|
|
42547
|
+
409: {
|
|
42548
|
+
content: {
|
|
42549
|
+
"application/json": coreComponents["schemas"]["Conflict"];
|
|
42550
|
+
};
|
|
42551
|
+
};
|
|
42552
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
42553
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
42554
|
+
};
|
|
42555
|
+
/** Selection of payout requests to add to the batch. */
|
|
42556
|
+
requestBody: {
|
|
42557
|
+
content: {
|
|
42558
|
+
"application/json":
|
|
42559
|
+
| {
|
|
42560
|
+
/** IDs of the payout requests to add to the batch. */
|
|
42561
|
+
payoutRequestIds: string[];
|
|
42562
|
+
}
|
|
42563
|
+
| {
|
|
42564
|
+
/**
|
|
42565
|
+
* Filter string that selects payout requests to add to the batch.
|
|
42566
|
+
* This field uses the same format as filter parameters for collections.
|
|
42567
|
+
* Use semicolons to separate multiple filter conditions.
|
|
42568
|
+
*
|
|
42569
|
+
* Available fields for filtering: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
42570
|
+
*
|
|
42571
|
+
* This operation ignores a `batchId` filter.
|
|
42572
|
+
* Filter results always exclude payout requests that are already associated with a batch.
|
|
42573
|
+
* If the filter matches more payout requests than the batch can contain,
|
|
42574
|
+
* the operation adds only the oldest matching requests up to the batch limit,
|
|
42575
|
+
* sorted by creation time.
|
|
42576
|
+
*/
|
|
42577
|
+
filter: string;
|
|
42578
|
+
};
|
|
42579
|
+
};
|
|
42580
|
+
};
|
|
42581
|
+
};
|
|
42582
|
+
/**
|
|
42583
|
+
* Removes specified payout requests from a batch with a specified ID by clearing `batchId` on each request.
|
|
42584
|
+
* This operation preserves each payout request, status, and blocked state.
|
|
42585
|
+
* Removes requests regardless of status or allocations.
|
|
42586
|
+
*
|
|
42587
|
+
* This operation is atomic.
|
|
42588
|
+
* If any payout request is not associated with the specified batch,
|
|
42589
|
+
* the operation clears no associations with the batch.
|
|
42590
|
+
*/
|
|
42591
|
+
PostRemovePayoutRequestsFromBatch: {
|
|
42592
|
+
parameters: {
|
|
42593
|
+
path: {
|
|
42594
|
+
/** ID of the resource. */
|
|
42595
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
42596
|
+
};
|
|
42597
|
+
};
|
|
42598
|
+
responses: {
|
|
42599
|
+
/** Payout requests removed from the batch. */
|
|
42600
|
+
200: {
|
|
42601
|
+
headers: {};
|
|
42602
|
+
content: {
|
|
42603
|
+
"application/json": coreComponents["schemas"]["PayoutRequestBatch"];
|
|
42604
|
+
};
|
|
42605
|
+
};
|
|
42606
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
42607
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
42608
|
+
404: coreComponents["responses"]["NotFound"];
|
|
42609
|
+
/** One or more payout requests are not associated with the specified batch. */
|
|
42610
|
+
409: {
|
|
42611
|
+
content: {
|
|
42612
|
+
"application/json": coreComponents["schemas"]["Conflict"];
|
|
42613
|
+
};
|
|
42614
|
+
};
|
|
42615
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
42616
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
42617
|
+
};
|
|
42618
|
+
/** Payout requests to remove from the batch. */
|
|
42619
|
+
requestBody: {
|
|
42620
|
+
content: {
|
|
42621
|
+
"application/json": {
|
|
42622
|
+
/** IDs of the payout requests to remove from the batch. */
|
|
42623
|
+
payoutRequestIds: string[];
|
|
42624
|
+
};
|
|
42625
|
+
};
|
|
42626
|
+
};
|
|
42627
|
+
};
|
|
42628
|
+
/**
|
|
42629
|
+
* Unblocks every blocked payout request in a batch with a specified ID.
|
|
42630
|
+
* Leaves payout requests without a block unchanged.
|
|
42631
|
+
* Processes all requests in the batch, up to the 1000-request batch limit, without changing batch membership.
|
|
42632
|
+
* This operation is atomic.
|
|
42633
|
+
*/
|
|
42634
|
+
PostPayoutRequestBatchUnblock: {
|
|
42635
|
+
parameters: {
|
|
42636
|
+
path: {
|
|
42637
|
+
/** ID of the resource. */
|
|
42638
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
42639
|
+
};
|
|
42640
|
+
};
|
|
42641
|
+
responses: {
|
|
42642
|
+
/** Payout requests in the batch unblocked. */
|
|
42643
|
+
200: {
|
|
42644
|
+
headers: {};
|
|
42645
|
+
content: {
|
|
42646
|
+
"application/json": coreComponents["schemas"]["PayoutRequestBatch"];
|
|
42647
|
+
};
|
|
42648
|
+
};
|
|
42649
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
42650
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
42651
|
+
404: coreComponents["responses"]["NotFound"];
|
|
42652
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
42653
|
+
};
|
|
42654
|
+
};
|
|
42400
42655
|
/**
|
|
42401
42656
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
42402
42657
|
*
|
|
@@ -44917,10 +45172,6 @@ export interface storefrontComponents {
|
|
|
44917
45172
|
/** Type of link. */
|
|
44918
45173
|
rel?: "self" | "customer";
|
|
44919
45174
|
}[];
|
|
44920
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
44921
|
-
_embedded?: {
|
|
44922
|
-
customer?: { [key: string]: any };
|
|
44923
|
-
};
|
|
44924
45175
|
};
|
|
44925
45176
|
/** AML check review. */
|
|
44926
45177
|
AmlCheckReview: {
|
|
@@ -49426,10 +49677,15 @@ export interface storefrontComponents {
|
|
|
49426
49677
|
/** Proof of funds document matches. */
|
|
49427
49678
|
documentMatches?: {
|
|
49428
49679
|
version?: storefrontComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
49680
|
+
score?: storefrontComponents["schemas"]["KycDocumentMatchesScore"];
|
|
49681
|
+
checkList?: storefrontComponents["schemas"]["KycDocumentCheckList"];
|
|
49429
49682
|
data?: storefrontComponents["schemas"]["FundsMatches"];
|
|
49430
49683
|
} | null;
|
|
49684
|
+
/** Parsed data. */
|
|
49431
49685
|
parsedData?: {
|
|
49432
49686
|
version?: storefrontComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
49687
|
+
score?: storefrontComponents["schemas"]["KycDocumentMatchesScore"];
|
|
49688
|
+
checkList?: storefrontComponents["schemas"]["KycDocumentCheckList"];
|
|
49433
49689
|
data?: storefrontComponents["schemas"]["FundsMatches"];
|
|
49434
49690
|
} | null;
|
|
49435
49691
|
/** Related links. */
|
|
@@ -49520,11 +49776,15 @@ export interface storefrontComponents {
|
|
|
49520
49776
|
/** Proof of purchase document matches. */
|
|
49521
49777
|
documentMatches?: {
|
|
49522
49778
|
version?: storefrontComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
49779
|
+
score?: storefrontComponents["schemas"]["KycDocumentMatchesScore"];
|
|
49780
|
+
checkList?: storefrontComponents["schemas"]["KycDocumentCheckList"];
|
|
49523
49781
|
data?: storefrontComponents["schemas"]["PurchaseMatches"];
|
|
49524
49782
|
} | null;
|
|
49525
49783
|
/** Parsed data. */
|
|
49526
49784
|
parsedData?: {
|
|
49527
49785
|
version?: storefrontComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
49786
|
+
score?: storefrontComponents["schemas"]["KycDocumentMatchesScore"];
|
|
49787
|
+
checkList?: storefrontComponents["schemas"]["KycDocumentCheckList"];
|
|
49528
49788
|
data?: storefrontComponents["schemas"]["PurchaseMatches"];
|
|
49529
49789
|
} | null;
|
|
49530
49790
|
/** Related links. */
|
|
@@ -49660,8 +49920,16 @@ export interface storefrontComponents {
|
|
|
49660
49920
|
/** Proof of credit document matches. */
|
|
49661
49921
|
documentMatches?: {
|
|
49662
49922
|
version?: storefrontComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
49923
|
+
score?: storefrontComponents["schemas"]["KycDocumentMatchesScore"];
|
|
49924
|
+
checkList?: storefrontComponents["schemas"]["KycDocumentCheckList"];
|
|
49663
49925
|
data?: storefrontComponents["schemas"]["CreditFileMatches"];
|
|
49926
|
+
} | null;
|
|
49927
|
+
/** Parsed data. */
|
|
49928
|
+
parsedData?: {
|
|
49929
|
+
version?: storefrontComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
49930
|
+
score?: storefrontComponents["schemas"]["KycDocumentMatchesScore"];
|
|
49664
49931
|
checkList?: storefrontComponents["schemas"]["KycDocumentCheckList"];
|
|
49932
|
+
data?: storefrontComponents["schemas"]["CreditFileMatches"];
|
|
49665
49933
|
} | null;
|
|
49666
49934
|
/** Related links. */
|
|
49667
49935
|
_links?: {
|
|
@@ -61192,10 +61460,6 @@ export interface storefrontComponents {
|
|
|
61192
61460
|
userId?: string;
|
|
61193
61461
|
/** Total number of payout requests in the batch. */
|
|
61194
61462
|
totalCount?: number;
|
|
61195
|
-
/** Number of payout requests successfully processed. */
|
|
61196
|
-
successCount?: number;
|
|
61197
|
-
/** Number of payout requests that failed to process. */
|
|
61198
|
-
failureCount?: number;
|
|
61199
61463
|
/** Number of unique customers in the batch. */
|
|
61200
61464
|
customerCount?: number;
|
|
61201
61465
|
/** Total payout amount grouped by currency in the batch. */
|
|
@@ -64168,6 +64432,11 @@ export interface storefrontComponents {
|
|
|
64168
64432
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
64169
64433
|
/** Date and time when the KYC document is processed. */
|
|
64170
64434
|
processedTime?: string;
|
|
64435
|
+
/** Document matches. */
|
|
64436
|
+
documentMatches?: {
|
|
64437
|
+
version?: storefrontComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
64438
|
+
data?: storefrontComponents["schemas"]["FundsMatches"];
|
|
64439
|
+
} | null;
|
|
64171
64440
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
64172
64441
|
};
|
|
64173
64442
|
StorefrontProofOfPurchaseKycDocument: {
|
|
@@ -70901,10 +71170,6 @@ export interface reportsComponents {
|
|
|
70901
71170
|
/** Type of link. */
|
|
70902
71171
|
rel?: "self" | "customer";
|
|
70903
71172
|
}[];
|
|
70904
|
-
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
70905
|
-
_embedded?: {
|
|
70906
|
-
customer?: { [key: string]: any };
|
|
70907
|
-
};
|
|
70908
71173
|
};
|
|
70909
71174
|
/** AML check review. */
|
|
70910
71175
|
AmlCheckReview: {
|
|
@@ -75410,10 +75675,15 @@ export interface reportsComponents {
|
|
|
75410
75675
|
/** Proof of funds document matches. */
|
|
75411
75676
|
documentMatches?: {
|
|
75412
75677
|
version?: reportsComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
75678
|
+
score?: reportsComponents["schemas"]["KycDocumentMatchesScore"];
|
|
75679
|
+
checkList?: reportsComponents["schemas"]["KycDocumentCheckList"];
|
|
75413
75680
|
data?: reportsComponents["schemas"]["FundsMatches"];
|
|
75414
75681
|
} | null;
|
|
75682
|
+
/** Parsed data. */
|
|
75415
75683
|
parsedData?: {
|
|
75416
75684
|
version?: reportsComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
75685
|
+
score?: reportsComponents["schemas"]["KycDocumentMatchesScore"];
|
|
75686
|
+
checkList?: reportsComponents["schemas"]["KycDocumentCheckList"];
|
|
75417
75687
|
data?: reportsComponents["schemas"]["FundsMatches"];
|
|
75418
75688
|
} | null;
|
|
75419
75689
|
/** Related links. */
|
|
@@ -75504,11 +75774,15 @@ export interface reportsComponents {
|
|
|
75504
75774
|
/** Proof of purchase document matches. */
|
|
75505
75775
|
documentMatches?: {
|
|
75506
75776
|
version?: reportsComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
75777
|
+
score?: reportsComponents["schemas"]["KycDocumentMatchesScore"];
|
|
75778
|
+
checkList?: reportsComponents["schemas"]["KycDocumentCheckList"];
|
|
75507
75779
|
data?: reportsComponents["schemas"]["PurchaseMatches"];
|
|
75508
75780
|
} | null;
|
|
75509
75781
|
/** Parsed data. */
|
|
75510
75782
|
parsedData?: {
|
|
75511
75783
|
version?: reportsComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
75784
|
+
score?: reportsComponents["schemas"]["KycDocumentMatchesScore"];
|
|
75785
|
+
checkList?: reportsComponents["schemas"]["KycDocumentCheckList"];
|
|
75512
75786
|
data?: reportsComponents["schemas"]["PurchaseMatches"];
|
|
75513
75787
|
} | null;
|
|
75514
75788
|
/** Related links. */
|
|
@@ -75644,8 +75918,16 @@ export interface reportsComponents {
|
|
|
75644
75918
|
/** Proof of credit document matches. */
|
|
75645
75919
|
documentMatches?: {
|
|
75646
75920
|
version?: reportsComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
75921
|
+
score?: reportsComponents["schemas"]["KycDocumentMatchesScore"];
|
|
75922
|
+
checkList?: reportsComponents["schemas"]["KycDocumentCheckList"];
|
|
75647
75923
|
data?: reportsComponents["schemas"]["CreditFileMatches"];
|
|
75924
|
+
} | null;
|
|
75925
|
+
/** Parsed data. */
|
|
75926
|
+
parsedData?: {
|
|
75927
|
+
version?: reportsComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
75928
|
+
score?: reportsComponents["schemas"]["KycDocumentMatchesScore"];
|
|
75648
75929
|
checkList?: reportsComponents["schemas"]["KycDocumentCheckList"];
|
|
75930
|
+
data?: reportsComponents["schemas"]["CreditFileMatches"];
|
|
75649
75931
|
} | null;
|
|
75650
75932
|
/** Related links. */
|
|
75651
75933
|
_links?: {
|
|
@@ -87176,10 +87458,6 @@ export interface reportsComponents {
|
|
|
87176
87458
|
userId?: string;
|
|
87177
87459
|
/** Total number of payout requests in the batch. */
|
|
87178
87460
|
totalCount?: number;
|
|
87179
|
-
/** Number of payout requests successfully processed. */
|
|
87180
|
-
successCount?: number;
|
|
87181
|
-
/** Number of payout requests that failed to process. */
|
|
87182
|
-
failureCount?: number;
|
|
87183
87461
|
/** Number of unique customers in the batch. */
|
|
87184
87462
|
customerCount?: number;
|
|
87185
87463
|
/** Total payout amount grouped by currency in the batch. */
|
|
@@ -90152,6 +90430,11 @@ export interface reportsComponents {
|
|
|
90152
90430
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
90153
90431
|
/** Date and time when the KYC document is processed. */
|
|
90154
90432
|
processedTime?: string;
|
|
90433
|
+
/** Document matches. */
|
|
90434
|
+
documentMatches?: {
|
|
90435
|
+
version?: reportsComponents["schemas"]["KycDocumentMatchesVersion"];
|
|
90436
|
+
data?: reportsComponents["schemas"]["FundsMatches"];
|
|
90437
|
+
} | null;
|
|
90155
90438
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
90156
90439
|
};
|
|
90157
90440
|
StorefrontProofOfPurchaseKycDocument: {
|
|
@@ -97425,6 +97708,8 @@ declare module "rebilly-js-sdk" {
|
|
|
97425
97708
|
export type PatchPayoutRequestBatchRequest = rebilly.PatchPayoutRequestBatchRequest;
|
|
97426
97709
|
export type PatchPayoutRequestBatchResponse = rebilly.PatchPayoutRequestBatchResponse;
|
|
97427
97710
|
export type PatchPayoutRequestBatchResponsePromise = rebilly.PatchPayoutRequestBatchResponsePromise;
|
|
97711
|
+
export type DeletePayoutRequestBatchResponse = rebilly.DeletePayoutRequestBatchResponse;
|
|
97712
|
+
export type DeletePayoutRequestBatchResponsePromise = rebilly.DeletePayoutRequestBatchResponsePromise;
|
|
97428
97713
|
export type PostPayoutRequestBatchAutoAllocateResponse = rebilly.PostPayoutRequestBatchAutoAllocateResponse;
|
|
97429
97714
|
export type PostPayoutRequestBatchAutoAllocateResponsePromise = rebilly.PostPayoutRequestBatchAutoAllocateResponsePromise;
|
|
97430
97715
|
export type PostPayoutRequestBatchApproveResponse = rebilly.PostPayoutRequestBatchApproveResponse;
|
|
@@ -97433,6 +97718,16 @@ declare module "rebilly-js-sdk" {
|
|
|
97433
97718
|
export type CreatePayoutRequestBatchBlockRequest = rebilly.CreatePayoutRequestBatchBlockRequest;
|
|
97434
97719
|
export type PostPayoutRequestBatchBlockResponse = rebilly.PostPayoutRequestBatchBlockResponse;
|
|
97435
97720
|
export type PostPayoutRequestBatchBlockResponsePromise = rebilly.PostPayoutRequestBatchBlockResponsePromise;
|
|
97721
|
+
export type PostPayoutRequestsToBatchRequest = rebilly.PostPayoutRequestsToBatchRequest;
|
|
97722
|
+
export type CreatePayoutRequestsToBatchRequest = rebilly.CreatePayoutRequestsToBatchRequest;
|
|
97723
|
+
export type PostPayoutRequestsToBatchResponse = rebilly.PostPayoutRequestsToBatchResponse;
|
|
97724
|
+
export type PostPayoutRequestsToBatchResponsePromise = rebilly.PostPayoutRequestsToBatchResponsePromise;
|
|
97725
|
+
export type PostRemovePayoutRequestsFromBatchRequest = rebilly.PostRemovePayoutRequestsFromBatchRequest;
|
|
97726
|
+
export type CreateRemovePayoutRequestsFromBatchRequest = rebilly.CreateRemovePayoutRequestsFromBatchRequest;
|
|
97727
|
+
export type PostRemovePayoutRequestsFromBatchResponse = rebilly.PostRemovePayoutRequestsFromBatchResponse;
|
|
97728
|
+
export type PostRemovePayoutRequestsFromBatchResponsePromise = rebilly.PostRemovePayoutRequestsFromBatchResponsePromise;
|
|
97729
|
+
export type PostPayoutRequestBatchUnblockResponse = rebilly.PostPayoutRequestBatchUnblockResponse;
|
|
97730
|
+
export type PostPayoutRequestBatchUnblockResponsePromise = rebilly.PostPayoutRequestBatchUnblockResponsePromise;
|
|
97436
97731
|
export type GetPayoutRequestBatchPreviewRequest = rebilly.GetPayoutRequestBatchPreviewRequest;
|
|
97437
97732
|
export type GetPayoutRequestBatchPreviewResponse = rebilly.GetPayoutRequestBatchPreviewResponse;
|
|
97438
97733
|
export type GetPayoutRequestBatchPreviewResponsePromise = rebilly.GetPayoutRequestBatchPreviewResponsePromise;
|
|
@@ -98201,10 +98496,9 @@ declare module "resources/aml-checks-resource" {
|
|
|
98201
98496
|
export default function AmlChecksResource({ apiHandler }: {
|
|
98202
98497
|
apiHandler: any;
|
|
98203
98498
|
}): {
|
|
98204
|
-
getAll({ limit, offset, sort, filter, q,
|
|
98205
|
-
get({ id
|
|
98499
|
+
getAll({ limit, offset, sort, filter, q, }?: rebilly.GetAmlCheckCollectionRequest): rebilly.GetAmlCheckCollectionResponsePromise;
|
|
98500
|
+
get({ id }: {
|
|
98206
98501
|
id: any;
|
|
98207
|
-
expand?: any;
|
|
98208
98502
|
}): rebilly.GetAmlCheckResponsePromise;
|
|
98209
98503
|
startReview({ id }: {
|
|
98210
98504
|
id: any;
|
|
@@ -99470,6 +99764,9 @@ declare module "resources/payout-request-batches-resource" {
|
|
|
99470
99764
|
get({ id }: {
|
|
99471
99765
|
id: any;
|
|
99472
99766
|
}): rebilly.GetPayoutRequestBatchResponsePromise;
|
|
99767
|
+
delete({ id }: {
|
|
99768
|
+
id: any;
|
|
99769
|
+
}): any;
|
|
99473
99770
|
patch({ id, data }: {
|
|
99474
99771
|
id: any;
|
|
99475
99772
|
data: any;
|
|
@@ -99484,6 +99781,17 @@ declare module "resources/payout-request-batches-resource" {
|
|
|
99484
99781
|
id: any;
|
|
99485
99782
|
data: any;
|
|
99486
99783
|
}): any;
|
|
99784
|
+
addPayoutRequests({ id, data }: {
|
|
99785
|
+
id: any;
|
|
99786
|
+
data: any;
|
|
99787
|
+
}): any;
|
|
99788
|
+
removePayoutRequests({ id, data }: {
|
|
99789
|
+
id: any;
|
|
99790
|
+
data: any;
|
|
99791
|
+
}): any;
|
|
99792
|
+
unblock({ id }: {
|
|
99793
|
+
id: any;
|
|
99794
|
+
}): any;
|
|
99487
99795
|
preview({ filter }: {
|
|
99488
99796
|
filter?: any;
|
|
99489
99797
|
}): rebilly.GetPayoutRequestBatchPreviewResponsePromise;
|
|
@@ -100198,10 +100506,9 @@ declare module "resources/api-instance" {
|
|
|
100198
100506
|
}): any;
|
|
100199
100507
|
};
|
|
100200
100508
|
amlChecks: {
|
|
100201
|
-
getAll({ limit, offset, sort, filter, q,
|
|
100202
|
-
get({ id
|
|
100509
|
+
getAll({ limit, offset, sort, filter, q, }?: rebilly.GetAmlCheckCollectionRequest): rebilly.GetAmlCheckCollectionResponsePromise;
|
|
100510
|
+
get({ id }: {
|
|
100203
100511
|
id: any;
|
|
100204
|
-
expand?: any;
|
|
100205
100512
|
}): rebilly.GetAmlCheckResponsePromise;
|
|
100206
100513
|
startReview({ id }: {
|
|
100207
100514
|
id: any;
|
|
@@ -101259,6 +101566,9 @@ declare module "resources/api-instance" {
|
|
|
101259
101566
|
get({ id }: {
|
|
101260
101567
|
id: any;
|
|
101261
101568
|
}): rebilly.GetPayoutRequestBatchResponsePromise;
|
|
101569
|
+
delete({ id }: {
|
|
101570
|
+
id: any;
|
|
101571
|
+
}): any;
|
|
101262
101572
|
patch({ id, data }: {
|
|
101263
101573
|
id: any;
|
|
101264
101574
|
data: any;
|
|
@@ -101273,6 +101583,17 @@ declare module "resources/api-instance" {
|
|
|
101273
101583
|
id: any;
|
|
101274
101584
|
data: any;
|
|
101275
101585
|
}): any;
|
|
101586
|
+
addPayoutRequests({ id, data }: {
|
|
101587
|
+
id: any;
|
|
101588
|
+
data: any;
|
|
101589
|
+
}): any;
|
|
101590
|
+
removePayoutRequests({ id, data }: {
|
|
101591
|
+
id: any;
|
|
101592
|
+
data: any;
|
|
101593
|
+
}): any;
|
|
101594
|
+
unblock({ id }: {
|
|
101595
|
+
id: any;
|
|
101596
|
+
}): any;
|
|
101276
101597
|
preview({ filter }: {
|
|
101277
101598
|
filter?: any;
|
|
101278
101599
|
}): rebilly.GetPayoutRequestBatchPreviewResponsePromise;
|