@gr4vy/sdk 1.5.8 → 1.6.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/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/package.json +1 -1
- package/src/lib/config.ts +3 -3
- 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,367 +0,0 @@
|
|
|
1
|
-
# CheckoutSessions
|
|
2
|
-
(*checkoutSessions*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [create](#create) - Create checkout session
|
|
9
|
-
* [update](#update) - Update checkout session
|
|
10
|
-
* [get](#get) - Get checkout session
|
|
11
|
-
* [delete](#delete) - Delete checkout session
|
|
12
|
-
|
|
13
|
-
## create
|
|
14
|
-
|
|
15
|
-
Create a new checkout session.
|
|
16
|
-
|
|
17
|
-
### Example Usage
|
|
18
|
-
|
|
19
|
-
<!-- UsageSnippet language="typescript" operationID="create_checkout_session" method="post" path="/checkout/sessions" -->
|
|
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.checkoutSessions.create();
|
|
35
|
-
|
|
36
|
-
console.log(result);
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
run();
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Standalone function
|
|
43
|
-
|
|
44
|
-
The standalone function version of this method:
|
|
45
|
-
|
|
46
|
-
```typescript
|
|
47
|
-
import { Gr4vyCore } from "@gr4vy/sdk/core.js";
|
|
48
|
-
import { checkoutSessionsCreate } from "@gr4vy/sdk/funcs/checkoutSessionsCreate.js";
|
|
49
|
-
|
|
50
|
-
// Use `Gr4vyCore` for best tree-shaking performance.
|
|
51
|
-
// You can create one instance of it to use across an application.
|
|
52
|
-
const gr4vy = new Gr4vyCore({
|
|
53
|
-
merchantAccountId: "<id>",
|
|
54
|
-
bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
|
|
55
|
-
});
|
|
56
|
-
|
|
57
|
-
async function run() {
|
|
58
|
-
const res = await checkoutSessionsCreate(gr4vy);
|
|
59
|
-
if (res.ok) {
|
|
60
|
-
const { value: result } = res;
|
|
61
|
-
console.log(result);
|
|
62
|
-
} else {
|
|
63
|
-
console.log("checkoutSessionsCreate failed:", res.error);
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
run();
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### Parameters
|
|
71
|
-
|
|
72
|
-
| Parameter | Type | Required | Description |
|
|
73
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
74
|
-
| `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. |
|
|
75
|
-
| `checkoutSessionCreate` | [components.CheckoutSessionCreate](../../models/components/checkoutsessioncreate.md) | :heavy_minus_sign: | N/A |
|
|
76
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
77
|
-
| `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. |
|
|
78
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
79
|
-
|
|
80
|
-
### Response
|
|
81
|
-
|
|
82
|
-
**Promise\<[components.CheckoutSession](../../models/components/checkoutsession.md)\>**
|
|
83
|
-
|
|
84
|
-
### Errors
|
|
85
|
-
|
|
86
|
-
| Error Type | Status Code | Content Type |
|
|
87
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
88
|
-
| errors.Error400 | 400 | application/json |
|
|
89
|
-
| errors.Error401 | 401 | application/json |
|
|
90
|
-
| errors.Error403 | 403 | application/json |
|
|
91
|
-
| errors.Error404 | 404 | application/json |
|
|
92
|
-
| errors.Error405 | 405 | application/json |
|
|
93
|
-
| errors.Error409 | 409 | application/json |
|
|
94
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
95
|
-
| errors.Error425 | 425 | application/json |
|
|
96
|
-
| errors.Error429 | 429 | application/json |
|
|
97
|
-
| errors.Error500 | 500 | application/json |
|
|
98
|
-
| errors.Error502 | 502 | application/json |
|
|
99
|
-
| errors.Error504 | 504 | application/json |
|
|
100
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
101
|
-
|
|
102
|
-
## update
|
|
103
|
-
|
|
104
|
-
Update the information stored on a checkout session.
|
|
105
|
-
|
|
106
|
-
### Example Usage
|
|
107
|
-
|
|
108
|
-
<!-- UsageSnippet language="typescript" operationID="update_checkout_session" method="put" path="/checkout/sessions/{session_id}" -->
|
|
109
|
-
```typescript
|
|
110
|
-
import { Gr4vy, withToken } from "@gr4vy/sdk";
|
|
111
|
-
import fs from "fs";
|
|
112
|
-
|
|
113
|
-
const gr4vy = new Gr4vy({
|
|
114
|
-
id: "example",
|
|
115
|
-
server: "sandbox",
|
|
116
|
-
merchantAccountId: "default",
|
|
117
|
-
bearerAuth: withToken({
|
|
118
|
-
privateKey: fs.readFileSync("private_key.pem", "utf8"),
|
|
119
|
-
}),
|
|
120
|
-
});
|
|
121
|
-
|
|
122
|
-
async function run() {
|
|
123
|
-
const result = await gr4vy.checkoutSessions.update({}, "4137b1cf-39ac-42a8-bad6-1c680d5dab6b");
|
|
124
|
-
|
|
125
|
-
console.log(result);
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
run();
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
### Standalone function
|
|
132
|
-
|
|
133
|
-
The standalone function version of this method:
|
|
134
|
-
|
|
135
|
-
```typescript
|
|
136
|
-
import { Gr4vyCore } from "@gr4vy/sdk/core.js";
|
|
137
|
-
import { checkoutSessionsUpdate } from "@gr4vy/sdk/funcs/checkoutSessionsUpdate.js";
|
|
138
|
-
|
|
139
|
-
// Use `Gr4vyCore` for best tree-shaking performance.
|
|
140
|
-
// You can create one instance of it to use across an application.
|
|
141
|
-
const gr4vy = new Gr4vyCore({
|
|
142
|
-
merchantAccountId: "<id>",
|
|
143
|
-
bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
|
|
144
|
-
});
|
|
145
|
-
|
|
146
|
-
async function run() {
|
|
147
|
-
const res = await checkoutSessionsUpdate(gr4vy, {}, "4137b1cf-39ac-42a8-bad6-1c680d5dab6b");
|
|
148
|
-
if (res.ok) {
|
|
149
|
-
const { value: result } = res;
|
|
150
|
-
console.log(result);
|
|
151
|
-
} else {
|
|
152
|
-
console.log("checkoutSessionsUpdate failed:", res.error);
|
|
153
|
-
}
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
run();
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
### Parameters
|
|
160
|
-
|
|
161
|
-
| Parameter | Type | Required | Description | Example |
|
|
162
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
163
|
-
| `sessionId` | *string* | :heavy_check_mark: | The ID of the checkout session. | [object Object] |
|
|
164
|
-
| `checkoutSessionCreate` | [components.CheckoutSessionCreate](../../models/components/checkoutsessioncreate.md) | :heavy_check_mark: | N/A | |
|
|
165
|
-
| `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
|
|
166
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
|
167
|
-
| `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. | |
|
|
168
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
|
|
169
|
-
|
|
170
|
-
### Response
|
|
171
|
-
|
|
172
|
-
**Promise\<[components.CheckoutSession](../../models/components/checkoutsession.md)\>**
|
|
173
|
-
|
|
174
|
-
### Errors
|
|
175
|
-
|
|
176
|
-
| Error Type | Status Code | Content Type |
|
|
177
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
178
|
-
| errors.Error400 | 400 | application/json |
|
|
179
|
-
| errors.Error401 | 401 | application/json |
|
|
180
|
-
| errors.Error403 | 403 | application/json |
|
|
181
|
-
| errors.Error404 | 404 | application/json |
|
|
182
|
-
| errors.Error405 | 405 | application/json |
|
|
183
|
-
| errors.Error409 | 409 | application/json |
|
|
184
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
185
|
-
| errors.Error425 | 425 | application/json |
|
|
186
|
-
| errors.Error429 | 429 | application/json |
|
|
187
|
-
| errors.Error500 | 500 | application/json |
|
|
188
|
-
| errors.Error502 | 502 | application/json |
|
|
189
|
-
| errors.Error504 | 504 | application/json |
|
|
190
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
191
|
-
|
|
192
|
-
## get
|
|
193
|
-
|
|
194
|
-
Retrieve the information stored on a checkout session.
|
|
195
|
-
|
|
196
|
-
### Example Usage
|
|
197
|
-
|
|
198
|
-
<!-- UsageSnippet language="typescript" operationID="get_checkout_session" method="get" path="/checkout/sessions/{session_id}" -->
|
|
199
|
-
```typescript
|
|
200
|
-
import { Gr4vy, withToken } from "@gr4vy/sdk";
|
|
201
|
-
import fs from "fs";
|
|
202
|
-
|
|
203
|
-
const gr4vy = new Gr4vy({
|
|
204
|
-
id: "example",
|
|
205
|
-
server: "sandbox",
|
|
206
|
-
merchantAccountId: "default",
|
|
207
|
-
bearerAuth: withToken({
|
|
208
|
-
privateKey: fs.readFileSync("private_key.pem", "utf8"),
|
|
209
|
-
}),
|
|
210
|
-
});
|
|
211
|
-
|
|
212
|
-
async function run() {
|
|
213
|
-
const result = await gr4vy.checkoutSessions.get("4137b1cf-39ac-42a8-bad6-1c680d5dab6b");
|
|
214
|
-
|
|
215
|
-
console.log(result);
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
run();
|
|
219
|
-
```
|
|
220
|
-
|
|
221
|
-
### Standalone function
|
|
222
|
-
|
|
223
|
-
The standalone function version of this method:
|
|
224
|
-
|
|
225
|
-
```typescript
|
|
226
|
-
import { Gr4vyCore } from "@gr4vy/sdk/core.js";
|
|
227
|
-
import { checkoutSessionsGet } from "@gr4vy/sdk/funcs/checkoutSessionsGet.js";
|
|
228
|
-
|
|
229
|
-
// Use `Gr4vyCore` for best tree-shaking performance.
|
|
230
|
-
// You can create one instance of it to use across an application.
|
|
231
|
-
const gr4vy = new Gr4vyCore({
|
|
232
|
-
merchantAccountId: "<id>",
|
|
233
|
-
bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
|
|
234
|
-
});
|
|
235
|
-
|
|
236
|
-
async function run() {
|
|
237
|
-
const res = await checkoutSessionsGet(gr4vy, "4137b1cf-39ac-42a8-bad6-1c680d5dab6b");
|
|
238
|
-
if (res.ok) {
|
|
239
|
-
const { value: result } = res;
|
|
240
|
-
console.log(result);
|
|
241
|
-
} else {
|
|
242
|
-
console.log("checkoutSessionsGet failed:", res.error);
|
|
243
|
-
}
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
run();
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
### Parameters
|
|
250
|
-
|
|
251
|
-
| Parameter | Type | Required | Description | Example |
|
|
252
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
253
|
-
| `sessionId` | *string* | :heavy_check_mark: | The ID of the checkout session. | [object Object] |
|
|
254
|
-
| `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
|
|
255
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
|
256
|
-
| `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. | |
|
|
257
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
|
|
258
|
-
|
|
259
|
-
### Response
|
|
260
|
-
|
|
261
|
-
**Promise\<[components.CheckoutSession](../../models/components/checkoutsession.md)\>**
|
|
262
|
-
|
|
263
|
-
### Errors
|
|
264
|
-
|
|
265
|
-
| Error Type | Status Code | Content Type |
|
|
266
|
-
| ---------------- | ---------------- | ---------------- |
|
|
267
|
-
| errors.Error400 | 400 | application/json |
|
|
268
|
-
| errors.Error401 | 401 | application/json |
|
|
269
|
-
| errors.Error403 | 403 | application/json |
|
|
270
|
-
| errors.Error404 | 404 | application/json |
|
|
271
|
-
| errors.Error405 | 405 | application/json |
|
|
272
|
-
| errors.Error409 | 409 | application/json |
|
|
273
|
-
| errors.Error425 | 425 | application/json |
|
|
274
|
-
| errors.Error429 | 429 | application/json |
|
|
275
|
-
| errors.Error500 | 500 | application/json |
|
|
276
|
-
| errors.Error502 | 502 | application/json |
|
|
277
|
-
| errors.Error504 | 504 | application/json |
|
|
278
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
279
|
-
|
|
280
|
-
## delete
|
|
281
|
-
|
|
282
|
-
Delete a checkout session and all of its (PCI) data.
|
|
283
|
-
|
|
284
|
-
### Example Usage
|
|
285
|
-
|
|
286
|
-
<!-- UsageSnippet language="typescript" operationID="delete_checkout_session" method="delete" path="/checkout/sessions/{session_id}" -->
|
|
287
|
-
```typescript
|
|
288
|
-
import { Gr4vy, withToken } from "@gr4vy/sdk";
|
|
289
|
-
import fs from "fs";
|
|
290
|
-
|
|
291
|
-
const gr4vy = new Gr4vy({
|
|
292
|
-
id: "example",
|
|
293
|
-
server: "sandbox",
|
|
294
|
-
merchantAccountId: "default",
|
|
295
|
-
bearerAuth: withToken({
|
|
296
|
-
privateKey: fs.readFileSync("private_key.pem", "utf8"),
|
|
297
|
-
}),
|
|
298
|
-
});
|
|
299
|
-
|
|
300
|
-
async function run() {
|
|
301
|
-
await gr4vy.checkoutSessions.delete("4137b1cf-39ac-42a8-bad6-1c680d5dab6b");
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
run();
|
|
307
|
-
```
|
|
308
|
-
|
|
309
|
-
### Standalone function
|
|
310
|
-
|
|
311
|
-
The standalone function version of this method:
|
|
312
|
-
|
|
313
|
-
```typescript
|
|
314
|
-
import { Gr4vyCore } from "@gr4vy/sdk/core.js";
|
|
315
|
-
import { checkoutSessionsDelete } from "@gr4vy/sdk/funcs/checkoutSessionsDelete.js";
|
|
316
|
-
|
|
317
|
-
// Use `Gr4vyCore` for best tree-shaking performance.
|
|
318
|
-
// You can create one instance of it to use across an application.
|
|
319
|
-
const gr4vy = new Gr4vyCore({
|
|
320
|
-
merchantAccountId: "<id>",
|
|
321
|
-
bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
|
|
322
|
-
});
|
|
323
|
-
|
|
324
|
-
async function run() {
|
|
325
|
-
const res = await checkoutSessionsDelete(gr4vy, "4137b1cf-39ac-42a8-bad6-1c680d5dab6b");
|
|
326
|
-
if (res.ok) {
|
|
327
|
-
const { value: result } = res;
|
|
328
|
-
|
|
329
|
-
} else {
|
|
330
|
-
console.log("checkoutSessionsDelete failed:", res.error);
|
|
331
|
-
}
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
run();
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
### Parameters
|
|
338
|
-
|
|
339
|
-
| Parameter | Type | Required | Description | Example |
|
|
340
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
341
|
-
| `sessionId` | *string* | :heavy_check_mark: | The ID of the checkout session. | [object Object] |
|
|
342
|
-
| `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
|
|
343
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
|
344
|
-
| `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. | |
|
|
345
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
|
|
346
|
-
|
|
347
|
-
### Response
|
|
348
|
-
|
|
349
|
-
**Promise\<void\>**
|
|
350
|
-
|
|
351
|
-
### Errors
|
|
352
|
-
|
|
353
|
-
| Error Type | Status Code | Content Type |
|
|
354
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
355
|
-
| errors.Error400 | 400 | application/json |
|
|
356
|
-
| errors.Error401 | 401 | application/json |
|
|
357
|
-
| errors.Error403 | 403 | application/json |
|
|
358
|
-
| errors.Error404 | 404 | application/json |
|
|
359
|
-
| errors.Error405 | 405 | application/json |
|
|
360
|
-
| errors.Error409 | 409 | application/json |
|
|
361
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
362
|
-
| errors.Error425 | 425 | application/json |
|
|
363
|
-
| errors.Error429 | 429 | application/json |
|
|
364
|
-
| errors.Error500 | 500 | application/json |
|
|
365
|
-
| errors.Error502 | 502 | application/json |
|
|
366
|
-
| errors.Error504 | 504 | application/json |
|
|
367
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -1,103 +0,0 @@
|
|
|
1
|
-
# Cryptogram
|
|
2
|
-
(*paymentMethods.networkTokens.cryptogram*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [create](#create) - Provision network token cryptogram
|
|
9
|
-
|
|
10
|
-
## create
|
|
11
|
-
|
|
12
|
-
Provision a cryptogram for a network token.
|
|
13
|
-
|
|
14
|
-
### Example Usage
|
|
15
|
-
|
|
16
|
-
<!-- UsageSnippet language="typescript" operationID="create_payment_method_network_token_cryptogram" method="post" path="/payment-methods/{payment_method_id}/network-tokens/{network_token_id}/cryptogram" -->
|
|
17
|
-
```typescript
|
|
18
|
-
import { Gr4vy, withToken } from "@gr4vy/sdk";
|
|
19
|
-
import fs from "fs";
|
|
20
|
-
|
|
21
|
-
const gr4vy = new Gr4vy({
|
|
22
|
-
id: "example",
|
|
23
|
-
server: "sandbox",
|
|
24
|
-
merchantAccountId: "default",
|
|
25
|
-
bearerAuth: withToken({
|
|
26
|
-
privateKey: fs.readFileSync("private_key.pem", "utf8"),
|
|
27
|
-
}),
|
|
28
|
-
});
|
|
29
|
-
|
|
30
|
-
async function run() {
|
|
31
|
-
const result = await gr4vy.paymentMethods.networkTokens.cryptogram.create({
|
|
32
|
-
merchantInitiated: false,
|
|
33
|
-
}, "ef9496d8-53a5-4aad-8ca2-00eb68334389", "f8dd5cfc-7834-4847-95dc-f75a360e2298");
|
|
34
|
-
|
|
35
|
-
console.log(result);
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
run();
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Standalone function
|
|
42
|
-
|
|
43
|
-
The standalone function version of this method:
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
import { Gr4vyCore } from "@gr4vy/sdk/core.js";
|
|
47
|
-
import { paymentMethodsNetworkTokensCryptogramCreate } from "@gr4vy/sdk/funcs/paymentMethodsNetworkTokensCryptogramCreate.js";
|
|
48
|
-
|
|
49
|
-
// Use `Gr4vyCore` for best tree-shaking performance.
|
|
50
|
-
// You can create one instance of it to use across an application.
|
|
51
|
-
const gr4vy = new Gr4vyCore({
|
|
52
|
-
merchantAccountId: "<id>",
|
|
53
|
-
bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
|
|
54
|
-
});
|
|
55
|
-
|
|
56
|
-
async function run() {
|
|
57
|
-
const res = await paymentMethodsNetworkTokensCryptogramCreate(gr4vy, {
|
|
58
|
-
merchantInitiated: false,
|
|
59
|
-
}, "ef9496d8-53a5-4aad-8ca2-00eb68334389", "f8dd5cfc-7834-4847-95dc-f75a360e2298");
|
|
60
|
-
if (res.ok) {
|
|
61
|
-
const { value: result } = res;
|
|
62
|
-
console.log(result);
|
|
63
|
-
} else {
|
|
64
|
-
console.log("paymentMethodsNetworkTokensCryptogramCreate failed:", res.error);
|
|
65
|
-
}
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
run();
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
### Parameters
|
|
72
|
-
|
|
73
|
-
| Parameter | Type | Required | Description | Example |
|
|
74
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
75
|
-
| `paymentMethodId` | *string* | :heavy_check_mark: | The ID of the payment method | [object Object] |
|
|
76
|
-
| `networkTokenId` | *string* | :heavy_check_mark: | The ID of the network token | [object Object] |
|
|
77
|
-
| `cryptogramCreate` | [components.CryptogramCreate](../../models/components/cryptogramcreate.md) | :heavy_check_mark: | N/A | |
|
|
78
|
-
| `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
|
|
79
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
|
80
|
-
| `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. | |
|
|
81
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
|
|
82
|
-
|
|
83
|
-
### Response
|
|
84
|
-
|
|
85
|
-
**Promise\<[components.Cryptogram](../../models/components/cryptogram.md)\>**
|
|
86
|
-
|
|
87
|
-
### Errors
|
|
88
|
-
|
|
89
|
-
| Error Type | Status Code | Content Type |
|
|
90
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
91
|
-
| errors.Error400 | 400 | application/json |
|
|
92
|
-
| errors.Error401 | 401 | application/json |
|
|
93
|
-
| errors.Error403 | 403 | application/json |
|
|
94
|
-
| errors.Error404 | 404 | application/json |
|
|
95
|
-
| errors.Error405 | 405 | application/json |
|
|
96
|
-
| errors.Error409 | 409 | application/json |
|
|
97
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
98
|
-
| errors.Error425 | 425 | application/json |
|
|
99
|
-
| errors.Error429 | 429 | application/json |
|
|
100
|
-
| errors.Error500 | 500 | application/json |
|
|
101
|
-
| errors.Error502 | 502 | application/json |
|
|
102
|
-
| errors.Error504 | 504 | application/json |
|
|
103
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|