Settlements
Get settlement by ID
Returns the full details of a single settlement, including aggregated volumes, fee breakdown, rolling reserve, adjustments, and net amount paid to the merchant. Returns 404 if the settlement does not exist or is not visible to the caller.
Authorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
curl -X GET "https://<api-host>/v1/settlements/string"{
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
"livemode": true,
"merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"currency": "string",
"period": {
"from": "string",
"to": "string"
},
"grossVolume": {
"currency": "string",
"valueMinor": 9007199254740991
},
"refundVolume": {
"currency": "string",
"valueMinor": 9007199254740991
},
"chargebackVolume": {
"currency": "string",
"valueMinor": 9007199254740991
},
"merchantFee": {
"currency": "string",
"valueMinor": 9007199254740991
},
"feeBreakdown": {
"providerFee": {
"currency": "string",
"valueMinor": 9007199254740991
},
"platformFee": {
"currency": "string",
"valueMinor": 9007199254740991
},
"tenantFee": {
"currency": "string",
"valueMinor": -9007199254740991
},
"partnerCommission": {
"currency": "string",
"valueMinor": 9007199254740991
}
},
"rollingReserveHeld": {
"currency": "string",
"valueMinor": 9007199254740991
},
"rollingReserveReleased": {
"currency": "string",
"valueMinor": 9007199254740991
},
"recurrentFees": {
"currency": "string",
"valueMinor": 9007199254740991
},
"adjustment": {
"currency": "string",
"valueMinor": 9007199254740991
},
"adjustmentDirection": "credit",
"adjustmentReason": "string",
"netToMerchant": {
"currency": "string",
"valueMinor": -9007199254740991
},
"status": "draft",
"generationMode": "automatic",
"linkedSettlementId": "a5b4ae99-b2c7-4597-bf95-7fafa4c7a116",
"createdAt": "string",
"updatedAt": "string",
"finalizedAt": "string",
"deletedAt": "string"
}
}Empty
List refunds for payment
Returns all refunds for the specified payment, most recent first. Uses cursor-based pagination — pass `cursor` from a previous response to fetch the next page. Default page size is 20, maximum 100. Returns an empty list if the payment has no refunds.
List settlements
Returns a paginated list of settlements visible to the caller. Filters: `merchantId`, `currency`, `status`, `periodFrom`, `periodTo`. Cursor-based pagination — default page size 20, maximum 100.