mollie-api-typescript 1.7.0 → 1.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/dist/commonjs/funcs/payoutsCancel.d.ts +22 -0
- package/dist/commonjs/funcs/payoutsCancel.d.ts.map +1 -0
- package/dist/commonjs/funcs/payoutsCancel.js +147 -0
- package/dist/commonjs/funcs/payoutsCancel.js.map +1 -0
- package/dist/commonjs/funcs/payoutsCreate.d.ts +54 -0
- package/dist/commonjs/funcs/payoutsCreate.d.ts.map +1 -0
- package/dist/commonjs/funcs/payoutsCreate.js +174 -0
- package/dist/commonjs/funcs/payoutsCreate.js.map +1 -0
- package/dist/commonjs/funcs/payoutsGet.d.ts +19 -0
- package/dist/commonjs/funcs/payoutsGet.d.ts.map +1 -0
- package/dist/commonjs/funcs/payoutsGet.js +144 -0
- package/dist/commonjs/funcs/payoutsGet.js.map +1 -0
- package/dist/commonjs/funcs/payoutsList.d.ts +29 -0
- package/dist/commonjs/funcs/payoutsList.d.ts.map +1 -0
- package/dist/commonjs/funcs/payoutsList.js +182 -0
- package/dist/commonjs/funcs/payoutsList.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/entitypayoutresponse.d.ts +102 -0
- package/dist/commonjs/models/entitypayoutresponse.d.ts.map +1 -0
- package/dist/commonjs/models/entitypayoutresponse.js +82 -0
- package/dist/commonjs/models/entitypayoutresponse.js.map +1 -0
- package/dist/commonjs/models/entitywebhookevent.d.ts +8 -2
- package/dist/commonjs/models/entitywebhookevent.d.ts.map +1 -1
- package/dist/commonjs/models/entitywebhookevent.js +8 -0
- package/dist/commonjs/models/entitywebhookevent.js.map +1 -1
- package/dist/commonjs/models/index.d.ts +6 -0
- package/dist/commonjs/models/index.d.ts.map +1 -1
- package/dist/commonjs/models/index.js +6 -0
- package/dist/commonjs/models/index.js.map +1 -1
- package/dist/commonjs/models/listentitypayout.d.ts +98 -0
- package/dist/commonjs/models/listentitypayout.d.ts.map +1 -0
- package/dist/commonjs/models/listentitypayout.js +81 -0
- package/dist/commonjs/models/listentitypayout.js.map +1 -0
- package/dist/commonjs/models/operations/cancelpayout.d.ts +43 -0
- package/dist/commonjs/models/operations/cancelpayout.d.ts.map +1 -0
- package/dist/commonjs/models/operations/cancelpayout.js +57 -0
- package/dist/commonjs/models/operations/cancelpayout.js.map +1 -0
- package/dist/commonjs/models/operations/createpayout.d.ts +41 -0
- package/dist/commonjs/models/operations/createpayout.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createpayout.js +59 -0
- package/dist/commonjs/models/operations/createpayout.js.map +1 -0
- package/dist/commonjs/models/operations/getpayout.d.ts +43 -0
- package/dist/commonjs/models/operations/getpayout.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getpayout.js +57 -0
- package/dist/commonjs/models/operations/getpayout.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +4 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +4 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/listpayouts.d.ts +114 -0
- package/dist/commonjs/models/operations/listpayouts.d.ts.map +1 -0
- package/dist/commonjs/models/operations/listpayouts.js +97 -0
- package/dist/commonjs/models/operations/listpayouts.js.map +1 -0
- package/dist/commonjs/models/payoutrequest.d.ts +45 -0
- package/dist/commonjs/models/payoutrequest.d.ts.map +1 -0
- package/dist/commonjs/models/payoutrequest.js +54 -0
- package/dist/commonjs/models/payoutrequest.js.map +1 -0
- package/dist/commonjs/models/payoutstatus.d.ts +20 -0
- package/dist/commonjs/models/payoutstatus.d.ts.map +1 -0
- package/dist/commonjs/models/payoutstatus.js +55 -0
- package/dist/commonjs/models/payoutstatus.js.map +1 -0
- package/dist/commonjs/models/payoutstatusreason.d.ts +21 -0
- package/dist/commonjs/models/payoutstatusreason.d.ts.map +1 -0
- package/dist/commonjs/models/payoutstatusreason.js +53 -0
- package/dist/commonjs/models/payoutstatusreason.js.map +1 -0
- package/dist/commonjs/models/payoutstatusreasoncode.d.ts +28 -0
- package/dist/commonjs/models/payoutstatusreasoncode.d.ts.map +1 -0
- package/dist/commonjs/models/payoutstatusreasoncode.js +63 -0
- package/dist/commonjs/models/payoutstatusreasoncode.js.map +1 -0
- package/dist/commonjs/models/webhookeventtypes.d.ts +5 -0
- package/dist/commonjs/models/webhookeventtypes.d.ts.map +1 -1
- package/dist/commonjs/models/webhookeventtypes.js +5 -0
- package/dist/commonjs/models/webhookeventtypes.js.map +1 -1
- package/dist/commonjs/sdk/payouts.d.ts +81 -0
- package/dist/commonjs/sdk/payouts.d.ts.map +1 -0
- package/dist/commonjs/sdk/payouts.js +98 -0
- package/dist/commonjs/sdk/payouts.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +3 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +4 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/esm/funcs/payoutsCancel.d.ts +22 -0
- package/dist/esm/funcs/payoutsCancel.d.ts.map +1 -0
- package/dist/esm/funcs/payoutsCancel.js +111 -0
- package/dist/esm/funcs/payoutsCancel.js.map +1 -0
- package/dist/esm/funcs/payoutsCreate.d.ts +54 -0
- package/dist/esm/funcs/payoutsCreate.d.ts.map +1 -0
- package/dist/esm/funcs/payoutsCreate.js +138 -0
- package/dist/esm/funcs/payoutsCreate.js.map +1 -0
- package/dist/esm/funcs/payoutsGet.d.ts +19 -0
- package/dist/esm/funcs/payoutsGet.d.ts.map +1 -0
- package/dist/esm/funcs/payoutsGet.js +108 -0
- package/dist/esm/funcs/payoutsGet.js.map +1 -0
- package/dist/esm/funcs/payoutsList.d.ts +29 -0
- package/dist/esm/funcs/payoutsList.d.ts.map +1 -0
- package/dist/esm/funcs/payoutsList.js +146 -0
- package/dist/esm/funcs/payoutsList.js.map +1 -0
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/entitypayoutresponse.d.ts +102 -0
- package/dist/esm/models/entitypayoutresponse.d.ts.map +1 -0
- package/dist/esm/models/entitypayoutresponse.js +44 -0
- package/dist/esm/models/entitypayoutresponse.js.map +1 -0
- package/dist/esm/models/entitywebhookevent.d.ts +8 -2
- package/dist/esm/models/entitywebhookevent.d.ts.map +1 -1
- package/dist/esm/models/entitywebhookevent.js +8 -0
- package/dist/esm/models/entitywebhookevent.js.map +1 -1
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.d.ts.map +1 -1
- package/dist/esm/models/index.js +6 -0
- package/dist/esm/models/index.js.map +1 -1
- package/dist/esm/models/listentitypayout.d.ts +98 -0
- package/dist/esm/models/listentitypayout.d.ts.map +1 -0
- package/dist/esm/models/listentitypayout.js +43 -0
- package/dist/esm/models/listentitypayout.js.map +1 -0
- package/dist/esm/models/operations/cancelpayout.d.ts +43 -0
- package/dist/esm/models/operations/cancelpayout.d.ts.map +1 -0
- package/dist/esm/models/operations/cancelpayout.js +20 -0
- package/dist/esm/models/operations/cancelpayout.js.map +1 -0
- package/dist/esm/models/operations/createpayout.d.ts +41 -0
- package/dist/esm/models/operations/createpayout.d.ts.map +1 -0
- package/dist/esm/models/operations/createpayout.js +22 -0
- package/dist/esm/models/operations/createpayout.js.map +1 -0
- package/dist/esm/models/operations/getpayout.d.ts +43 -0
- package/dist/esm/models/operations/getpayout.d.ts.map +1 -0
- package/dist/esm/models/operations/getpayout.js +20 -0
- package/dist/esm/models/operations/getpayout.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +4 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +4 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/listpayouts.d.ts +114 -0
- package/dist/esm/models/operations/listpayouts.d.ts.map +1 -0
- package/dist/esm/models/operations/listpayouts.js +57 -0
- package/dist/esm/models/operations/listpayouts.js.map +1 -0
- package/dist/esm/models/payoutrequest.d.ts +45 -0
- package/dist/esm/models/payoutrequest.d.ts.map +1 -0
- package/dist/esm/models/payoutrequest.js +17 -0
- package/dist/esm/models/payoutrequest.js.map +1 -0
- package/dist/esm/models/payoutstatus.d.ts +20 -0
- package/dist/esm/models/payoutstatus.d.ts.map +1 -0
- package/dist/esm/models/payoutstatus.js +19 -0
- package/dist/esm/models/payoutstatus.js.map +1 -0
- package/dist/esm/models/payoutstatusreason.d.ts +21 -0
- package/dist/esm/models/payoutstatusreason.d.ts.map +1 -0
- package/dist/esm/models/payoutstatusreason.js +16 -0
- package/dist/esm/models/payoutstatusreason.js.map +1 -0
- package/dist/esm/models/payoutstatusreasoncode.d.ts +28 -0
- package/dist/esm/models/payoutstatusreasoncode.d.ts.map +1 -0
- package/dist/esm/models/payoutstatusreasoncode.js +27 -0
- package/dist/esm/models/payoutstatusreasoncode.js.map +1 -0
- package/dist/esm/models/webhookeventtypes.d.ts +5 -0
- package/dist/esm/models/webhookeventtypes.d.ts.map +1 -1
- package/dist/esm/models/webhookeventtypes.js +5 -0
- package/dist/esm/models/webhookeventtypes.js.map +1 -1
- package/dist/esm/sdk/payouts.d.ts +81 -0
- package/dist/esm/sdk/payouts.d.ts.map +1 -0
- package/dist/esm/sdk/payouts.js +94 -0
- package/dist/esm/sdk/payouts.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +3 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +4 -0
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/payoutsCancel.ts +204 -0
- package/src/funcs/payoutsCreate.ts +231 -0
- package/src/funcs/payoutsGet.ts +201 -0
- package/src/funcs/payoutsList.ts +278 -0
- package/src/lib/config.ts +2 -2
- package/src/models/entitypayoutresponse.ts +165 -0
- package/src/models/entitywebhookevent.ts +13 -0
- package/src/models/index.ts +6 -0
- package/src/models/listentitypayout.ts +160 -0
- package/src/models/operations/cancelpayout.ts +71 -0
- package/src/models/operations/createpayout.ts +70 -0
- package/src/models/operations/getpayout.ts +71 -0
- package/src/models/operations/index.ts +4 -0
- package/src/models/operations/listpayouts.ts +208 -0
- package/src/models/payoutrequest.ts +68 -0
- package/src/models/payoutstatus.ts +31 -0
- package/src/models/payoutstatusreason.ts +47 -0
- package/src/models/payoutstatusreasoncode.ts +39 -0
- package/src/models/webhookeventtypes.ts +5 -0
- package/src/sdk/payouts.ts +128 -0
- package/src/sdk/sdk.ts +6 -0
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import * as z from "zod/v3";
|
|
2
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
3
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
4
|
+
import * as models from "../index.js";
|
|
5
|
+
export type ListPayoutsGlobals = {
|
|
6
|
+
/**
|
|
7
|
+
* Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
8
|
+
*
|
|
9
|
+
* @remarks
|
|
10
|
+
* parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
11
|
+
* setting the `testmode` query parameter to `true`.
|
|
12
|
+
*
|
|
13
|
+
* Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
14
|
+
*/
|
|
15
|
+
testmode?: boolean | undefined;
|
|
16
|
+
};
|
|
17
|
+
export type ListPayoutsRequest = {
|
|
18
|
+
/**
|
|
19
|
+
* Return only payouts for the balance with the given ID. The value must be a valid balance
|
|
20
|
+
*
|
|
21
|
+
* @remarks
|
|
22
|
+
* token in the format `bal_*`.
|
|
23
|
+
*/
|
|
24
|
+
balanceId?: string | null | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
|
|
27
|
+
*
|
|
28
|
+
* @remarks
|
|
29
|
+
* result set.
|
|
30
|
+
*/
|
|
31
|
+
from?: string | null | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* The maximum number of items to return. Defaults to 50 items.
|
|
34
|
+
*/
|
|
35
|
+
limit?: number | null | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
|
|
38
|
+
*
|
|
39
|
+
* @remarks
|
|
40
|
+
* newest to oldest.
|
|
41
|
+
*/
|
|
42
|
+
sort?: models.Sorting | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
|
|
45
|
+
*
|
|
46
|
+
* @remarks
|
|
47
|
+
* parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by
|
|
48
|
+
* setting the `testmode` query parameter to `true`.
|
|
49
|
+
*
|
|
50
|
+
* Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
|
|
51
|
+
*/
|
|
52
|
+
testmode?: boolean | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* A unique key to ensure idempotent requests. This key should be a UUID v4 string.
|
|
55
|
+
*/
|
|
56
|
+
idempotencyKey?: string | undefined;
|
|
57
|
+
};
|
|
58
|
+
export type ListPayoutsEmbedded = {
|
|
59
|
+
/**
|
|
60
|
+
* An array of payout objects. For a complete reference of the payout object, refer to the
|
|
61
|
+
*
|
|
62
|
+
* @remarks
|
|
63
|
+
* [Get payout endpoint](get-payout) documentation.
|
|
64
|
+
*/
|
|
65
|
+
payouts: Array<models.ListEntityPayout>;
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* A list of payout objects. For a complete reference of the payout object, refer to the
|
|
69
|
+
*
|
|
70
|
+
* @remarks
|
|
71
|
+
* [Get payout endpoint](get-payout) documentation.
|
|
72
|
+
*/
|
|
73
|
+
export type ListPayoutsResponseBody = {
|
|
74
|
+
/**
|
|
75
|
+
* The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
|
|
76
|
+
*
|
|
77
|
+
* @remarks
|
|
78
|
+
* as well.
|
|
79
|
+
*
|
|
80
|
+
* The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
|
|
81
|
+
* limit is 50 items.
|
|
82
|
+
*/
|
|
83
|
+
count: number;
|
|
84
|
+
embedded: ListPayoutsEmbedded;
|
|
85
|
+
/**
|
|
86
|
+
* Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.
|
|
87
|
+
*/
|
|
88
|
+
links: models.ListLinks;
|
|
89
|
+
};
|
|
90
|
+
export type ListPayoutsResponse = {
|
|
91
|
+
result: ListPayoutsResponseBody;
|
|
92
|
+
};
|
|
93
|
+
/** @internal */
|
|
94
|
+
export type ListPayoutsRequest$Outbound = {
|
|
95
|
+
balanceId?: string | null | undefined;
|
|
96
|
+
from?: string | null | undefined;
|
|
97
|
+
limit?: number | null | undefined;
|
|
98
|
+
sort?: string | undefined;
|
|
99
|
+
testmode?: boolean | undefined;
|
|
100
|
+
"idempotency-key"?: string | undefined;
|
|
101
|
+
};
|
|
102
|
+
/** @internal */
|
|
103
|
+
export declare const ListPayoutsRequest$outboundSchema: z.ZodType<ListPayoutsRequest$Outbound, z.ZodTypeDef, ListPayoutsRequest>;
|
|
104
|
+
export declare function listPayoutsRequestToJSON(listPayoutsRequest: ListPayoutsRequest): string;
|
|
105
|
+
/** @internal */
|
|
106
|
+
export declare const ListPayoutsEmbedded$inboundSchema: z.ZodType<ListPayoutsEmbedded, z.ZodTypeDef, unknown>;
|
|
107
|
+
export declare function listPayoutsEmbeddedFromJSON(jsonString: string): SafeParseResult<ListPayoutsEmbedded, SDKValidationError>;
|
|
108
|
+
/** @internal */
|
|
109
|
+
export declare const ListPayoutsResponseBody$inboundSchema: z.ZodType<ListPayoutsResponseBody, z.ZodTypeDef, unknown>;
|
|
110
|
+
export declare function listPayoutsResponseBodyFromJSON(jsonString: string): SafeParseResult<ListPayoutsResponseBody, SDKValidationError>;
|
|
111
|
+
/** @internal */
|
|
112
|
+
export declare const ListPayoutsResponse$inboundSchema: z.ZodType<ListPayoutsResponse, z.ZodTypeDef, unknown>;
|
|
113
|
+
export declare function listPayoutsResponseFromJSON(jsonString: string): SafeParseResult<ListPayoutsResponse, SDKValidationError>;
|
|
114
|
+
//# sourceMappingURL=listpayouts.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"listpayouts.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/listpayouts.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAClC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAClC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;;OAKG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;CACzC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;;;;;;;OAQG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,mBAAmB,CAAC;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,uBAAuB,CAAC;CACjC,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,2BAA2B,GAAG;IACxC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACxC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,kBAAkB,CAYlB,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,kBAAkB,EAAE,kBAAkB,GACrC,MAAM,CAIR;AAED,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAGP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D;AAED,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAUP,CAAC;AAEH,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAM9D;AAED,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
* @generated-id: 2417fe06d050
|
|
4
|
+
*/
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { remap as remap$ } from "../../lib/primitives.js";
|
|
7
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
8
|
+
import * as models from "../index.js";
|
|
9
|
+
/** @internal */
|
|
10
|
+
export const ListPayoutsRequest$outboundSchema = z.object({
|
|
11
|
+
balanceId: z.nullable(z.string()).optional(),
|
|
12
|
+
from: z.nullable(z.string()).optional(),
|
|
13
|
+
limit: z.nullable(z.number().int()).optional(),
|
|
14
|
+
sort: models.Sorting$outboundSchema.optional(),
|
|
15
|
+
testmode: z.boolean().optional(),
|
|
16
|
+
idempotencyKey: z.string().optional(),
|
|
17
|
+
}).transform((v) => {
|
|
18
|
+
return remap$(v, {
|
|
19
|
+
idempotencyKey: "idempotency-key",
|
|
20
|
+
});
|
|
21
|
+
});
|
|
22
|
+
export function listPayoutsRequestToJSON(listPayoutsRequest) {
|
|
23
|
+
return JSON.stringify(ListPayoutsRequest$outboundSchema.parse(listPayoutsRequest));
|
|
24
|
+
}
|
|
25
|
+
/** @internal */
|
|
26
|
+
export const ListPayoutsEmbedded$inboundSchema = z.object({
|
|
27
|
+
payouts: z.array(models.ListEntityPayout$inboundSchema),
|
|
28
|
+
});
|
|
29
|
+
export function listPayoutsEmbeddedFromJSON(jsonString) {
|
|
30
|
+
return safeParse(jsonString, (x) => ListPayoutsEmbedded$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListPayoutsEmbedded' from JSON`);
|
|
31
|
+
}
|
|
32
|
+
/** @internal */
|
|
33
|
+
export const ListPayoutsResponseBody$inboundSchema = z.object({
|
|
34
|
+
count: z.number().int(),
|
|
35
|
+
_embedded: z.lazy(() => ListPayoutsEmbedded$inboundSchema),
|
|
36
|
+
_links: models.ListLinks$inboundSchema,
|
|
37
|
+
}).transform((v) => {
|
|
38
|
+
return remap$(v, {
|
|
39
|
+
"_embedded": "embedded",
|
|
40
|
+
"_links": "links",
|
|
41
|
+
});
|
|
42
|
+
});
|
|
43
|
+
export function listPayoutsResponseBodyFromJSON(jsonString) {
|
|
44
|
+
return safeParse(jsonString, (x) => ListPayoutsResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListPayoutsResponseBody' from JSON`);
|
|
45
|
+
}
|
|
46
|
+
/** @internal */
|
|
47
|
+
export const ListPayoutsResponse$inboundSchema = z.object({
|
|
48
|
+
Result: z.lazy(() => ListPayoutsResponseBody$inboundSchema),
|
|
49
|
+
}).transform((v) => {
|
|
50
|
+
return remap$(v, {
|
|
51
|
+
"Result": "result",
|
|
52
|
+
});
|
|
53
|
+
});
|
|
54
|
+
export function listPayoutsResponseFromJSON(jsonString) {
|
|
55
|
+
return safeParse(jsonString, (x) => ListPayoutsResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListPayoutsResponse' from JSON`);
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=listpayouts.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"listpayouts.js","sourceRoot":"","sources":["../../../../src/models/operations/listpayouts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGjD,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAyGtC,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC9C,IAAI,EAAE,MAAM,CAAC,sBAAsB,CAAC,QAAQ,EAAE;IAC9C,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,iBAAiB;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,wBAAwB,CACtC,kBAAsC;IAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,iCAAiC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAC5D,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,8BAA8B,CAAC;CACxD,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAI9C,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvB,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,iCAAiC,CAAC;IAC1D,MAAM,EAAE,MAAM,CAAC,uBAAuB;CACvC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,WAAW,EAAE,UAAU;QACvB,QAAQ,EAAE,OAAO;KAClB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,+BAA+B,CAC7C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qCAAqC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjE,qDAAqD,CACtD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qCAAqC,CAAC;CAC5D,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,QAAQ,EAAE,QAAQ;KACnB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import * as z from "zod/v3";
|
|
2
|
+
import { AmountNullable, AmountNullable$Outbound } from "./amountnullable.js";
|
|
3
|
+
export type PayoutRequest = {
|
|
4
|
+
/**
|
|
5
|
+
* The identifier of the balance that will be paid out. Example: `bal_gVMhHKqSSRYJyPsuoPNFH`.
|
|
6
|
+
*/
|
|
7
|
+
balanceId: string;
|
|
8
|
+
/**
|
|
9
|
+
* The amount to pay out. When omitted from the request, the full available balance minus any configured
|
|
10
|
+
*
|
|
11
|
+
* @remarks
|
|
12
|
+
* balance reserve is paid out.
|
|
13
|
+
*
|
|
14
|
+
* Merchants registered in the United Kingdom cannot specify a custom amount — omit this field to pay out
|
|
15
|
+
* the full available balance.
|
|
16
|
+
*
|
|
17
|
+
* The value in the response reflects the amount paid out, excluding any applicable fees.
|
|
18
|
+
*/
|
|
19
|
+
amount?: AmountNullable | null | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* The description that will appear on the bank statement for this payout.
|
|
22
|
+
*/
|
|
23
|
+
description?: string | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* Whether to create the entity in test mode or live mode.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
*
|
|
29
|
+
* Most API credentials are specifically created for either live mode or test mode, in which case this parameter must
|
|
30
|
+
* not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
|
|
31
|
+
* `testmode` to `true`.
|
|
32
|
+
*/
|
|
33
|
+
testmode?: boolean | null | undefined;
|
|
34
|
+
};
|
|
35
|
+
/** @internal */
|
|
36
|
+
export type PayoutRequest$Outbound = {
|
|
37
|
+
balanceId: string;
|
|
38
|
+
amount?: AmountNullable$Outbound | null | undefined;
|
|
39
|
+
description?: string | undefined;
|
|
40
|
+
testmode?: boolean | null | undefined;
|
|
41
|
+
};
|
|
42
|
+
/** @internal */
|
|
43
|
+
export declare const PayoutRequest$outboundSchema: z.ZodType<PayoutRequest$Outbound, z.ZodTypeDef, PayoutRequest>;
|
|
44
|
+
export declare function payoutRequestToJSON(payoutRequest: PayoutRequest): string;
|
|
45
|
+
//# sourceMappingURL=payoutrequest.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payoutrequest.d.ts","sourceRoot":"","sources":["../../../src/models/payoutrequest.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,cAAc,EACd,uBAAuB,EAExB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,GAAG,SAAS,CAAC;IACpD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,aAAa,CAMb,CAAC;AAEH,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAExE"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
* @generated-id: 39795b6f75e2
|
|
4
|
+
*/
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { AmountNullable$outboundSchema, } from "./amountnullable.js";
|
|
7
|
+
/** @internal */
|
|
8
|
+
export const PayoutRequest$outboundSchema = z.object({
|
|
9
|
+
balanceId: z.string(),
|
|
10
|
+
amount: z.nullable(AmountNullable$outboundSchema).optional(),
|
|
11
|
+
description: z.string().optional(),
|
|
12
|
+
testmode: z.nullable(z.boolean()).optional(),
|
|
13
|
+
});
|
|
14
|
+
export function payoutRequestToJSON(payoutRequest) {
|
|
15
|
+
return JSON.stringify(PayoutRequest$outboundSchema.parse(payoutRequest));
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=payoutrequest.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payoutrequest.js","sourceRoot":"","sources":["../../../src/models/payoutrequest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAGL,6BAA6B,GAC9B,MAAM,qBAAqB,CAAC;AA2C7B,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC,QAAQ,EAAE;IAC5D,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAEH,MAAM,UAAU,mBAAmB,CAAC,aAA4B;IAC9D,OAAO,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;AAC3E,CAAC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import * as z from "zod/v3";
|
|
2
|
+
import { OpenEnum } from "../types/enums.js";
|
|
3
|
+
/**
|
|
4
|
+
* The status of the payout.
|
|
5
|
+
*/
|
|
6
|
+
export declare const PayoutStatus: {
|
|
7
|
+
readonly Requested: "requested";
|
|
8
|
+
readonly Initiated: "initiated";
|
|
9
|
+
readonly ProcessingAtBank: "processing-at-bank";
|
|
10
|
+
readonly Completed: "completed";
|
|
11
|
+
readonly Failed: "failed";
|
|
12
|
+
readonly Canceled: "canceled";
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* The status of the payout.
|
|
16
|
+
*/
|
|
17
|
+
export type PayoutStatus = OpenEnum<typeof PayoutStatus>;
|
|
18
|
+
/** @internal */
|
|
19
|
+
export declare const PayoutStatus$inboundSchema: z.ZodType<PayoutStatus, z.ZodTypeDef, unknown>;
|
|
20
|
+
//# sourceMappingURL=payoutstatus.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payoutstatus.d.ts","sourceRoot":"","sources":["../../../src/models/payoutstatus.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;CAOf,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAEzD,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CACgC,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
* @generated-id: c35fe9ae063d
|
|
4
|
+
*/
|
|
5
|
+
import * as openEnums from "../types/enums.js";
|
|
6
|
+
/**
|
|
7
|
+
* The status of the payout.
|
|
8
|
+
*/
|
|
9
|
+
export const PayoutStatus = {
|
|
10
|
+
Requested: "requested",
|
|
11
|
+
Initiated: "initiated",
|
|
12
|
+
ProcessingAtBank: "processing-at-bank",
|
|
13
|
+
Completed: "completed",
|
|
14
|
+
Failed: "failed",
|
|
15
|
+
Canceled: "canceled",
|
|
16
|
+
};
|
|
17
|
+
/** @internal */
|
|
18
|
+
export const PayoutStatus$inboundSchema = openEnums.inboundSchema(PayoutStatus);
|
|
19
|
+
//# sourceMappingURL=payoutstatus.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payoutstatus.js","sourceRoot":"","sources":["../../../src/models/payoutstatus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,SAAS,MAAM,mBAAmB,CAAC;AAG/C;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,gBAAgB,EAAE,oBAAoB;IACtC,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAMX,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import * as z from "zod/v3";
|
|
2
|
+
import { Result as SafeParseResult } from "../types/fp.js";
|
|
3
|
+
import { SDKValidationError } from "./errors/sdkvalidationerror.js";
|
|
4
|
+
import { PayoutStatusReasonCode } from "./payoutstatusreasoncode.js";
|
|
5
|
+
/**
|
|
6
|
+
* The reason for the payout's current status.
|
|
7
|
+
*/
|
|
8
|
+
export type PayoutStatusReason = {
|
|
9
|
+
/**
|
|
10
|
+
* A machine-readable code describing the reason for the payout's current status.
|
|
11
|
+
*/
|
|
12
|
+
code: PayoutStatusReasonCode;
|
|
13
|
+
/**
|
|
14
|
+
* A human-readable description of the status reason.
|
|
15
|
+
*/
|
|
16
|
+
message: string;
|
|
17
|
+
};
|
|
18
|
+
/** @internal */
|
|
19
|
+
export declare const PayoutStatusReason$inboundSchema: z.ZodType<PayoutStatusReason, z.ZodTypeDef, unknown>;
|
|
20
|
+
export declare function payoutStatusReasonFromJSON(jsonString: string): SafeParseResult<PayoutStatusReason, SDKValidationError>;
|
|
21
|
+
//# sourceMappingURL=payoutstatusreason.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payoutstatusreason.d.ts","sourceRoot":"","sources":["../../../src/models/payoutstatusreason.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EACL,sBAAsB,EAEvB,MAAM,6BAA6B,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
* @generated-id: c4c4247c41f9
|
|
4
|
+
*/
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../lib/schemas.js";
|
|
7
|
+
import { PayoutStatusReasonCode$inboundSchema, } from "./payoutstatusreasoncode.js";
|
|
8
|
+
/** @internal */
|
|
9
|
+
export const PayoutStatusReason$inboundSchema = z.object({
|
|
10
|
+
code: PayoutStatusReasonCode$inboundSchema,
|
|
11
|
+
message: z.string(),
|
|
12
|
+
});
|
|
13
|
+
export function payoutStatusReasonFromJSON(jsonString) {
|
|
14
|
+
return safeParse(jsonString, (x) => PayoutStatusReason$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PayoutStatusReason' from JSON`);
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=payoutstatusreason.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payoutstatusreason.js","sourceRoot":"","sources":["../../../src/models/payoutstatusreason.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAG9C,OAAO,EAEL,oCAAoC,GACrC,MAAM,6BAA6B,CAAC;AAgBrC,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,oCAAoC;IAC1C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import * as z from "zod/v3";
|
|
2
|
+
import { OpenEnum } from "../types/enums.js";
|
|
3
|
+
/**
|
|
4
|
+
* A machine-readable code describing the reason for the payout's current status.
|
|
5
|
+
*/
|
|
6
|
+
export declare const PayoutStatusReasonCode: {
|
|
7
|
+
readonly Requested: "requested";
|
|
8
|
+
readonly Initiated: "initiated";
|
|
9
|
+
readonly ProcessingAtBank: "processing_at_bank";
|
|
10
|
+
readonly Completed: "completed";
|
|
11
|
+
readonly Canceled: "canceled";
|
|
12
|
+
readonly Failed: "failed";
|
|
13
|
+
readonly InsufficientFunds: "insufficient_funds";
|
|
14
|
+
readonly Returned: "returned";
|
|
15
|
+
readonly InvalidRequest: "invalid_request";
|
|
16
|
+
readonly OrganizationInactive: "organization_inactive";
|
|
17
|
+
readonly PayoutsBlocked: "payouts_blocked";
|
|
18
|
+
readonly BankProcessingFailed: "bank_processing_failed";
|
|
19
|
+
readonly BalanceNotFound: "balance_not_found";
|
|
20
|
+
readonly Expired: "expired";
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* A machine-readable code describing the reason for the payout's current status.
|
|
24
|
+
*/
|
|
25
|
+
export type PayoutStatusReasonCode = OpenEnum<typeof PayoutStatusReasonCode>;
|
|
26
|
+
/** @internal */
|
|
27
|
+
export declare const PayoutStatusReasonCode$inboundSchema: z.ZodType<PayoutStatusReasonCode, z.ZodTypeDef, unknown>;
|
|
28
|
+
//# sourceMappingURL=payoutstatusreasoncode.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payoutstatusreasoncode.d.ts","sourceRoot":"","sources":["../../../src/models/payoutstatusreasoncode.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;CAezB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,QAAQ,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAE7E,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,OAAO,CAC0C,CAAC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
* @generated-id: 1ee305eaa864
|
|
4
|
+
*/
|
|
5
|
+
import * as openEnums from "../types/enums.js";
|
|
6
|
+
/**
|
|
7
|
+
* A machine-readable code describing the reason for the payout's current status.
|
|
8
|
+
*/
|
|
9
|
+
export const PayoutStatusReasonCode = {
|
|
10
|
+
Requested: "requested",
|
|
11
|
+
Initiated: "initiated",
|
|
12
|
+
ProcessingAtBank: "processing_at_bank",
|
|
13
|
+
Completed: "completed",
|
|
14
|
+
Canceled: "canceled",
|
|
15
|
+
Failed: "failed",
|
|
16
|
+
InsufficientFunds: "insufficient_funds",
|
|
17
|
+
Returned: "returned",
|
|
18
|
+
InvalidRequest: "invalid_request",
|
|
19
|
+
OrganizationInactive: "organization_inactive",
|
|
20
|
+
PayoutsBlocked: "payouts_blocked",
|
|
21
|
+
BankProcessingFailed: "bank_processing_failed",
|
|
22
|
+
BalanceNotFound: "balance_not_found",
|
|
23
|
+
Expired: "expired",
|
|
24
|
+
};
|
|
25
|
+
/** @internal */
|
|
26
|
+
export const PayoutStatusReasonCode$inboundSchema = openEnums.inboundSchema(PayoutStatusReasonCode);
|
|
27
|
+
//# sourceMappingURL=payoutstatusreasoncode.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payoutstatusreasoncode.js","sourceRoot":"","sources":["../../../src/models/payoutstatusreasoncode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,SAAS,MAAM,mBAAmB,CAAC;AAG/C;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,gBAAgB,EAAE,oBAAoB;IACtC,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,iBAAiB,EAAE,oBAAoB;IACvC,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,iBAAiB;IACjC,oBAAoB,EAAE,uBAAuB;IAC7C,cAAc,EAAE,iBAAiB;IACjC,oBAAoB,EAAE,wBAAwB;IAC9C,eAAe,EAAE,mBAAmB;IACpC,OAAO,EAAE,SAAS;CACV,CAAC;AAMX,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAI7C,SAAS,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC"}
|
|
@@ -9,6 +9,11 @@ import { ClosedEnum } from "../types/enums.js";
|
|
|
9
9
|
export declare const WebhookEventTypes: {
|
|
10
10
|
readonly PaymentLinkPaid: "payment-link.paid";
|
|
11
11
|
readonly BalanceTransactionCreated: "balance-transaction.created";
|
|
12
|
+
readonly PayoutInitiated: "payout.initiated";
|
|
13
|
+
readonly PayoutProcessingAtBank: "payout.processing-at-bank";
|
|
14
|
+
readonly PayoutCompleted: "payout.completed";
|
|
15
|
+
readonly PayoutCanceled: "payout.canceled";
|
|
16
|
+
readonly PayoutFailed: "payout.failed";
|
|
12
17
|
readonly SalesInvoiceCreated: "sales-invoice.created";
|
|
13
18
|
readonly SalesInvoiceIssued: "sales-invoice.issued";
|
|
14
19
|
readonly SalesInvoiceCanceled: "sales-invoice.canceled";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"webhookeventtypes.d.ts","sourceRoot":"","sources":["../../../src/models/webhookeventtypes.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB
|
|
1
|
+
{"version":3,"file":"webhookeventtypes.d.ts","sourceRoot":"","sources":["../../../src/models/webhookeventtypes.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;CAqBpB,CAAC;AACX;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErE,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,aAAa,CAC3D,OAAO,iBAAiB,CACS,CAAC;AACpC,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,aAAa,CAC5D,OAAO,iBAAiB,CACS,CAAC"}
|
|
@@ -12,6 +12,11 @@ import * as z from "zod/v3";
|
|
|
12
12
|
export const WebhookEventTypes = {
|
|
13
13
|
PaymentLinkPaid: "payment-link.paid",
|
|
14
14
|
BalanceTransactionCreated: "balance-transaction.created",
|
|
15
|
+
PayoutInitiated: "payout.initiated",
|
|
16
|
+
PayoutProcessingAtBank: "payout.processing-at-bank",
|
|
17
|
+
PayoutCompleted: "payout.completed",
|
|
18
|
+
PayoutCanceled: "payout.canceled",
|
|
19
|
+
PayoutFailed: "payout.failed",
|
|
15
20
|
SalesInvoiceCreated: "sales-invoice.created",
|
|
16
21
|
SalesInvoiceIssued: "sales-invoice.issued",
|
|
17
22
|
SalesInvoiceCanceled: "sales-invoice.canceled",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"webhookeventtypes.js","sourceRoot":"","sources":["../../../src/models/webhookeventtypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,eAAe,EAAE,mBAAmB;IACpC,yBAAyB,EAAE,6BAA6B;IACxD,mBAAmB,EAAE,uBAAuB;IAC5C,kBAAkB,EAAE,sBAAsB;IAC1C,oBAAoB,EAAE,wBAAwB;IAC9C,gBAAgB,EAAE,oBAAoB;IACtC,gCAAgC,EAAE,qCAAqC;IACvE,gCAAgC,EAAE,qCAAqC;IACvE,oCAAoC,EAClC,0CAA0C;IAC5C,gCAAgC,EAAE,qCAAqC;IACvE,6BAA6B,EAAE,kCAAkC;IACjE,8BAA8B,EAAE,mCAAmC;IACnE,+BAA+B,EAAE,oCAAoC;IACrE,QAAQ,EAAE,GAAG;CACL,CAAC;AASX,gBAAgB;AAChB,MAAM,CAAC,MAAM,+BAA+B,GAExC,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;AACpC,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAEzC,+BAA+B,CAAC"}
|
|
1
|
+
{"version":3,"file":"webhookeventtypes.js","sourceRoot":"","sources":["../../../src/models/webhookeventtypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,eAAe,EAAE,mBAAmB;IACpC,yBAAyB,EAAE,6BAA6B;IACxD,eAAe,EAAE,kBAAkB;IACnC,sBAAsB,EAAE,2BAA2B;IACnD,eAAe,EAAE,kBAAkB;IACnC,cAAc,EAAE,iBAAiB;IACjC,YAAY,EAAE,eAAe;IAC7B,mBAAmB,EAAE,uBAAuB;IAC5C,kBAAkB,EAAE,sBAAsB;IAC1C,oBAAoB,EAAE,wBAAwB;IAC9C,gBAAgB,EAAE,oBAAoB;IACtC,gCAAgC,EAAE,qCAAqC;IACvE,gCAAgC,EAAE,qCAAqC;IACvE,oCAAoC,EAClC,0CAA0C;IAC5C,gCAAgC,EAAE,qCAAqC;IACvE,6BAA6B,EAAE,kCAAkC;IACjE,8BAA8B,EAAE,mCAAmC;IACnE,+BAA+B,EAAE,oCAAoC;IACrE,QAAQ,EAAE,GAAG;CACL,CAAC;AASX,gBAAgB;AAChB,MAAM,CAAC,MAAM,+BAA+B,GAExC,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;AACpC,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAEzC,+BAA+B,CAAC"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
2
|
+
import * as models from "../models/index.js";
|
|
3
|
+
import * as operations from "../models/operations/index.js";
|
|
4
|
+
import { PageIterator } from "../types/operations.js";
|
|
5
|
+
export declare class Payouts extends ClientSDK {
|
|
6
|
+
/**
|
|
7
|
+
* Create payout
|
|
8
|
+
*
|
|
9
|
+
* @remarks
|
|
10
|
+
* Request a payout from one of your balances to the balance's configured bank account.
|
|
11
|
+
*
|
|
12
|
+
* The payout will be executed on the next scheduled business day. If no `amount` is specified, the full available
|
|
13
|
+
* balance minus any configured balance reserve is paid out.
|
|
14
|
+
*
|
|
15
|
+
* Once the payout is created with status `requested`, you can cancel it via the
|
|
16
|
+
* [Cancel payout](cancel-payout) endpoint, up until the payout moves to `initiated`.
|
|
17
|
+
*
|
|
18
|
+
* Creating a payout via the API automatically sets the balance's `transferFrequency` to `never`,
|
|
19
|
+
* pausing any previously configured automatic settlement schedule. To resume automatic settlements,
|
|
20
|
+
* update the transfer frequency via the dashboard.
|
|
21
|
+
*
|
|
22
|
+
* ### Webhooks
|
|
23
|
+
*
|
|
24
|
+
* Subscribe to the following webhook events to track payout status changes. See the
|
|
25
|
+
* [Webhook Subscriptions API](list-webhooks) for details on subscribing.
|
|
26
|
+
*
|
|
27
|
+
* | Event | Description |
|
|
28
|
+
* |---|---|
|
|
29
|
+
* | `payout.initiated` | The payout is being executed and funds are reserved. |
|
|
30
|
+
* | `payout.processing-at-bank` | The payout has been submitted to the bank. |
|
|
31
|
+
* | `payout.completed` | The payout has been sent to the destination bank account. |
|
|
32
|
+
* | `payout.canceled` | The payout was canceled via the API before being submitted to the bank. |
|
|
33
|
+
* | `payout.failed` | The payout failed after creation, including bank rejections and post-submission cancellations. |
|
|
34
|
+
*
|
|
35
|
+
* ### Payout failure reasons
|
|
36
|
+
*
|
|
37
|
+
* A payout request may fail immediately if one of the following conditions applies:
|
|
38
|
+
*
|
|
39
|
+
* - A payout is already scheduled for the next business day for this balance.
|
|
40
|
+
* - The balance has insufficient funds.
|
|
41
|
+
* - The balance is not active.
|
|
42
|
+
* - Payouts are blocked for this organization.
|
|
43
|
+
* - The balance has queued refunds.
|
|
44
|
+
* - One of the organization's balances is below the negative balance threshold.
|
|
45
|
+
* - The payout destination (bank account) is invalid or not configured.
|
|
46
|
+
*/
|
|
47
|
+
create(request: operations.CreatePayoutRequest, options?: RequestOptions): Promise<models.EntityPayoutResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* List payouts
|
|
50
|
+
*
|
|
51
|
+
* @remarks
|
|
52
|
+
* Retrieve a list of all payouts for your organization, including payouts initiated automatically by the
|
|
53
|
+
* balance's payout schedule and payouts requested via the API or dashboard.
|
|
54
|
+
*
|
|
55
|
+
* Only payouts created on or after April 1st, 2026 are returned.
|
|
56
|
+
*
|
|
57
|
+
* The results are paginated. Use the `from` query parameter together with `_links.next` to iterate through
|
|
58
|
+
* the full result set.
|
|
59
|
+
*/
|
|
60
|
+
list(request?: operations.ListPayoutsRequest | undefined, options?: RequestOptions): Promise<PageIterator<operations.ListPayoutsResponse, {
|
|
61
|
+
url: string;
|
|
62
|
+
}>>;
|
|
63
|
+
/**
|
|
64
|
+
* Get payout
|
|
65
|
+
*
|
|
66
|
+
* @remarks
|
|
67
|
+
* Retrieve a single payout by its ID.
|
|
68
|
+
*/
|
|
69
|
+
get(request: operations.GetPayoutRequest, options?: RequestOptions): Promise<models.EntityPayoutResponse>;
|
|
70
|
+
/**
|
|
71
|
+
* Cancel payout
|
|
72
|
+
*
|
|
73
|
+
* @remarks
|
|
74
|
+
* Cancel a payout. A payout can only be canceled while it has the status `requested`. Once the payout moves
|
|
75
|
+
* to `initiated`, it is too late to cancel.
|
|
76
|
+
*
|
|
77
|
+
* The canceled payout object is returned with the status set to `canceled`.
|
|
78
|
+
*/
|
|
79
|
+
cancel(request: operations.CancelPayoutRequest, options?: RequestOptions): Promise<models.EntityPayoutResponse>;
|
|
80
|
+
}
|
|
81
|
+
//# sourceMappingURL=payouts.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payouts.d.ts","sourceRoot":"","sources":["../../../src/sdk/payouts.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,OAAQ,SAAQ,SAAS;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;IAQvC;;;;;;;;;;;OAWG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,UAAU,CAAC,kBAAkB,GAAG,SAAS,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,mBAAmB,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAQzE;;;;;OAKG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,gBAAgB,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;IAQvC;;;;;;;;OAQG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;CAOxC"}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
* @generated-id: 9d174eba7124
|
|
4
|
+
*/
|
|
5
|
+
import { payoutsCancel } from "../funcs/payoutsCancel.js";
|
|
6
|
+
import { payoutsCreate } from "../funcs/payoutsCreate.js";
|
|
7
|
+
import { payoutsGet } from "../funcs/payoutsGet.js";
|
|
8
|
+
import { payoutsList } from "../funcs/payoutsList.js";
|
|
9
|
+
import { ClientSDK } from "../lib/sdks.js";
|
|
10
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
11
|
+
import { unwrapResultIterator } from "../types/operations.js";
|
|
12
|
+
export class Payouts extends ClientSDK {
|
|
13
|
+
/**
|
|
14
|
+
* Create payout
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* Request a payout from one of your balances to the balance's configured bank account.
|
|
18
|
+
*
|
|
19
|
+
* The payout will be executed on the next scheduled business day. If no `amount` is specified, the full available
|
|
20
|
+
* balance minus any configured balance reserve is paid out.
|
|
21
|
+
*
|
|
22
|
+
* Once the payout is created with status `requested`, you can cancel it via the
|
|
23
|
+
* [Cancel payout](cancel-payout) endpoint, up until the payout moves to `initiated`.
|
|
24
|
+
*
|
|
25
|
+
* Creating a payout via the API automatically sets the balance's `transferFrequency` to `never`,
|
|
26
|
+
* pausing any previously configured automatic settlement schedule. To resume automatic settlements,
|
|
27
|
+
* update the transfer frequency via the dashboard.
|
|
28
|
+
*
|
|
29
|
+
* ### Webhooks
|
|
30
|
+
*
|
|
31
|
+
* Subscribe to the following webhook events to track payout status changes. See the
|
|
32
|
+
* [Webhook Subscriptions API](list-webhooks) for details on subscribing.
|
|
33
|
+
*
|
|
34
|
+
* | Event | Description |
|
|
35
|
+
* |---|---|
|
|
36
|
+
* | `payout.initiated` | The payout is being executed and funds are reserved. |
|
|
37
|
+
* | `payout.processing-at-bank` | The payout has been submitted to the bank. |
|
|
38
|
+
* | `payout.completed` | The payout has been sent to the destination bank account. |
|
|
39
|
+
* | `payout.canceled` | The payout was canceled via the API before being submitted to the bank. |
|
|
40
|
+
* | `payout.failed` | The payout failed after creation, including bank rejections and post-submission cancellations. |
|
|
41
|
+
*
|
|
42
|
+
* ### Payout failure reasons
|
|
43
|
+
*
|
|
44
|
+
* A payout request may fail immediately if one of the following conditions applies:
|
|
45
|
+
*
|
|
46
|
+
* - A payout is already scheduled for the next business day for this balance.
|
|
47
|
+
* - The balance has insufficient funds.
|
|
48
|
+
* - The balance is not active.
|
|
49
|
+
* - Payouts are blocked for this organization.
|
|
50
|
+
* - The balance has queued refunds.
|
|
51
|
+
* - One of the organization's balances is below the negative balance threshold.
|
|
52
|
+
* - The payout destination (bank account) is invalid or not configured.
|
|
53
|
+
*/
|
|
54
|
+
async create(request, options) {
|
|
55
|
+
return unwrapAsync(payoutsCreate(this, request, options));
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* List payouts
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
* Retrieve a list of all payouts for your organization, including payouts initiated automatically by the
|
|
62
|
+
* balance's payout schedule and payouts requested via the API or dashboard.
|
|
63
|
+
*
|
|
64
|
+
* Only payouts created on or after April 1st, 2026 are returned.
|
|
65
|
+
*
|
|
66
|
+
* The results are paginated. Use the `from` query parameter together with `_links.next` to iterate through
|
|
67
|
+
* the full result set.
|
|
68
|
+
*/
|
|
69
|
+
async list(request, options) {
|
|
70
|
+
return unwrapResultIterator(payoutsList(this, request, options));
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Get payout
|
|
74
|
+
*
|
|
75
|
+
* @remarks
|
|
76
|
+
* Retrieve a single payout by its ID.
|
|
77
|
+
*/
|
|
78
|
+
async get(request, options) {
|
|
79
|
+
return unwrapAsync(payoutsGet(this, request, options));
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Cancel payout
|
|
83
|
+
*
|
|
84
|
+
* @remarks
|
|
85
|
+
* Cancel a payout. A payout can only be canceled while it has the status `requested`. Once the payout moves
|
|
86
|
+
* to `initiated`, it is too late to cancel.
|
|
87
|
+
*
|
|
88
|
+
* The canceled payout object is returned with the status set to `canceled`.
|
|
89
|
+
*/
|
|
90
|
+
async cancel(request, options) {
|
|
91
|
+
return unwrapAsync(payoutsCancel(this, request, options));
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
//# sourceMappingURL=payouts.js.map
|