List settlement records

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.

Response

200 - application/json

A list of settlements.

items

object[]

A list of settlements.

items.amount

integer

The net amount of this settlement.

items.commission

integer

The total commission of this settlement, expressed in currency.

items.created_at

string

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

items.currency

string

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

items.exchange_rate

number | null

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

items.id

string

The unique identifier for this settlement.

items.ingested_at

string

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

items.interchange

integer | null

The interchange fee of this settlement, expressed in currency.

items.markup

integer | null

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

items.merchant_account_id

string

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

items.payment_service_report_file_ids

string[]

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

items.payment_service_report_id

string

The ID of the payment service report containing this settlement.

items.posted_at

string

The date and time when this settlement occurred.

items.scheme_fee

integer | null

The scheme fee of this settlement, expressed in currency.

items.transaction_id

string

The ID of the transaction associated with this settlement.

items.type

enum<string>

The type of this resource. Is always settlement.

Available options:

settlement

items.updated_at

string

The date and time when this settlement was last updated.

Payments

Instruments

Vault

Connections

Dashboard

Errors

List settlements

Authorizations

Path Parameters

Response