GET
/
transactions
/
{transaction_id}
/
settlements
/
{settlement_id}

This endpoint requires the transactions.read scope.

Authorizations

Authorization
string
headerrequired

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

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.