@gr4vy/sdk 1.5.8 → 1.6.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/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/models/components/checkoutsession.d.ts +15 -0
- package/models/components/checkoutsession.d.ts.map +1 -1
- package/models/components/checkoutsession.js +8 -0
- package/models/components/checkoutsession.js.map +1 -1
- package/models/components/checkoutsessioncreate.d.ts +15 -0
- package/models/components/checkoutsessioncreate.d.ts.map +1 -1
- package/models/components/checkoutsessioncreate.js +8 -0
- package/models/components/checkoutsessioncreate.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/config.ts +3 -3
- package/src/models/components/checkoutsession.ts +23 -0
- package/src/models/components/checkoutsessioncreate.ts +23 -0
- package/docs/sdks/all/README.md +0 -98
- package/docs/sdks/auditlogs/README.md +0 -100
- package/docs/sdks/balances/README.md +0 -123
- package/docs/sdks/buyers/README.md +0 -461
- package/docs/sdks/cardschemedefinitions/README.md +0 -96
- package/docs/sdks/checkoutsessions/README.md +0 -367
- package/docs/sdks/cryptogram/README.md +0 -103
- package/docs/sdks/digitalwallets/README.md +0 -465
- package/docs/sdks/domains/README.md +0 -197
- package/docs/sdks/events/README.md +0 -99
- package/docs/sdks/executions/README.md +0 -285
- package/docs/sdks/giftcards/README.md +0 -376
- package/docs/sdks/gr4vygiftcards/README.md +0 -98
- package/docs/sdks/gr4vypaymentmethods/README.md +0 -96
- package/docs/sdks/gr4vyrefunds/README.md +0 -279
- package/docs/sdks/jobs/README.md +0 -107
- package/docs/sdks/merchantaccounts/README.md +0 -382
- package/docs/sdks/networktokens/README.md +0 -467
- package/docs/sdks/paymentlinks/README.md +0 -381
- package/docs/sdks/paymentmethods/README.md +0 -376
- package/docs/sdks/paymentoptions/README.md +0 -97
- package/docs/sdks/paymentservicedefinitions/README.md +0 -281
- package/docs/sdks/paymentservices/README.md +0 -706
- package/docs/sdks/paymentservicetokens/README.md +0 -286
- package/docs/sdks/payouts/README.md +0 -298
- package/docs/sdks/refunds/README.md +0 -97
- package/docs/sdks/reportexecutions/README.md +0 -100
- package/docs/sdks/reports/README.md +0 -403
- package/docs/sdks/sessions/README.md +0 -289
- package/docs/sdks/settlements/README.md +0 -188
- package/docs/sdks/shippingdetails/README.md +0 -462
- package/docs/sdks/transactions/README.md +0 -752
- package/examples/README.md +0 -31
|
@@ -1,381 +0,0 @@
|
|
|
1
|
-
# PaymentLinks
|
|
2
|
-
(*paymentLinks*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [create](#create) - Add a payment link
|
|
9
|
-
* [list](#list) - List all payment links
|
|
10
|
-
* [expire](#expire) - Expire a payment link
|
|
11
|
-
* [get](#get) - Get payment link
|
|
12
|
-
|
|
13
|
-
## create
|
|
14
|
-
|
|
15
|
-
Create a new payment link.
|
|
16
|
-
|
|
17
|
-
### Example Usage
|
|
18
|
-
|
|
19
|
-
<!-- UsageSnippet language="typescript" operationID="add_payment_link" method="post" path="/payment-links" -->
|
|
20
|
-
```typescript
|
|
21
|
-
import { Gr4vy, withToken } from "@gr4vy/sdk";
|
|
22
|
-
import fs from "fs";
|
|
23
|
-
|
|
24
|
-
const gr4vy = new Gr4vy({
|
|
25
|
-
id: "example",
|
|
26
|
-
server: "sandbox",
|
|
27
|
-
merchantAccountId: "default",
|
|
28
|
-
bearerAuth: withToken({
|
|
29
|
-
privateKey: fs.readFileSync("private_key.pem", "utf8"),
|
|
30
|
-
}),
|
|
31
|
-
});
|
|
32
|
-
|
|
33
|
-
async function run() {
|
|
34
|
-
const result = await gr4vy.paymentLinks.create({
|
|
35
|
-
amount: 1299,
|
|
36
|
-
country: "DE",
|
|
37
|
-
currency: "EUR",
|
|
38
|
-
});
|
|
39
|
-
|
|
40
|
-
console.log(result);
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
run();
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### Standalone function
|
|
47
|
-
|
|
48
|
-
The standalone function version of this method:
|
|
49
|
-
|
|
50
|
-
```typescript
|
|
51
|
-
import { Gr4vyCore } from "@gr4vy/sdk/core.js";
|
|
52
|
-
import { paymentLinksCreate } from "@gr4vy/sdk/funcs/paymentLinksCreate.js";
|
|
53
|
-
|
|
54
|
-
// Use `Gr4vyCore` for best tree-shaking performance.
|
|
55
|
-
// You can create one instance of it to use across an application.
|
|
56
|
-
const gr4vy = new Gr4vyCore({
|
|
57
|
-
merchantAccountId: "<id>",
|
|
58
|
-
bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
|
|
59
|
-
});
|
|
60
|
-
|
|
61
|
-
async function run() {
|
|
62
|
-
const res = await paymentLinksCreate(gr4vy, {
|
|
63
|
-
amount: 1299,
|
|
64
|
-
country: "DE",
|
|
65
|
-
currency: "EUR",
|
|
66
|
-
});
|
|
67
|
-
if (res.ok) {
|
|
68
|
-
const { value: result } = res;
|
|
69
|
-
console.log(result);
|
|
70
|
-
} else {
|
|
71
|
-
console.log("paymentLinksCreate failed:", res.error);
|
|
72
|
-
}
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
run();
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### Parameters
|
|
79
|
-
|
|
80
|
-
| Parameter | Type | Required | Description |
|
|
81
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
82
|
-
| `paymentLinkCreate` | [components.PaymentLinkCreate](../../models/components/paymentlinkcreate.md) | :heavy_check_mark: | N/A |
|
|
83
|
-
| `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. |
|
|
84
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
85
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
86
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
87
|
-
|
|
88
|
-
### Response
|
|
89
|
-
|
|
90
|
-
**Promise\<[components.PaymentLink](../../models/components/paymentlink.md)\>**
|
|
91
|
-
|
|
92
|
-
### Errors
|
|
93
|
-
|
|
94
|
-
| Error Type | Status Code | Content Type |
|
|
95
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
96
|
-
| errors.Error400 | 400 | application/json |
|
|
97
|
-
| errors.Error401 | 401 | application/json |
|
|
98
|
-
| errors.Error403 | 403 | application/json |
|
|
99
|
-
| errors.Error404 | 404 | application/json |
|
|
100
|
-
| errors.Error405 | 405 | application/json |
|
|
101
|
-
| errors.Error409 | 409 | application/json |
|
|
102
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
103
|
-
| errors.Error425 | 425 | application/json |
|
|
104
|
-
| errors.Error429 | 429 | application/json |
|
|
105
|
-
| errors.Error500 | 500 | application/json |
|
|
106
|
-
| errors.Error502 | 502 | application/json |
|
|
107
|
-
| errors.Error504 | 504 | application/json |
|
|
108
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
109
|
-
|
|
110
|
-
## list
|
|
111
|
-
|
|
112
|
-
List all created payment links.
|
|
113
|
-
|
|
114
|
-
### Example Usage
|
|
115
|
-
|
|
116
|
-
<!-- UsageSnippet language="typescript" operationID="list_payment_links" method="get" path="/payment-links" -->
|
|
117
|
-
```typescript
|
|
118
|
-
import { Gr4vy, withToken } from "@gr4vy/sdk";
|
|
119
|
-
import fs from "fs";
|
|
120
|
-
|
|
121
|
-
const gr4vy = new Gr4vy({
|
|
122
|
-
id: "example",
|
|
123
|
-
server: "sandbox",
|
|
124
|
-
merchantAccountId: "default",
|
|
125
|
-
bearerAuth: withToken({
|
|
126
|
-
privateKey: fs.readFileSync("private_key.pem", "utf8"),
|
|
127
|
-
}),
|
|
128
|
-
});
|
|
129
|
-
|
|
130
|
-
async function run() {
|
|
131
|
-
const result = await gr4vy.paymentLinks.list();
|
|
132
|
-
|
|
133
|
-
for await (const page of result) {
|
|
134
|
-
console.log(page);
|
|
135
|
-
}
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
run();
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
### Standalone function
|
|
142
|
-
|
|
143
|
-
The standalone function version of this method:
|
|
144
|
-
|
|
145
|
-
```typescript
|
|
146
|
-
import { Gr4vyCore } from "@gr4vy/sdk/core.js";
|
|
147
|
-
import { paymentLinksList } from "@gr4vy/sdk/funcs/paymentLinksList.js";
|
|
148
|
-
|
|
149
|
-
// Use `Gr4vyCore` for best tree-shaking performance.
|
|
150
|
-
// You can create one instance of it to use across an application.
|
|
151
|
-
const gr4vy = new Gr4vyCore({
|
|
152
|
-
merchantAccountId: "<id>",
|
|
153
|
-
bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
|
|
154
|
-
});
|
|
155
|
-
|
|
156
|
-
async function run() {
|
|
157
|
-
const res = await paymentLinksList(gr4vy);
|
|
158
|
-
if (res.ok) {
|
|
159
|
-
const { value: result } = res;
|
|
160
|
-
for await (const page of result) {
|
|
161
|
-
console.log(page);
|
|
162
|
-
}
|
|
163
|
-
} else {
|
|
164
|
-
console.log("paymentLinksList failed:", res.error);
|
|
165
|
-
}
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
run();
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
### Parameters
|
|
172
|
-
|
|
173
|
-
| Parameter | Type | Required | Description | Example |
|
|
174
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
175
|
-
| `cursor` | *string* | :heavy_minus_sign: | A pointer to the page of results to return. | [object Object] |
|
|
176
|
-
| `limit` | *number* | :heavy_minus_sign: | The maximum number of items that are returned. | [object Object] |
|
|
177
|
-
| `buyerSearch` | *string*[] | :heavy_minus_sign: | Filters the results to only get the items for which some of the buyer data contains exactly the provided `buyer_search` values. | [object Object] |
|
|
178
|
-
| `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
|
|
179
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
|
180
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
|
181
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
|
|
182
|
-
|
|
183
|
-
### Response
|
|
184
|
-
|
|
185
|
-
**Promise\<[operations.ListPaymentLinksResponse](../../models/operations/listpaymentlinksresponse.md)\>**
|
|
186
|
-
|
|
187
|
-
### Errors
|
|
188
|
-
|
|
189
|
-
| Error Type | Status Code | Content Type |
|
|
190
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
191
|
-
| errors.Error400 | 400 | application/json |
|
|
192
|
-
| errors.Error401 | 401 | application/json |
|
|
193
|
-
| errors.Error403 | 403 | application/json |
|
|
194
|
-
| errors.Error404 | 404 | application/json |
|
|
195
|
-
| errors.Error405 | 405 | application/json |
|
|
196
|
-
| errors.Error409 | 409 | application/json |
|
|
197
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
198
|
-
| errors.Error425 | 425 | application/json |
|
|
199
|
-
| errors.Error429 | 429 | application/json |
|
|
200
|
-
| errors.Error500 | 500 | application/json |
|
|
201
|
-
| errors.Error502 | 502 | application/json |
|
|
202
|
-
| errors.Error504 | 504 | application/json |
|
|
203
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
204
|
-
|
|
205
|
-
## expire
|
|
206
|
-
|
|
207
|
-
Expire an existing payment link.
|
|
208
|
-
|
|
209
|
-
### Example Usage
|
|
210
|
-
|
|
211
|
-
<!-- UsageSnippet language="typescript" operationID="expire_payment_link" method="post" path="/payment-links/{payment_link_id}/expire" -->
|
|
212
|
-
```typescript
|
|
213
|
-
import { Gr4vy, withToken } from "@gr4vy/sdk";
|
|
214
|
-
import fs from "fs";
|
|
215
|
-
|
|
216
|
-
const gr4vy = new Gr4vy({
|
|
217
|
-
id: "example",
|
|
218
|
-
server: "sandbox",
|
|
219
|
-
merchantAccountId: "default",
|
|
220
|
-
bearerAuth: withToken({
|
|
221
|
-
privateKey: fs.readFileSync("private_key.pem", "utf8"),
|
|
222
|
-
}),
|
|
223
|
-
});
|
|
224
|
-
|
|
225
|
-
async function run() {
|
|
226
|
-
await gr4vy.paymentLinks.expire("a1b2c3d4-5678-90ab-cdef-1234567890ab");
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
}
|
|
230
|
-
|
|
231
|
-
run();
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
### Standalone function
|
|
235
|
-
|
|
236
|
-
The standalone function version of this method:
|
|
237
|
-
|
|
238
|
-
```typescript
|
|
239
|
-
import { Gr4vyCore } from "@gr4vy/sdk/core.js";
|
|
240
|
-
import { paymentLinksExpire } from "@gr4vy/sdk/funcs/paymentLinksExpire.js";
|
|
241
|
-
|
|
242
|
-
// Use `Gr4vyCore` for best tree-shaking performance.
|
|
243
|
-
// You can create one instance of it to use across an application.
|
|
244
|
-
const gr4vy = new Gr4vyCore({
|
|
245
|
-
merchantAccountId: "<id>",
|
|
246
|
-
bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
|
|
247
|
-
});
|
|
248
|
-
|
|
249
|
-
async function run() {
|
|
250
|
-
const res = await paymentLinksExpire(gr4vy, "a1b2c3d4-5678-90ab-cdef-1234567890ab");
|
|
251
|
-
if (res.ok) {
|
|
252
|
-
const { value: result } = res;
|
|
253
|
-
|
|
254
|
-
} else {
|
|
255
|
-
console.log("paymentLinksExpire failed:", res.error);
|
|
256
|
-
}
|
|
257
|
-
}
|
|
258
|
-
|
|
259
|
-
run();
|
|
260
|
-
```
|
|
261
|
-
|
|
262
|
-
### Parameters
|
|
263
|
-
|
|
264
|
-
| Parameter | Type | Required | Description | Example |
|
|
265
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
266
|
-
| `paymentLinkId` | *string* | :heavy_check_mark: | The unique identifier for the payment link. | [object Object] |
|
|
267
|
-
| `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
|
|
268
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
|
269
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
|
270
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
|
|
271
|
-
|
|
272
|
-
### Response
|
|
273
|
-
|
|
274
|
-
**Promise\<void\>**
|
|
275
|
-
|
|
276
|
-
### Errors
|
|
277
|
-
|
|
278
|
-
| Error Type | Status Code | Content Type |
|
|
279
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
280
|
-
| errors.Error400 | 400 | application/json |
|
|
281
|
-
| errors.Error401 | 401 | application/json |
|
|
282
|
-
| errors.Error403 | 403 | application/json |
|
|
283
|
-
| errors.Error404 | 404 | application/json |
|
|
284
|
-
| errors.Error405 | 405 | application/json |
|
|
285
|
-
| errors.Error409 | 409 | application/json |
|
|
286
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
287
|
-
| errors.Error425 | 425 | application/json |
|
|
288
|
-
| errors.Error429 | 429 | application/json |
|
|
289
|
-
| errors.Error500 | 500 | application/json |
|
|
290
|
-
| errors.Error502 | 502 | application/json |
|
|
291
|
-
| errors.Error504 | 504 | application/json |
|
|
292
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
293
|
-
|
|
294
|
-
## get
|
|
295
|
-
|
|
296
|
-
Fetch the details for a payment link.
|
|
297
|
-
|
|
298
|
-
### Example Usage
|
|
299
|
-
|
|
300
|
-
<!-- UsageSnippet language="typescript" operationID="get_payment_link" method="get" path="/payment-links/{payment_link_id}" -->
|
|
301
|
-
```typescript
|
|
302
|
-
import { Gr4vy, withToken } from "@gr4vy/sdk";
|
|
303
|
-
import fs from "fs";
|
|
304
|
-
|
|
305
|
-
const gr4vy = new Gr4vy({
|
|
306
|
-
id: "example",
|
|
307
|
-
server: "sandbox",
|
|
308
|
-
merchantAccountId: "default",
|
|
309
|
-
bearerAuth: withToken({
|
|
310
|
-
privateKey: fs.readFileSync("private_key.pem", "utf8"),
|
|
311
|
-
}),
|
|
312
|
-
});
|
|
313
|
-
|
|
314
|
-
async function run() {
|
|
315
|
-
const result = await gr4vy.paymentLinks.get("a1b2c3d4-5678-90ab-cdef-1234567890ab");
|
|
316
|
-
|
|
317
|
-
console.log(result);
|
|
318
|
-
}
|
|
319
|
-
|
|
320
|
-
run();
|
|
321
|
-
```
|
|
322
|
-
|
|
323
|
-
### Standalone function
|
|
324
|
-
|
|
325
|
-
The standalone function version of this method:
|
|
326
|
-
|
|
327
|
-
```typescript
|
|
328
|
-
import { Gr4vyCore } from "@gr4vy/sdk/core.js";
|
|
329
|
-
import { paymentLinksGet } from "@gr4vy/sdk/funcs/paymentLinksGet.js";
|
|
330
|
-
|
|
331
|
-
// Use `Gr4vyCore` for best tree-shaking performance.
|
|
332
|
-
// You can create one instance of it to use across an application.
|
|
333
|
-
const gr4vy = new Gr4vyCore({
|
|
334
|
-
merchantAccountId: "<id>",
|
|
335
|
-
bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
|
|
336
|
-
});
|
|
337
|
-
|
|
338
|
-
async function run() {
|
|
339
|
-
const res = await paymentLinksGet(gr4vy, "a1b2c3d4-5678-90ab-cdef-1234567890ab");
|
|
340
|
-
if (res.ok) {
|
|
341
|
-
const { value: result } = res;
|
|
342
|
-
console.log(result);
|
|
343
|
-
} else {
|
|
344
|
-
console.log("paymentLinksGet failed:", res.error);
|
|
345
|
-
}
|
|
346
|
-
}
|
|
347
|
-
|
|
348
|
-
run();
|
|
349
|
-
```
|
|
350
|
-
|
|
351
|
-
### Parameters
|
|
352
|
-
|
|
353
|
-
| Parameter | Type | Required | Description | Example |
|
|
354
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
355
|
-
| `paymentLinkId` | *string* | :heavy_check_mark: | The unique identifier for the payment link. | [object Object] |
|
|
356
|
-
| `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
|
|
357
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
|
358
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
|
359
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
|
|
360
|
-
|
|
361
|
-
### Response
|
|
362
|
-
|
|
363
|
-
**Promise\<[components.PaymentLink](../../models/components/paymentlink.md)\>**
|
|
364
|
-
|
|
365
|
-
### Errors
|
|
366
|
-
|
|
367
|
-
| Error Type | Status Code | Content Type |
|
|
368
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
369
|
-
| errors.Error400 | 400 | application/json |
|
|
370
|
-
| errors.Error401 | 401 | application/json |
|
|
371
|
-
| errors.Error403 | 403 | application/json |
|
|
372
|
-
| errors.Error404 | 404 | application/json |
|
|
373
|
-
| errors.Error405 | 405 | application/json |
|
|
374
|
-
| errors.Error409 | 409 | application/json |
|
|
375
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
376
|
-
| errors.Error425 | 425 | application/json |
|
|
377
|
-
| errors.Error429 | 429 | application/json |
|
|
378
|
-
| errors.Error500 | 500 | application/json |
|
|
379
|
-
| errors.Error502 | 502 | application/json |
|
|
380
|
-
| errors.Error504 | 504 | application/json |
|
|
381
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|