Skip to main content
GET
/
transactions
/
{transaction_id}
/
settlements
C#
using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Transactions.Settlements.ListAsync(transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591");

// handle response
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchant_account_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "posted_at": "2023-11-07T05:31:56Z",
      "ingested_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "amount": 123,
      "commission": 123,
      "payment_service_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_service_report_file_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "exchange_rate": 1,
      "interchange": 50,
      "markup": 10,
      "scheme_fee": 5,
      "type": "settlement"
    }
  ]
}
This endpoint requires the transactions.read scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-gr4vy-merchant-account-id
string | null

The ID of the merchant account to use for this request.

Example:

"default"

Path Parameters

​
transaction_id
string<uuid>
required

The unique identifier of the transaction.

Example:

"7099948d-7286-47e4-aad8-b68f7eb44591"

Response

Successful Response

A list of settlement records for a transaction.

​
items
Settlement · object[]
required

The list of settlement objects.