Skip to main content

A settlement window representing a merchant payout cycle

​
id
string<uuid>
required

Unique settlement window identifier

Example:

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

​
merchant_id
string
required

Merchant identifier

Example:

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

​
cycle_id
string
required

Settlement cycle identifier

Example:

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

​
value_date
string<date-time>
required

Date that actual settlement should be sent

Example:

"2024-01-01T23:59:59.000Z"

​
status
required

Window is open and accepting transactions

Allowed value: "OPENED"
​
created_by
string
required

User who created the settlement window

Example:

"system"

​
updated_by
string
required

User who last updated the settlement window

Example:

"system"

​
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"

​
closing_date
string<date-time>

Date after all instructions are done and window is completed

Example:

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

​
total_instructions
integer

Total number of instructions in this window

Required range: x >= 0
Example:

5

​
total_amount
integer

Total sales amount in minor units

Required range: x >= 0
Example:

100000

​
settled_amount
integer

Total settled amount in minor units (sum of transaction settled amounts)

Required range: x >= 0
Example:

95000

​
currency
string

Currency code (ISO 4217)

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

"USD"