Skip to main content
GET
/
v1
/
settlement
/
batches
List settlement batches
curl --request GET \
  --url https://api.leanrails.com/v1/settlement/batches \
  --header 'Authorization: Basic <encoded-value>'
{
  "object": "list",
  "data": [
    {
      "id": "sbatch_xxx",
      "object": "settlement_batch",
      "status": "pending",
      "total_gross": 123,
      "total_fees": 123,
      "total_net": 123,
      "total_reserves": 123,
      "transfer_amount": 123,
      "currency": "<string>",
      "period_start": 123,
      "period_end": 123,
      "settlement_date": "<string>",
      "payment_count": 123,
      "livemode": true,
      "created": 123,
      "transfer_id": "<string>",
      "error_message": "<string>",
      "completed_at": 123,
      "metadata": {}
    }
  ],
  "has_more": true,
  "url": "/v1/settlement/batches",
  "next_cursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.fluveo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use your secret API key as the username with an empty password.

Headers

​
X-API-Version
string

Override the API version for this request.

Query Parameters

​
limit
integer
default:10

Number of objects to return (1-100).

Required range: 1 <= x <= 100
​
starting_after
string

Cursor for forward pagination. The ID of the last object in the previous page.

​
ending_before
string

Cursor for backward pagination. The ID of the first object in the previous page.

​
status
enum<string>

Filter by settlement batch status.

Available options:
pending,
processing,
completed,
failed

Response

A list of SettlementBatches.

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
​
has_more
boolean
required
​
url
string
required
Example:

"/v1/settlement/batches"

​
next_cursor
string | null