GET
/
transactions
/
{transaction_id}
/
settlements
/
{settlement_id}
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/transactions/{transaction_id}/settlements/{settlement_id} \
  --header 'Authorization: Bearer <token>'
{
  "type": "settlement",
  "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "merchant_account_id": "default",
  "created_at": "2024-04-01T19:23:00.000+00:00",
  "updated_at": "2024-04-01T19:23:00.000+00:00",
  "posted_at": "2024-03-30T10:25:00.000+00:00",
  "ingested_at": "2013-04-01T01:01:00.000+00:00",
  "currency": "USD",
  "amount": 1299,
  "exchange_rate": 0.95,
  "commission": 5,
  "interchange": 5,
  "markup": 10,
  "scheme_fee": 5,
  "payment_service_report_id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
  "payment_service_report_file_ids": [
    "0302e601-d2c3-42b2-9825-9457145331ae",
    "7deec061-71a5-435f-beae-40f35820ca67"
  ],
  "transaction_id": "fe26475d-ec3e-4884-9553-f7356683f7f9"
}

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.

Path Parameters

​
transaction_id
string
required

The ID for the transaction to get the information for.

​
settlement_id
string
required

The unique ID of the settlement.

Response

200
application/json
Returns a settlement.

A settlement record.

​
type
enum<string>

The type of this resource. Is always settlement.

Available options:
settlement
​
id
string

The unique identifier for this settlement.

​
merchant_account_id
string

The ID of the merchant account to which this settlement belongs to.

​
created_at
string

The date and time when this settlement was created in our system.

​
updated_at
string

The date and time when this settlement was last updated.

​
posted_at
string

The date and time when this settlement occurred.

​
ingested_at
string

The date and time when information about this settlement was ingested into our system.

​
currency
string

The currency code of this settlement in ISO 4217 three-letter code format.

​
amount
integer

The net amount of this settlement.

​
exchange_rate
number | null

The exchange rate used to convert amounts from the processing currency to the settlement currency.

​
commission
integer

The total commission of this settlement, expressed in currency.

​
interchange
integer | null

The interchange fee of this settlement, expressed in currency.

​
markup
integer | null

The markup of this settlement by the acquirer, expressed in currency.

​
scheme_fee
integer | null

The scheme fee of this settlement, expressed in currency.

​
payment_service_report_id
string

The ID of the payment service report containing this settlement.

​
payment_service_report_file_ids
string[]

The list of payment service report file IDs that make up the payment service report containing this settlement.

​
transaction_id
string

The ID of the transaction associated with this settlement.

Was this page helpful?

Suggest edits
List settlement recordsList card scheme definitions