Skip to main content

A settlement transaction record

​
id
string<uuid>
required

Unique transaction identifier

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

​
amount
integer
required

Transaction amount in minor units

Required range: x >= 0
Example:

100000

​
currency
string
required

Currency code (ISO 4217)

Required string length: 3
Pattern: ^[A-Z]{3}$
Example:

"USD"

​
external_reference_id
string
required

External reference ID - unique ID for the payment transaction or transfer from ledger

Example:

"payment_123456789"

​
status
required

Transaction counts towards its settlement window

Allowed value: "ACTIVE"
​
is_settled
boolean
required

Whether the transaction has been settled

Example:

false

​
created_at
string<date-time>
required

Creation timestamp

Example:

"2024-01-01T00:00:00.000Z"

​
updated_at
string<date-time>
required

Last update timestamp

Example:

"2024-01-01T00:00:00.000Z"

​
settled_amount
integer

Settled amount in minor units (calculated as total amount minus fees)

Required range: x >= 0
Example:

95000

​
settlement_window_id
string<uuid>

Settlement window ID assigned when associated to a window

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

​
payment_transaction_id
string

Payment transaction ID (for refunds, the parent payment transaction ID)

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

​
operation
enum<string> | null

Pricing operation that created the transaction

Available options:
authorize,
capture,
pay,
refund,
reversal_adjustment,
manual_adjustment,
null
Example:

"capture"

​
fees
object[]

Array of fee objects with fee type and amount in minor units

​
hold_at
string<date-time> | null

When a refund transaction was placed on hold

Example:

null

​
refunded_at
string<date-time> | null

When a held refund completed

Example:

null

​
removed_at
string<date-time> | null

When the transaction was removed or cancelled

Example:

null