Skip to content

README.md

Latest commit

 

History

History
112 lines (83 loc) · 7.8 KB

README.md

File metadata and controls

112 lines (83 loc) · 7.8 KB

Transactions.Settlements

Overview

Available Operations

  • Get - Get transaction settlement
  • List - List transaction settlements

Get

Retrieve a specific settlement for a transaction by its unique identifier.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

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

var res = await sdk.Transactions.Settlements.GetAsync(
    transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591",
    settlementId: "b1e2c3d4-5678-1234-9abc-1234567890ab"
);

// handle response

Parameters

Parameter Type Required Description Example
TransactionId string ✔️ The unique identifier of the transaction. 7099948d-7286-47e4-aad8-b68f7eb44591
SettlementId string ✔️ The unique identifier of the settlement. b1e2c3d4-5678-1234-9abc-1234567890ab
MerchantAccountId string ➖ The ID of the merchant account to use for this request. default

Response

Settlement

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 */*

List

List all settlements for a specific 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.Settlements.ListAsync(transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591");

// handle response

Parameters

Parameter Type Required Description Example
TransactionId string ✔️ The unique identifier of the transaction. 7099948d-7286-47e4-aad8-b68f7eb44591
MerchantAccountId string ➖ The ID of the merchant account to use for this request. default

Response

Models.Components.Settlements

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 */*