Skip to content

README.md

Latest commit

 

History

History
65 lines (49 loc) · 8.66 KB

README.md

File metadata and controls

65 lines (49 loc) · 8.66 KB

Transactions.Refunds.All

Overview

Available Operations

  • Create - Create batch transaction refund

Create

Create a refund for all instruments on a transaction.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    merchantAccountId: "default",
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>"
);

var res = await sdk.Transactions.Refunds.All.CreateAsync(
    transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591",
    transactionRefundAllCreate: new TransactionRefundAllCreate() {
        Reason = "Refund due to user request.",
        ExternalIdentifier = "refund-12345",
    }
);

// handle response

Parameters

Parameter Type Required Description Example
TransactionId string ✔️ The ID of the transaction 7099948d-7286-47e4-aad8-b68f7eb44591
MerchantAccountId string ➖ The ID of the merchant account to use for this request. default
IdempotencyKey string ➖ A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions. request-12345
TransactionRefundAllCreate TransactionRefundAllCreate ➖ N/A

Response

Models.Components.Refunds

Errors

Error Type Status Code Content Type
Gr4vy.Models.Errors.Error400 400 application/json
Gr4vy.Models.Errors.Error401 401 application/json
Gr4vy.Models.Errors.Error403 403 application/json
Gr4vy.Models.Errors.Error404 404 application/json
Gr4vy.Models.Errors.Error405 405 application/json
Gr4vy.Models.Errors.Error409 409 application/json
Gr4vy.Models.Errors.HTTPValidationError 422 application/json
Gr4vy.Models.Errors.Error425 425 application/json
Gr4vy.Models.Errors.Error429 429 application/json
Gr4vy.Models.Errors.Error500 500 application/json
Gr4vy.Models.Errors.Error502 502 application/json
Gr4vy.Models.Errors.Error504 504 application/json
Gr4vy.Models.Errors.APIException 4XX, 5XX */*