Get settlement results

Developing

GET

/v1/match-predictions/{matchPredictionId}/results

Retrieve settlement or void results for a match. Returns 202 while an operation is still in progress; 200 once terminal.

Auth: Bearer API key with matchPredictions permission.
Response mode:

202 MATCH_PREDICTION_SETTLEMENT_IN_PROGRESS / _VOID_IN_PROGRESS: body includes retryAfterSeconds and Retry-After header.

200 MATCH_PREDICTION_SETTLEMENT_COMPLETED / _VOID_COMPLETED: full 12-field summary + paginated participants.

409 MATCH_PREDICTION_SETTLEMENT_FAILED / MATCH_PREDICTION_VOID_FAILED: settle/void ended in a failed terminal state — retry via a new operation.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200Terminal

application/json

Settled or voided — full summary + paginated participants.

Bodyapplication/json

🟢202In progress

🟠401Unauthorized

🟠403Forbidden

🟠404Not found

🟠409Failed terminal

🟠429Rate limited

🔴503Frozen

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.returning.ai/v1/match-predictions/mp_01abc/results?page=1&limit=20&outcome=correct_result&payoutStatus=paid&sort=payout.coins&order=desc' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Settlement completed

{
  "meta": {
    "status": "success",
    "statusCode": 200,
    "code": "MATCH_PREDICTION_SETTLEMENT_COMPLETED",
    "requestId": "req_01abc",
    "timestamp": "2026-08-07T12:00:00.000Z",
    "page": 1,
    "limit": 20,
    "total": 42
  },
  "message": "Settlement results retrieved.",
  "data": {
    "status": "settled",
    "summary": {
      "fullTimeScore": { "teamA": 2, "teamB": 1 },
      "predictionsTotal": 42,
      "winnerCount": 18,
      "correctResultCount": 15,
      "exactScoreCount": 3,
      "missedCount": 24,
      "coinsPaid": 2100,
      "xpPaid": 1050,
      "entryCoinsReturned": 0,
      "payoutFailureCount": 0,
      "settledAt": "2026-08-07T12:00:00.000Z",
      "operationId": "mps_01xyz"
    },
    "participants": []
  }
}

Modified at 2026-09-25 08:29:20

Settle match prediction

Void match prediction