CRISPDocs
Dashboard
CRISP partnersEndpoint reference

Redeem positions

POST /v1/accounts/{externalUserId}/positions/redeem

Use this operation for redeem positions. Follow the positions and redemption guide for the complete workflow.

Positions and redemption guide · All endpoints · SDK: redeemPositions

Authentication

Server-to-server HMAC. Your key selects the partner; your backend must authorize the end user.

CRISP enables access to the features agreed for your integration. Contact CRISP if an enabled feature returns an access error.

Idempotency-Key: Required — persist one key per intent. Signing and authentication →

Request fields

Required means the field must be present. Nullable means an explicit JSON null is allowed; it does not mean optional.

Path parameters

FieldType / presenceDescription and constraints
externalUserIdstring
Required
Non-null

Your stable user ID within the authenticated partner. Derive it from your authorized server session.

Validation pattern^[A-Za-z0-9._:@-]{1,200}$

Query parameters

None.

Header parameters

FieldType / presenceDescription and constraints
Idempotency-Keystring
Required
Non-null
Validation pattern^[A-Za-z0-9._:-]{8,200}$

JSON body

FieldType / presenceDescription and constraints
positionsarray<object>
Required
Non-null
minItems: 1
maxItems: 20
positions: expand item fields
FieldType / presenceDescription and constraints
conditionIdstring
Required
Non-null
—
sizenumber
Required
Non-null
—
outcomeIndexinteger
Required
Non-null
Allowed: 0, 1
negRiskboolean
Required
Non-null
—

Additional fields are not allowed in this object.

Additional fields are not allowed in this object.

Request example

Illustrative identifiers only: replace them with resources from your integration. Keep credentials on your backend. HTTP placeholders must be signed; the SDK signs automatically. Financial intent keys must be persisted and unique per new action.

POST /v1/accounts/user-123/positions/redeem
Host: partner-api.crisp.trade
X-Crisp-Partner-Key: <server-key-id>
X-Crisp-Timestamp: <fresh-ISO-8601-UTC-timestamp>
X-Crisp-Nonce: <fresh-unique-nonce>
X-Crisp-Signature: <computed-base64-HMAC>
Idempotency-Key: persisted-intent-0001
Content-Type: application/json

{
  "positions": [
    {
      "conditionId": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "size": 1,
      "outcomeIndex": 0,
      "negRisk": false
    }
  ]
}

Response fields

HTTP responses use the envelope below. SDK calls expose its payload as result.data, with HTTP status and request metadata on the SDK wrapper.

202 · Accepted; inspect lifecycle state. This is not proof of a fill or payout.

Accepted for processing, not proof of a fill, completed provisioning or settled payout. Inspect resource state and follow the recovery guide.

Data payload

FieldType / presenceDescription and constraints
crispAccountIdstring
Required
Non-null

CRISP's account identifier; distinct from your external user ID.

Format: uuid
externalUserIdstring
Required
Non-null

Your stable user ID within the authenticated partner. Derive it from your authorized server session.

Validation pattern^[A-Za-z0-9._:@-]{1,200}$
commandobject
Required
Non-null
Expand the structure below.
command: expand fields
FieldType / presenceDescription and constraints
idstring
Required
Non-null
Format: uuid
statestring
Required
Non-null
Allowed: "queued", "running", "retryable", "succeeded", "failed", "ambiguous"
failureCodestring | null
Required
Nullable
Expand the structure below.
failureCode: expand fields

string

Additional fields are not allowed in this object.

redemptionobject
Required
Non-null
Expand the structure below.
redemption: expand fields
FieldType / presenceDescription and constraints
transactionHashstring | null
Required
Nullable
Expand the structure below.
transactionHash: expand fields

string

countinteger
Required
Non-null
minimum: 0
totalinteger
Required
Non-null
minimum: 0
conditionIdsarray<string>
Required
Non-null
Expand the structure below.
conditionIds: expand item fields

string

fallbackboolean
Required
Non-null
—

Additional fields are not allowed in this object.

Additional fields are not allowed in this object.

Full HTTP envelope
FieldType / presenceDescription and constraints
dataobject
Required
Non-null
Expand the structure below.
data: expand fields
FieldType / presenceDescription and constraints
crispAccountIdstring
Required
Non-null

CRISP's account identifier; distinct from your external user ID.

Format: uuid
externalUserIdstring
Required
Non-null

Your stable user ID within the authenticated partner. Derive it from your authorized server session.

Validation pattern^[A-Za-z0-9._:@-]{1,200}$
commandobject
Required
Non-null
Expand the structure below.
command: expand fields
FieldType / presenceDescription and constraints
idstring
Required
Non-null
Format: uuid
statestring
Required
Non-null
Allowed: "queued", "running", "retryable", "succeeded", "failed", "ambiguous"
failureCodestring | null
Required
Nullable
Expand the structure below.
failureCode: expand fields

string

Additional fields are not allowed in this object.

redemptionobject
Required
Non-null
Expand the structure below.
redemption: expand fields
FieldType / presenceDescription and constraints
transactionHashstring | null
Required
Nullable
Expand the structure below.
transactionHash: expand fields

string

countinteger
Required
Non-null
minimum: 0
totalinteger
Required
Non-null
minimum: 0
conditionIdsarray<string>
Required
Non-null
Expand the structure below.
conditionIds: expand item fields

string

fallbackboolean
Required
Non-null
—

Additional fields are not allowed in this object.

Additional fields are not allowed in this object.

requestIdstring
Required
Non-null

Request correlation ID for debugging and support.

Additional fields are not allowed in this object.

Response example

Schema illustration, not live account data. Null means unavailable or not applicable, never an invented zero. Empty arrays do not imply the endpoint always returns no results.

202 response JSON
{
  "data": {
    "crispAccountId": "11111111-1111-4111-8111-111111111111",
    "externalUserId": "user-123",
    "command": {
      "id": "11111111-1111-4111-8111-111111111111",
      "state": "queued",
      "failureCode": null
    },
    "redemption": {
      "transactionHash": null,
      "count": 0,
      "total": 0,
      "conditionIds": [],
      "fallback": false
    }
  },
  "requestId": "example-request-id"
}

Errors and recovery

StatusMeaning
400Inspect error.code and retain the original financial intent.
401Inspect error.code and retain the original financial intent.
403Inspect error.code and retain the original financial intent.
404Not visible for this account. A recovery lookup miss is not proof that an in-flight submission failed.
409Inspect error.code and retain the original financial intent.
429Inspect error.code and retain the original financial intent.
500Inspect error.code and retain the original financial intent.
502Inspect error.code and retain the original financial intent.
503Inspect error.code and retain the original financial intent.

Inspect the error code and outcomeUnknown, not just the HTTP status. Preserve the original intent after financial uncertainty. Read-only retries should honor Retry-After. Recovery workflow →

Error response fields
FieldType / presenceDescription and constraints
errorobject
Required
Non-null
Expand the structure below.
error: expand fields
FieldType / presenceDescription and constraints
codestring
Required
Non-null
—
messagestring
Required
Non-null
—
requestIdstring
Required
Non-null

Request correlation ID for debugging and support.

Additional fields are not allowed in this object.

Additional fields are not allowed in this object.

Raw contract

OpenAPI download · Advanced schema and legacy anchor

CRISP Partner Documentation

List positions

GET /v1/accounts/{externalUserId}/positions

List trades

GET /v1/accounts/{externalUserId}/trades

On this page

AuthenticationRequest fieldsRequest exampleResponse fieldsResponse exampleErrors and recoveryRaw contract