Skip to main content
GET
/
v1
/
settlement
/
batches
/
{id}
Retrieve a settlement batch
curl --request GET \
  --url https://api.leanrails.com/v1/settlement/batches/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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": {}
}

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.

Path Parameters

id
string
required

The settlement batch ID.

Response

The SettlementBatch.

id
string
required
Example:

"sbatch_xxx"

object
enum<string>
required
Available options:
settlement_batch
status
enum<string>
required

Current status of the settlement batch.

Available options:
pending,
processing,
completed,
failed
total_gross
integer
required

Total gross amount in smallest currency unit.

total_fees
integer
required

Total fees deducted in smallest currency unit.

total_net
integer
required

Net amount after fees in smallest currency unit.

total_reserves
integer
required

Amount held in rolling reserve.

transfer_amount
integer
required

Amount transferred to your bank account.

currency
string
required

Three-letter ISO currency code.

period_start
integer
required

Unix timestamp of period start.

period_end
integer
required

Unix timestamp of period end.

settlement_date
string
required

Settlement date in YYYY-MM-DD format.

payment_count
integer
required

Number of payments included in this batch.

livemode
boolean
required
created
integer
required

Unix timestamp.

transfer_id
string | null

ID of the associated transfer.

error_message
string | null
completed_at
integer | null

Unix timestamp when completed.

metadata
object

Set of key-value pairs for storing additional information.