Skip to main content
GET
/
transactions
/
{transaction_id}
/
settlements
/
{settlement_id}
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.GetAsync(
    transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591",
    settlementId: "b1e2c3d4-5678-1234-9abc-1234567890ab"
);

// handle response
{
  "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

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

Path Parameters

​
transaction_id
string<uuid>
required

The unique identifier of the transaction. The unique identifier of the transaction.

​
settlement_id
string<uuid>
required

The unique identifier of the settlement. The unique identifier of the settlement.

Response

Successful Response

A settlement record for a transaction.

​
id
string<uuid>
required

The unique identifier for the record.

​
merchant_account_id
string
required

The merchant account this record belongs to.

​
created_at
string<date-time>
required

The date and time the record was created, in ISO 8601 format.

​
updated_at
string<date-time>
required

The date and time the record was last updated, in ISO 8601 format.

​
posted_at
string<date-time>
required

The date and time the record was posted, in ISO 8601 format.

​
ingested_at
string<date-time>
required

The date and time the record was ingested, in ISO 8601 format.

​
currency
string
required

ISO 4217 currency code.

​
amount
integer
required

The total amount in the smallest currency unit (e.g. cents).

​
commission
integer
required

The commission amount deducted in the smallest currency unit.

​
payment_service_report_id
string<uuid>
required

The report ID from the payment service.

​
payment_service_report_file_ids
string<uuid>[]
required

List of file IDs for the payment service report.

​
transaction_id
string<uuid>
required

The transaction this record is associated with.

​
exchange_rate
number | null

The exchange rate, if applicable.

Example:

1

​
interchange
integer | null

The interchange fee, if applicable, in the smallest currency unit.

Example:

50

​
markup
integer | null

The markup fee, if applicable, in the smallest currency unit.

Example:

10

​
scheme_fee
integer | null

The scheme fee, if applicable, in the smallest currency unit.

Example:

5

​
type
string
default:settlement

Always settlement.

Allowed value: "settlement"