Skip to main content
GET
List settlements

Authorizations

Authorization
string
header
required

Organization API key created in Grain Settings → API. The key determines the organization and is limited to its assigned resource scopes. Write scopes imply the corresponding read scope.

Headers

X-Organization-Id
string

Required with OAuth access tokens. Optional with organization API keys; if supplied, it must match the key's organization.

Query Parameters

page
integer
default:1

Page number (1-based)

Required range: x >= 1
limit
integer
default:20

Giving records per page

Required range: 1 <= x <= 100
provider
enum<string>
Available options:
STRIPE,
PUSHPAY,
SUBSPLASH,
TITHELY,
PLANNING_CENTER,
ROCK_RMS,
RAMP,
DIVVY,
MANUAL
status
enum<string>
Available options:
PENDING,
IN_TRANSIT,
DEPOSITED,
MATCHED,
RECONCILED,
FAILED,
CANCELLED
dateFrom
string<date>
dateTo
string<date>
givingIntegrationId
string
givingMerchantId
string
sortBy
enum<string>
default:estimatedArrivalDate
Available options:
estimatedArrivalDate,
totalGross,
totalNet,
createdAt
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

Paginated settlements

settlements
object[]
pagination
object
Last modified on August 23, 2026