@gr4vy/sdk 1.1.16 → 1.1.18
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/docs/sdks/all/README.md +1 -0
- package/docs/sdks/auditlogs/README.md +1 -0
- package/docs/sdks/balances/README.md +1 -0
- package/docs/sdks/buyers/README.md +5 -0
- package/docs/sdks/cardschemedefinitions/README.md +1 -0
- package/docs/sdks/checkoutsessions/README.md +4 -0
- package/docs/sdks/cryptogram/README.md +1 -0
- package/docs/sdks/digitalwallets/README.md +5 -0
- package/docs/sdks/domains/README.md +2 -0
- package/docs/sdks/events/README.md +1 -0
- package/docs/sdks/executions/README.md +3 -0
- package/docs/sdks/giftcards/README.md +4 -0
- package/docs/sdks/gr4vygiftcards/README.md +1 -0
- package/docs/sdks/gr4vypaymentmethods/README.md +1 -0
- package/docs/sdks/gr4vyrefunds/README.md +3 -0
- package/docs/sdks/jobs/README.md +1 -0
- package/docs/sdks/merchantaccounts/README.md +4 -0
- package/docs/sdks/networktokens/README.md +5 -0
- package/docs/sdks/paymentlinks/README.md +4 -0
- package/docs/sdks/paymentmethods/README.md +4 -0
- package/docs/sdks/paymentoptions/README.md +1 -0
- package/docs/sdks/paymentservicedefinitions/README.md +3 -0
- package/docs/sdks/paymentservices/README.md +7 -0
- package/docs/sdks/paymentservicetokens/README.md +3 -0
- package/docs/sdks/payouts/README.md +3 -0
- package/docs/sdks/refunds/README.md +1 -0
- package/docs/sdks/reportexecutions/README.md +1 -0
- package/docs/sdks/reports/README.md +4 -0
- package/docs/sdks/sessions/README.md +3 -0
- package/docs/sdks/settlements/README.md +2 -0
- package/docs/sdks/shippingdetails/README.md +5 -0
- package/docs/sdks/transactions/README.md +10 -2
- package/funcs/transactionsCapture.d.ts +1 -1
- package/funcs/transactionsCapture.d.ts.map +1 -1
- package/funcs/transactionsCapture.js.map +1 -1
- package/funcs/transactionsVoid.d.ts +2 -2
- package/funcs/transactionsVoid.d.ts.map +1 -1
- package/funcs/transactionsVoid.js +9 -5
- package/funcs/transactionsVoid.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/models/components/index.d.ts +2 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +2 -0
- package/models/components/index.js.map +1 -1
- package/models/components/transactionvoid.d.ts +56 -0
- package/models/components/transactionvoid.d.ts.map +1 -0
- package/models/components/transactionvoid.js +82 -0
- package/models/components/transactionvoid.js.map +1 -0
- package/models/components/voidstatus.d.ts +24 -0
- package/models/components/voidstatus.d.ts.map +1 -0
- package/models/components/voidstatus.js +60 -0
- package/models/components/voidstatus.js.map +1 -0
- package/models/operations/capturetransaction.d.ts +2 -2
- package/models/operations/capturetransaction.d.ts.map +1 -1
- package/models/operations/capturetransaction.js +2 -2
- package/models/operations/capturetransaction.js.map +1 -1
- package/models/operations/voidtransaction.d.ts +30 -0
- package/models/operations/voidtransaction.d.ts.map +1 -1
- package/models/operations/voidtransaction.js +33 -1
- package/models/operations/voidtransaction.js.map +1 -1
- package/package.json +1 -1
- package/sdk/transactions.d.ts +2 -2
- package/sdk/transactions.d.ts.map +1 -1
- package/sdk/transactions.js +2 -2
- package/sdk/transactions.js.map +1 -1
- package/src/funcs/transactionsCapture.ts +2 -2
- package/src/funcs/transactionsVoid.ts +15 -5
- package/src/lib/config.ts +3 -3
- package/src/models/components/index.ts +2 -0
- package/src/models/components/transactionvoid.ts +121 -0
- package/src/models/components/voidstatus.ts +50 -0
- package/src/models/operations/capturetransaction.ts +4 -4
- package/src/models/operations/voidtransaction.ts +77 -0
- package/src/sdk/transactions.ts +4 -2
package/docs/sdks/all/README.md
CHANGED
|
@@ -13,6 +13,7 @@ Create a refund for all instruments on a transaction.
|
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="create_full_transaction_refund" method="post" path="/transactions/{transaction_id}/refunds/all" -->
|
|
16
17
|
```typescript
|
|
17
18
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
18
19
|
|
|
@@ -17,6 +17,7 @@ List all buyers or search for a specific buyer.
|
|
|
17
17
|
|
|
18
18
|
### Example Usage
|
|
19
19
|
|
|
20
|
+
<!-- UsageSnippet language="typescript" operationID="list_buyers" method="get" path="/buyers" -->
|
|
20
21
|
```typescript
|
|
21
22
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
22
23
|
|
|
@@ -112,6 +113,7 @@ Create a new buyer record.
|
|
|
112
113
|
|
|
113
114
|
### Example Usage
|
|
114
115
|
|
|
116
|
+
<!-- UsageSnippet language="typescript" operationID="add_buyer" method="post" path="/buyers" -->
|
|
115
117
|
```typescript
|
|
116
118
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
117
119
|
|
|
@@ -204,6 +206,7 @@ Fetches a buyer by its ID.
|
|
|
204
206
|
|
|
205
207
|
### Example Usage
|
|
206
208
|
|
|
209
|
+
<!-- UsageSnippet language="typescript" operationID="get_buyer" method="get" path="/buyers/{buyer_id}" -->
|
|
207
210
|
```typescript
|
|
208
211
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
209
212
|
|
|
@@ -296,6 +299,7 @@ Updates a buyer record.
|
|
|
296
299
|
|
|
297
300
|
### Example Usage
|
|
298
301
|
|
|
302
|
+
<!-- UsageSnippet language="typescript" operationID="update_buyer" method="put" path="/buyers/{buyer_id}" -->
|
|
299
303
|
```typescript
|
|
300
304
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
301
305
|
|
|
@@ -389,6 +393,7 @@ Permanently removes a buyer record.
|
|
|
389
393
|
|
|
390
394
|
### Example Usage
|
|
391
395
|
|
|
396
|
+
<!-- UsageSnippet language="typescript" operationID="delete_buyer" method="delete" path="/buyers/{buyer_id}" -->
|
|
392
397
|
```typescript
|
|
393
398
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
394
399
|
|
|
@@ -13,6 +13,7 @@ Fetch a list of the definitions of each card scheme.
|
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="list_card_scheme_definitions" method="get" path="/card-scheme-definitions" -->
|
|
16
17
|
```typescript
|
|
17
18
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
18
19
|
|
|
@@ -16,6 +16,7 @@ Create a new checkout session.
|
|
|
16
16
|
|
|
17
17
|
### Example Usage
|
|
18
18
|
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="create_checkout_session" method="post" path="/checkout/sessions" -->
|
|
19
20
|
```typescript
|
|
20
21
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
21
22
|
|
|
@@ -108,6 +109,7 @@ Update the information stored on a checkout session.
|
|
|
108
109
|
|
|
109
110
|
### Example Usage
|
|
110
111
|
|
|
112
|
+
<!-- UsageSnippet language="typescript" operationID="update_checkout_session" method="put" path="/checkout/sessions/{session_id}" -->
|
|
111
113
|
```typescript
|
|
112
114
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
113
115
|
|
|
@@ -201,6 +203,7 @@ Retrieve the information stored on a checkout session.
|
|
|
201
203
|
|
|
202
204
|
### Example Usage
|
|
203
205
|
|
|
206
|
+
<!-- UsageSnippet language="typescript" operationID="get_checkout_session" method="get" path="/checkout/sessions/{session_id}" -->
|
|
204
207
|
```typescript
|
|
205
208
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
206
209
|
|
|
@@ -292,6 +295,7 @@ Delete a checkout session and all of its (PCI) data.
|
|
|
292
295
|
|
|
293
296
|
### Example Usage
|
|
294
297
|
|
|
298
|
+
<!-- UsageSnippet language="typescript" operationID="delete_checkout_session" method="delete" path="/checkout/sessions/{session_id}" -->
|
|
295
299
|
```typescript
|
|
296
300
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
297
301
|
|
|
@@ -13,6 +13,7 @@ Provision a cryptogram for a network token.
|
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
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" -->
|
|
16
17
|
```typescript
|
|
17
18
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
18
19
|
|
|
@@ -17,6 +17,7 @@ Register a digital wallet like Apple Pay, Google Pay, or Click to Pay.
|
|
|
17
17
|
|
|
18
18
|
### Example Usage
|
|
19
19
|
|
|
20
|
+
<!-- UsageSnippet language="typescript" operationID="configure_digital_wallet" method="post" path="/digital-wallets" -->
|
|
20
21
|
```typescript
|
|
21
22
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
22
23
|
|
|
@@ -117,6 +118,7 @@ List configured digital wallets.
|
|
|
117
118
|
|
|
118
119
|
### Example Usage
|
|
119
120
|
|
|
121
|
+
<!-- UsageSnippet language="typescript" operationID="list_digital_wallets" method="get" path="/digital-wallets" -->
|
|
120
122
|
```typescript
|
|
121
123
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
122
124
|
|
|
@@ -208,6 +210,7 @@ Fetch the details a digital wallet.
|
|
|
208
210
|
|
|
209
211
|
### Example Usage
|
|
210
212
|
|
|
213
|
+
<!-- UsageSnippet language="typescript" operationID="get_digital_wallet" method="get" path="/digital-wallets/{digital_wallet_id}" -->
|
|
211
214
|
```typescript
|
|
212
215
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
213
216
|
|
|
@@ -300,6 +303,7 @@ Delete a configured digital wallet.
|
|
|
300
303
|
|
|
301
304
|
### Example Usage
|
|
302
305
|
|
|
306
|
+
<!-- UsageSnippet language="typescript" operationID="delete_digital_wallet" method="delete" path="/digital-wallets/{digital_wallet_id}" -->
|
|
303
307
|
```typescript
|
|
304
308
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
305
309
|
|
|
@@ -392,6 +396,7 @@ Update a digital wallet.
|
|
|
392
396
|
|
|
393
397
|
### Example Usage
|
|
394
398
|
|
|
399
|
+
<!-- UsageSnippet language="typescript" operationID="update_digital_wallet" method="put" path="/digital-wallets/{digital_wallet_id}" -->
|
|
395
400
|
```typescript
|
|
396
401
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
397
402
|
|
|
@@ -14,6 +14,7 @@ Register a digital wallet domain (Apple Pay only).
|
|
|
14
14
|
|
|
15
15
|
### Example Usage
|
|
16
16
|
|
|
17
|
+
<!-- UsageSnippet language="typescript" operationID="register_digital_wallet_domain" method="post" path="/digital-wallets/{digital_wallet_id}/domains" -->
|
|
17
18
|
```typescript
|
|
18
19
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
19
20
|
|
|
@@ -111,6 +112,7 @@ Remove a digital wallet domain (Apple Pay only).
|
|
|
111
112
|
|
|
112
113
|
### Example Usage
|
|
113
114
|
|
|
115
|
+
<!-- UsageSnippet language="typescript" operationID="unregister_digital_wallet_domain" method="delete" path="/digital-wallets/{digital_wallet_id}/domains" -->
|
|
114
116
|
```typescript
|
|
115
117
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
116
118
|
|
|
@@ -13,6 +13,7 @@ Retrieve a paginated list of events related to processing a transaction, includi
|
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="list_transaction_events" method="get" path="/transactions/{transaction_id}/events" -->
|
|
16
17
|
```typescript
|
|
17
18
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
18
19
|
|
|
@@ -15,6 +15,7 @@ List all executions of a specific report.
|
|
|
15
15
|
|
|
16
16
|
### Example Usage
|
|
17
17
|
|
|
18
|
+
<!-- UsageSnippet language="typescript" operationID="list_report_executions" method="get" path="/reports/{report_id}/executions" -->
|
|
18
19
|
```typescript
|
|
19
20
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
20
21
|
|
|
@@ -113,6 +114,7 @@ Creates a download URL for a specific execution of a report.
|
|
|
113
114
|
|
|
114
115
|
### Example Usage
|
|
115
116
|
|
|
117
|
+
<!-- UsageSnippet language="typescript" operationID="create_report_execution_url" method="post" path="/reports/{report_id}/executions/{report_execution_id}/url" -->
|
|
116
118
|
```typescript
|
|
117
119
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
118
120
|
|
|
@@ -206,6 +208,7 @@ Fetch a specific executed report.
|
|
|
206
208
|
|
|
207
209
|
### Example Usage
|
|
208
210
|
|
|
211
|
+
<!-- UsageSnippet language="typescript" operationID="get_report_execution" method="get" path="/report-executions/{report_execution_id}" -->
|
|
209
212
|
```typescript
|
|
210
213
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
211
214
|
|
|
@@ -16,6 +16,7 @@ Fetch details about a gift card.
|
|
|
16
16
|
|
|
17
17
|
### Example Usage
|
|
18
18
|
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="get_gift_card" method="get" path="/gift-cards/{gift_card_id}" -->
|
|
19
20
|
```typescript
|
|
20
21
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
21
22
|
|
|
@@ -108,6 +109,7 @@ Removes a gift card from our system.
|
|
|
108
109
|
|
|
109
110
|
### Example Usage
|
|
110
111
|
|
|
112
|
+
<!-- UsageSnippet language="typescript" operationID="delete_gift_card" method="delete" path="/gift-cards/{gift_card_id}" -->
|
|
111
113
|
```typescript
|
|
112
114
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
113
115
|
|
|
@@ -200,6 +202,7 @@ Store a new gift card in the vault.
|
|
|
200
202
|
|
|
201
203
|
### Example Usage
|
|
202
204
|
|
|
205
|
+
<!-- UsageSnippet language="typescript" operationID="create_gift_card" method="post" path="/gift-cards" -->
|
|
203
206
|
```typescript
|
|
204
207
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
205
208
|
|
|
@@ -298,6 +301,7 @@ Browser all gift cards.
|
|
|
298
301
|
|
|
299
302
|
### Example Usage
|
|
300
303
|
|
|
304
|
+
<!-- UsageSnippet language="typescript" operationID="list_gift_cards" method="get" path="/gift-cards" -->
|
|
301
305
|
```typescript
|
|
302
306
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
303
307
|
|
|
@@ -13,6 +13,7 @@ List all the stored payment methods for a specific buyer.
|
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="list_buyer_payment_methods" method="get" path="/buyers/payment-methods" -->
|
|
16
17
|
```typescript
|
|
17
18
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
18
19
|
|
|
@@ -15,6 +15,7 @@ List refunds for a transaction.
|
|
|
15
15
|
|
|
16
16
|
### Example Usage
|
|
17
17
|
|
|
18
|
+
<!-- UsageSnippet language="typescript" operationID="list_transaction_refunds" method="get" path="/transactions/{transaction_id}/refunds" -->
|
|
18
19
|
```typescript
|
|
19
20
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
20
21
|
|
|
@@ -107,6 +108,7 @@ Create a refund for a transaction.
|
|
|
107
108
|
|
|
108
109
|
### Example Usage
|
|
109
110
|
|
|
111
|
+
<!-- UsageSnippet language="typescript" operationID="create_transaction_refund" method="post" path="/transactions/{transaction_id}/refunds" -->
|
|
110
112
|
```typescript
|
|
111
113
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
112
114
|
|
|
@@ -200,6 +202,7 @@ Fetch refund for a transaction.
|
|
|
200
202
|
|
|
201
203
|
### Example Usage
|
|
202
204
|
|
|
205
|
+
<!-- UsageSnippet language="typescript" operationID="get_transaction_refund" method="get" path="/transactions/{transaction_id}/refunds/{refund_id}" -->
|
|
203
206
|
```typescript
|
|
204
207
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
205
208
|
|
package/docs/sdks/jobs/README.md
CHANGED
|
@@ -13,6 +13,7 @@ Schedule one or more stored cards for an account update.
|
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="create_account_updater_job" method="post" path="/account-updater/jobs" -->
|
|
16
17
|
```typescript
|
|
17
18
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
18
19
|
|
|
@@ -16,6 +16,7 @@ List all merchant accounts in an instance.
|
|
|
16
16
|
|
|
17
17
|
### Example Usage
|
|
18
18
|
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="list_merchant_accounts" method="get" path="/merchant-accounts" -->
|
|
19
20
|
```typescript
|
|
20
21
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
21
22
|
|
|
@@ -111,6 +112,7 @@ Create a new merchant account in an instance.
|
|
|
111
112
|
|
|
112
113
|
### Example Usage
|
|
113
114
|
|
|
115
|
+
<!-- UsageSnippet language="typescript" operationID="create_merchant_account" method="post" path="/merchant-accounts" -->
|
|
114
116
|
```typescript
|
|
115
117
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
116
118
|
|
|
@@ -208,6 +210,7 @@ Get info about a merchant account in an instance.
|
|
|
208
210
|
|
|
209
211
|
### Example Usage
|
|
210
212
|
|
|
213
|
+
<!-- UsageSnippet language="typescript" operationID="get_merchant_account" method="get" path="/merchant-accounts/{merchant_account_id}" -->
|
|
211
214
|
```typescript
|
|
212
215
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
213
216
|
|
|
@@ -297,6 +300,7 @@ Update info for a merchant account in an instance.
|
|
|
297
300
|
|
|
298
301
|
### Example Usage
|
|
299
302
|
|
|
303
|
+
<!-- UsageSnippet language="typescript" operationID="update_merchant_account" method="put" path="/merchant-accounts/{merchant_account_id}" -->
|
|
300
304
|
```typescript
|
|
301
305
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
302
306
|
|
|
@@ -17,6 +17,7 @@ List all network tokens stored for a payment method.
|
|
|
17
17
|
|
|
18
18
|
### Example Usage
|
|
19
19
|
|
|
20
|
+
<!-- UsageSnippet language="typescript" operationID="list_payment_method_network_tokens" method="get" path="/payment-methods/{payment_method_id}/network-tokens" -->
|
|
20
21
|
```typescript
|
|
21
22
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
22
23
|
|
|
@@ -109,6 +110,7 @@ Provision a network token for a payment method.
|
|
|
109
110
|
|
|
110
111
|
### Example Usage
|
|
111
112
|
|
|
113
|
+
<!-- UsageSnippet language="typescript" operationID="create_payment_method_network_token" method="post" path="/payment-methods/{payment_method_id}/network-tokens" -->
|
|
112
114
|
```typescript
|
|
113
115
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
114
116
|
|
|
@@ -208,6 +210,7 @@ Suspend a network token for a payment method.
|
|
|
208
210
|
|
|
209
211
|
### Example Usage
|
|
210
212
|
|
|
213
|
+
<!-- UsageSnippet language="typescript" operationID="suspend_payment_method_network_token" method="post" path="/payment-methods/{payment_method_id}/network-tokens/{network_token_id}/suspend" -->
|
|
211
214
|
```typescript
|
|
212
215
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
213
216
|
|
|
@@ -301,6 +304,7 @@ Resume a suspended network token for a payment method.
|
|
|
301
304
|
|
|
302
305
|
### Example Usage
|
|
303
306
|
|
|
307
|
+
<!-- UsageSnippet language="typescript" operationID="resume_payment_method_network_token" method="post" path="/payment-methods/{payment_method_id}/network-tokens/{network_token_id}/resume" -->
|
|
304
308
|
```typescript
|
|
305
309
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
306
310
|
|
|
@@ -394,6 +398,7 @@ Delete a network token for a payment method.
|
|
|
394
398
|
|
|
395
399
|
### Example Usage
|
|
396
400
|
|
|
401
|
+
<!-- UsageSnippet language="typescript" operationID="delete_payment_method_network_token" method="delete" path="/payment-methods/{payment_method_id}/network-tokens/{network_token_id}" -->
|
|
397
402
|
```typescript
|
|
398
403
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
399
404
|
|
|
@@ -16,6 +16,7 @@ Create a new payment link.
|
|
|
16
16
|
|
|
17
17
|
### Example Usage
|
|
18
18
|
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="add_payment_link" method="post" path="/payment-links" -->
|
|
19
20
|
```typescript
|
|
20
21
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
21
22
|
|
|
@@ -116,6 +117,7 @@ List all created payment links.
|
|
|
116
117
|
|
|
117
118
|
### Example Usage
|
|
118
119
|
|
|
120
|
+
<!-- UsageSnippet language="typescript" operationID="list_payment_links" method="get" path="/payment-links" -->
|
|
119
121
|
```typescript
|
|
120
122
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
121
123
|
|
|
@@ -213,6 +215,7 @@ Expire an existing payment link.
|
|
|
213
215
|
|
|
214
216
|
### Example Usage
|
|
215
217
|
|
|
218
|
+
<!-- UsageSnippet language="typescript" operationID="expire_payment_link" method="post" path="/payment-links/{payment_link_id}/expire" -->
|
|
216
219
|
```typescript
|
|
217
220
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
218
221
|
|
|
@@ -305,6 +308,7 @@ Fetch the details for a payment link.
|
|
|
305
308
|
|
|
306
309
|
### Example Usage
|
|
307
310
|
|
|
311
|
+
<!-- UsageSnippet language="typescript" operationID="get_payment_link" method="get" path="/payment-links/{payment_link_id}" -->
|
|
308
312
|
```typescript
|
|
309
313
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
310
314
|
|
|
@@ -16,6 +16,7 @@ List all stored payment method.
|
|
|
16
16
|
|
|
17
17
|
### Example Usage
|
|
18
18
|
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="list_payment_methods" method="get" path="/payment-methods" -->
|
|
19
20
|
```typescript
|
|
20
21
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
21
22
|
|
|
@@ -111,6 +112,7 @@ Store a new payment method.
|
|
|
111
112
|
|
|
112
113
|
### Example Usage
|
|
113
114
|
|
|
115
|
+
<!-- UsageSnippet language="typescript" operationID="create_payment_method" method="post" path="/payment-methods" -->
|
|
114
116
|
```typescript
|
|
115
117
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
116
118
|
|
|
@@ -209,6 +211,7 @@ Retrieve a payment method.
|
|
|
209
211
|
|
|
210
212
|
### Example Usage
|
|
211
213
|
|
|
214
|
+
<!-- UsageSnippet language="typescript" operationID="get_payment_method" method="get" path="/payment-methods/{payment_method_id}" -->
|
|
212
215
|
```typescript
|
|
213
216
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
214
217
|
|
|
@@ -301,6 +304,7 @@ Delete a payment method.
|
|
|
301
304
|
|
|
302
305
|
### Example Usage
|
|
303
306
|
|
|
307
|
+
<!-- UsageSnippet language="typescript" operationID="delete_payment_method" method="delete" path="/payment-methods/{payment_method_id}" -->
|
|
304
308
|
```typescript
|
|
305
309
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
306
310
|
|
|
@@ -13,6 +13,7 @@ List the payment options available at checkout. filtering by country, currency,
|
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="list_payment_options" method="post" path="/payment-options" -->
|
|
16
17
|
```typescript
|
|
17
18
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
18
19
|
|
|
@@ -15,6 +15,7 @@ List the definitions of each payment service that can be configured.
|
|
|
15
15
|
|
|
16
16
|
### Example Usage
|
|
17
17
|
|
|
18
|
+
<!-- UsageSnippet language="typescript" operationID="list_payment_service_definitions" method="get" path="/payment-service-definitions" -->
|
|
18
19
|
```typescript
|
|
19
20
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
20
21
|
|
|
@@ -109,6 +110,7 @@ Get the definition of a payment service that can be configured.
|
|
|
109
110
|
|
|
110
111
|
### Example Usage
|
|
111
112
|
|
|
113
|
+
<!-- UsageSnippet language="typescript" operationID="get_payment_service_definition" method="get" path="/payment-service-definitions/{payment_service_definition_id}" -->
|
|
112
114
|
```typescript
|
|
113
115
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
114
116
|
|
|
@@ -198,6 +200,7 @@ Creates a session for a payment service that supports sessions.
|
|
|
198
200
|
|
|
199
201
|
### Example Usage
|
|
200
202
|
|
|
203
|
+
<!-- UsageSnippet language="typescript" operationID="create_payment_service_definition_session" method="post" path="/payment-service-definitions/{payment_service_definition_id}/sessions" -->
|
|
201
204
|
```typescript
|
|
202
205
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
203
206
|
|
|
@@ -19,6 +19,7 @@ List the configured payment services.
|
|
|
19
19
|
|
|
20
20
|
### Example Usage
|
|
21
21
|
|
|
22
|
+
<!-- UsageSnippet language="typescript" operationID="list_payment_services" method="get" path="/payment-services" -->
|
|
22
23
|
```typescript
|
|
23
24
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
24
25
|
|
|
@@ -114,6 +115,7 @@ Updates the configuration of a payment service.
|
|
|
114
115
|
|
|
115
116
|
### Example Usage
|
|
116
117
|
|
|
118
|
+
<!-- UsageSnippet language="typescript" operationID="update_payment_service" method="post" path="/payment-services" -->
|
|
117
119
|
```typescript
|
|
118
120
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
119
121
|
|
|
@@ -256,6 +258,7 @@ Get the details of a configured payment service.
|
|
|
256
258
|
|
|
257
259
|
### Example Usage
|
|
258
260
|
|
|
261
|
+
<!-- UsageSnippet language="typescript" operationID="get_payment_service" method="get" path="/payment-services/{payment_service_id}" -->
|
|
259
262
|
```typescript
|
|
260
263
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
261
264
|
|
|
@@ -348,6 +351,7 @@ Configures a new payment service for use by merchants.
|
|
|
348
351
|
|
|
349
352
|
### Example Usage
|
|
350
353
|
|
|
354
|
+
<!-- UsageSnippet language="typescript" operationID="create_payment_service" method="put" path="/payment-services/{payment_service_id}" -->
|
|
351
355
|
```typescript
|
|
352
356
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
353
357
|
|
|
@@ -445,6 +449,7 @@ Deletes all the configuration of a payment service.
|
|
|
445
449
|
|
|
446
450
|
### Example Usage
|
|
447
451
|
|
|
452
|
+
<!-- UsageSnippet language="typescript" operationID="delete_payment_service" method="delete" path="/payment-services/{payment_service_id}" -->
|
|
448
453
|
```typescript
|
|
449
454
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
450
455
|
|
|
@@ -537,6 +542,7 @@ Verify the credentials of a configured payment service
|
|
|
537
542
|
|
|
538
543
|
### Example Usage
|
|
539
544
|
|
|
545
|
+
<!-- UsageSnippet language="typescript" operationID="verify_payment_service_credentials" method="post" path="/payment-services/verify" -->
|
|
540
546
|
```typescript
|
|
541
547
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
542
548
|
|
|
@@ -635,6 +641,7 @@ Creates a session for a payment service that supports sessions.
|
|
|
635
641
|
|
|
636
642
|
### Example Usage
|
|
637
643
|
|
|
644
|
+
<!-- UsageSnippet language="typescript" operationID="create_payment_service_session" method="post" path="/payment-services/{payment_service_id}/sessions" -->
|
|
638
645
|
```typescript
|
|
639
646
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
640
647
|
|
|
@@ -15,6 +15,7 @@ List all gateway tokens stored for a payment method.
|
|
|
15
15
|
|
|
16
16
|
### Example Usage
|
|
17
17
|
|
|
18
|
+
<!-- UsageSnippet language="typescript" operationID="list_payment_method_payment_service_tokens" method="get" path="/payment-methods/{payment_method_id}/payment-service-tokens" -->
|
|
18
19
|
```typescript
|
|
19
20
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
20
21
|
|
|
@@ -108,6 +109,7 @@ Create a gateway tokens for a payment method.
|
|
|
108
109
|
|
|
109
110
|
### Example Usage
|
|
110
111
|
|
|
112
|
+
<!-- UsageSnippet language="typescript" operationID="create_payment_method_payment_service_token" method="post" path="/payment-methods/{payment_method_id}/payment-service-tokens" -->
|
|
111
113
|
```typescript
|
|
112
114
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
113
115
|
|
|
@@ -207,6 +209,7 @@ Delete a gateway tokens for a payment method.
|
|
|
207
209
|
|
|
208
210
|
### Example Usage
|
|
209
211
|
|
|
212
|
+
<!-- UsageSnippet language="typescript" operationID="delete_payment_method_payment_service_token" method="delete" path="/payment-methods/{payment_method_id}/payment-service-tokens/{payment_service_token_id}" -->
|
|
210
213
|
```typescript
|
|
211
214
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
212
215
|
|
|
@@ -15,6 +15,7 @@ Returns a list of payouts made.
|
|
|
15
15
|
|
|
16
16
|
### Example Usage
|
|
17
17
|
|
|
18
|
+
<!-- UsageSnippet language="typescript" operationID="list_payouts" method="get" path="/payouts" -->
|
|
18
19
|
```typescript
|
|
19
20
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
20
21
|
|
|
@@ -112,6 +113,7 @@ Creates a new payout.
|
|
|
112
113
|
|
|
113
114
|
### Example Usage
|
|
114
115
|
|
|
116
|
+
<!-- UsageSnippet language="typescript" operationID="create_payout" method="post" path="/payouts" -->
|
|
115
117
|
```typescript
|
|
116
118
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
117
119
|
|
|
@@ -220,6 +222,7 @@ Retrieves a payout.
|
|
|
220
222
|
|
|
221
223
|
### Example Usage
|
|
222
224
|
|
|
225
|
+
<!-- UsageSnippet language="typescript" operationID="get_payout" method="get" path="/payouts/{payout_id}" -->
|
|
223
226
|
```typescript
|
|
224
227
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
225
228
|
|
|
@@ -13,6 +13,7 @@ List all executed reports that have been generated.
|
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="list_all_report_executions" method="get" path="/report-executions" -->
|
|
16
17
|
```typescript
|
|
17
18
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
18
19
|
|
|
@@ -16,6 +16,7 @@ List all configured reports that can be generated.
|
|
|
16
16
|
|
|
17
17
|
### Example Usage
|
|
18
18
|
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="list_reports" method="get" path="/reports" -->
|
|
19
20
|
```typescript
|
|
20
21
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
21
22
|
|
|
@@ -111,6 +112,7 @@ Create a new report.
|
|
|
111
112
|
|
|
112
113
|
### Example Usage
|
|
113
114
|
|
|
115
|
+
<!-- UsageSnippet language="typescript" operationID="add_report" method="post" path="/reports" -->
|
|
114
116
|
```typescript
|
|
115
117
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
116
118
|
|
|
@@ -235,6 +237,7 @@ Fetches a report by its ID.
|
|
|
235
237
|
|
|
236
238
|
### Example Usage
|
|
237
239
|
|
|
240
|
+
<!-- UsageSnippet language="typescript" operationID="get_report" method="get" path="/reports/{report_id}" -->
|
|
238
241
|
```typescript
|
|
239
242
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
240
243
|
|
|
@@ -327,6 +330,7 @@ Updates the configuration of a report.
|
|
|
327
330
|
|
|
328
331
|
### Example Usage
|
|
329
332
|
|
|
333
|
+
<!-- UsageSnippet language="typescript" operationID="update_report" method="put" path="/reports/{report_id}" -->
|
|
330
334
|
```typescript
|
|
331
335
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
332
336
|
|
|
@@ -15,6 +15,7 @@ Create a session for use with Google Pay.
|
|
|
15
15
|
|
|
16
16
|
### Example Usage
|
|
17
17
|
|
|
18
|
+
<!-- UsageSnippet language="typescript" operationID="create_google_pay_digital_wallet_session" method="post" path="/digital-wallets/google/session" -->
|
|
18
19
|
```typescript
|
|
19
20
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
20
21
|
|
|
@@ -111,6 +112,7 @@ Create a session for use with Apple Pay.
|
|
|
111
112
|
|
|
112
113
|
### Example Usage
|
|
113
114
|
|
|
115
|
+
<!-- UsageSnippet language="typescript" operationID="create_apple_pay_digital_wallet_session" method="post" path="/digital-wallets/apple/session" -->
|
|
114
116
|
```typescript
|
|
115
117
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
116
118
|
|
|
@@ -209,6 +211,7 @@ Create a session for use with Click to Pay.
|
|
|
209
211
|
|
|
210
212
|
### Example Usage
|
|
211
213
|
|
|
214
|
+
<!-- UsageSnippet language="typescript" operationID="create_click_to_pay_digital_wallet_session" method="post" path="/digital-wallets/click-to-pay/session" -->
|
|
212
215
|
```typescript
|
|
213
216
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
214
217
|
|
|
@@ -14,6 +14,7 @@ Retrieve a specific settlement for a transaction by its unique identifier.
|
|
|
14
14
|
|
|
15
15
|
### Example Usage
|
|
16
16
|
|
|
17
|
+
<!-- UsageSnippet language="typescript" operationID="get_transaction_settlement" method="get" path="/transactions/{transaction_id}/settlements/{settlement_id}" -->
|
|
17
18
|
```typescript
|
|
18
19
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
19
20
|
|
|
@@ -107,6 +108,7 @@ List all settlements for a specific transaction.
|
|
|
107
108
|
|
|
108
109
|
### Example Usage
|
|
109
110
|
|
|
111
|
+
<!-- UsageSnippet language="typescript" operationID="list_transaction_settlements" method="get" path="/transactions/{transaction_id}/settlements" -->
|
|
110
112
|
```typescript
|
|
111
113
|
import { Gr4vy } from "@gr4vy/sdk";
|
|
112
114
|
|