📘
Sandbox API URL: https://api.stage.siti.ws/api/v1/payins
Sandbox API & Sign key: 23455432-4444-3333-8888-123456654321
Sandbox Merchant ID: 23455432-4444-3333-8888-123456654321
Production credentials: Please contact your provider to obtain your production credentials

Export Payins

Retrieve and export payin payment records with optional filtering and pagination. Use request GET https://stage.siti.ws/api/v1/payinsand additional filtering parameters in query if applicable:

Parameter	Description	Example
orderId	Payment ID from your system	23872638746238
status	Payin status ("Done", "Settled", "New", "Failed", "IncompleteSettlement", "Processing", "AwaitingConfirmation")	"Done"
dateFrom	Start date for filtering payments (ISO-8601 format). Returns payments created on or after this date	2025-01-30
dateTo	End date for filtering payments (ISO-8601 format). Returns payments created on or before this date	2025-01-31
settlementDateFrom	Settlement date for filtering payments (ISO-8601 format). Returns payments settled on or after this date	2025-01-29
settlementDateTo	Settlement date for filtering payments (ISO-8601 format). Returns payments settled on or before this date	2025-01-31
limit	Number of records per page (max 1000, default: 1000)	67
cursor	pagination.next token to go to the next page	9f3a6c42-8e1b-4d77-b9d2-5f1c0a8e3c94

*None of the query parameters are required.

Tip: You can optionally use the limit parameter to control how many payments are returned. While not required, using it is recommended for better performance. This endpoint is paginated and returns a maximum of 1,000 payments per page (use pagination.next token for going to the next page).

Request Example

curl --location 'https://stage.siti.ws/api/v1/payins?startDate=2026-01-01&endDate=2026-01-31&status=Done&limit=6'
--header 'x-api-key: 23455432-4444-3333-8888-123456654321'

Response Example

{
  "data": [
    {
      "id": "9c7e4a1b-2f83-4d6a-9b1e-3c5f7a9d0123",
      "reference": "ABC123",
      "amount": 49.99,
      "currency": "EUR",
      "status": "Done",
      "createdDate": "2026-01-02T10:30:00Z",
      "finalisedDate": "2026-01-02T10:32:00Z",
      "order": {
        "id": "1e8f3a5b-2c4d-4e6f-9a12-b7c8d9e0f111",
        "description": "3f5e9b6a-91c2-4b7d-8e21-1f9a2c8d4a11"
      }
    },
    {
      "id": "b6f29d04-7c1e-4a93-8f52-1d4c7e90aabc",
      "reference": "DEF456",
      "amount": 89.5,
      "currency": "EUR",
      "status": "Done",
      "createdDate": "2026-01-05T09:15:00Z",
      "finalisedDate": "2026-01-05T09:18:00Z",
      "order": {
        "id": "7c92f4e1-8b0a-4f3c-9d6e-2a51e4c8b901",
        "description": "a8d4c9f1-2b7e-4c6a-9e13-77c2b91f0e54"
      }
    },
    {
      "id": "0f3a9c7e-6d4b-4c21-8e59-12a7d8c94b01",
      "reference": "GHI789",
      "amount": 15.0,
      "currency": "EUR",
      "status": "Done",
      "createdDate": "2026-01-10T14:05:00Z",
      "finalisedDate": "2026-01-10T14:06:00Z",
      "order": {
        "id": "c4a1e8b7-2d9f-4c31-a6e5-19f72b84d003",
        "description": "d91c0a84-6e3b-4f7a-8c52-2c94a71e6b90"
      }
    },
    {
      "id": "7a2c4e9b-1d83-4f52-9c06-5b6e8a1d3f44",
      "reference": "JKL012",
      "amount": 199.99,
      "currency": "EUR",
      "status": "Done",
      "createdDate": "2026-01-14T16:40:00Z",
      "finalisedDate": "2026-01-14T16:45:00Z",
      "order": {
        "id": "8f6d9a12-4b7e-4f91-9c03-5d1e2a4b6c78",
        "description": "5b72f09e-13c4-4b9d-8e1f-4a60c92d8f21"
      }
    },
    {
      "id": "4c8a7d12-9e03-4b6f-8c71-1d5a92e47f63",
      "reference": "MNO345",
      "amount": 32.75,
      "currency": "EUR",
      "status": "Done",
      "createdDate": "2026-01-20T11:20:00Z",
      "finalisedDate": "2026-01-20T11:22:00Z",
      "order": {
        "id": "2d4c6b8e-9a71-4f03-b512-8c7e1f94a632",
        "description": "9c3b6e2f-7a41-4f88-b59e-6d92c13e047a"
      }
    },
    {
      "id": "e12a9f8c-6b74-4d91-8c35-0f2d1a9b7e55",
      "reference": "PQR678",
      "amount": 120.0,
      "currency": "EUR",
      "status": "Done",
      "createdDate": "2026-01-28T08:55:00Z",
      "finalisedDate": "2026-01-28T09:00:00Z",
      "order": {
        "id": "f91c7b2e-4a83-4d6c-9e15-3b70d8a21f44",
        "description": "f2a71c9d-4e83-4d6a-9c5e-8b103a7d2f64"
      }
    }
  ],
  "pagination": {
    "next": "c1b2d3e4-5f6a-7b8c-9d0e-1f2a3b4c5d6e"
  }
}