Easy Labs
APITreasurySettlement

Get a settlement by ID

Retrieve a settlement by its ID

GET
/v1/api/settlements/{id}

Authorization

apiKey
x-easy-api-key<token>

Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/v1/api/settlements/string"
{
  "success": true,
  "timestamp": "2026-02-06T12:00:00.000Z",
  "data": {
    "id": "STxxxxxxxxxxxxxxxxxx",
    "status": "PENDING",
    "net_amount": 50000,
    "total_amount": 52500,
    "total_fees": 2500,
    "currency": "USD",
    "transfer_count": 25,
    "funding_transfers": [],
    "created_at": "2026-01-31T00:00:00.000Z"
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}

Fund a settlement (Finix→Brale instant payout)

Initiate an instant payout against a settlement. Wraps Finix's `POST /settlements/{id}/funding_transfer_attempts`. The destination must be a payment instrument owned by the authenticated company (debit card, typically a Brale-issued one). `amount` is in cents and cannot exceed the settlement's `net_amount`. This is the Finix→Brale movement that was missing from the API surface — see `tasks/transfer-endpoint-gap.md`.

Get settlements

Retrieve a list of settlements