List settlements

GET

/v2/settlements

curl --request GET \
  --url 'https://api.orderfast.com.ar/v2/settlements?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

• Production
• Testing
• Local

Authorizations

• api-key

Parameters

Query Parameters

limit

object

Example

50

offset

object

Example

0

Responses

200

Successful paginated response

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string

batch_number

required

string

started_at

required

string

ended_at

string

total_orders

number

total_collected

number

average_ticket

number

pagination

required

object

limit

required

number

offset

required

number

total

required

number

Example

{
  "data": [
    {
      "id": "turn_123",
      "batch_number": "2026-07-07-001",
      "started_at": "2026-07-07T08:00:00.000Z",
      "ended_at": "2026-07-07T16:00:00.000Z",
      "total_orders": 42,
      "total_collected": 250000,
      "average_ticket": 5952.38
    },
    {
      "id": "turn_123",
      "batch_number": "2026-07-07-001",
      "started_at": "2026-07-07T08:00:00.000Z",
      "ended_at": "2026-07-07T16:00:00.000Z",
      "total_orders": 42,
      "total_collected": 250000,
      "average_ticket": 5952.38
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 100
  }
}

401

Unauthorized — missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error

message

required

string

request_id

required

string

Examples

Exampleunauthorized

Invalid API key

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key",
    "request_id": "req_01J..."
  }
}

403

Permission denied

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error

message

required

string

request_id

required

string

Examples

Examplepermission_denied

Missing permission

{
  "error": {
    "code": "permission_denied",
    "message": "The API key does not have the required permission",
    "request_id": "req_01J..."
  }
}

422

Validation error

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error

message

required

string

request_id

required

string

Examples

Examplevalidation_error

Invalid body or query

{
  "error": {
    "code": "validation_error",
    "message": "One or more fields failed validation",
    "request_id": "req_01J..."
  }
}

500

Internal server error

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error

message

required

string

request_id

required

string

Examples

Exampleinternal_error

Unexpected failure

{
  "error": {
    "code": "internal_error",
    "message": "An unexpected error occurred",
    "request_id": "req_01J..."
  }
}