Settlements

Financial settlements and reconciliation.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdstringOptionalExample: user-uuid

sourcestringOptionalExample: ORDER_BUNDLE

eventIdstringOptionalExample: event-uuid

createdStartDatestring · date-timeOptionalExample: 2024-01-01T00:00:00.000Z

createdEndDatestring · date-timeOptionalExample: 2024-01-31T23:59:59.999Z

grossFromnumberOptionalExample: 100

grossTonumberOptionalExample: 1000

pagenumberOptionalExample: 1

ippnumberOptionalExample: 30

expandstring[]OptionalExample: ["user","payment","event"]

sortstringOptionalExample: createdDate:DESC

paymentIdstringOptionalExample: payment-uuid

Responses

200

Returns a SettlementCollectionDto

application/json

get/settlements

GET /apis/v2/settlements HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a SettlementCollectionDto

{
  "items": [
    {
      "id": "text",
      "createdDate": "2026-01-01T00:00:00.000Z",
      "updatedDate": "2026-01-01T00:00:00.000Z",
      "payoutDate": "2026-01-01T00:00:00.000Z",
      "source": "text",
      "description": "text",
      "financials": {
        "paymentMethod": "text",
        "currency": "text",
        "subtotal": 1,
        "discounts": 1,
        "taxableAmount": 1,
        "taxes": [
          {
            "name": "text",
            "amount": 1,
            "percentage": 1
          }
        ],
        "taxAmount": 1,
        "grossAmount": 1,
        "virtualCredits": 1,
        "paymentGatewayAmount": 1,
        "fees": 1,
        "cashAmount": 1,
        "feeItems": 1,
        "feeItemsTotal": 1,
        "netAmount": 1,
        "netRevenue": 1
      },
      "notes": "text",
      "payment": {
        "id": "text"
      },
      "lineItems": {
        "items": [
          {
            "id": "text",
            "description": "text",
            "quantity": 1,
            "unitPrice": 1,
            "unitDiscount": 1,
            "proratedDiscount": 1,
            "subtotal": 1,
            "totalDiscount": 1,
            "taxableAmount": 1,
            "taxAmount": 1,
            "taxes": [
              {
                "name": "text",
                "amount": 1,
                "percentage": 1
              }
            ],
            "grossAmount": 1,
            "category": "text"
          }
        ],
        "total": 1,
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "user": {
        "id": "text"
      },
      "orders": {
        "_total": 1
      },
      "event": {
        "id": "text"
      },
      "_links": {}
    }
  ],
  "_pagination": {
    "page": 1,
    "ipp": 1,
    "count": 1,
    "total": 1
  },
  "_links": {
    "self": {
      "href": "text"
    }
  }
}