Skip to main content

Claim Rent

Claim rent for a specific user and token.

Asynchronous operation

A user transaction row is created with type = 5 (ClaimRent) and status = 1 (Started), and a ClaimRent event is published to the wallet pipeline. HTTP 200 means queued — the rent currency only lands in the user's wallet once the on-chain transfer reaches Done (3). Poll Get User Transactions (filter by types=5) until status is 3 or 4. The transaction's data.token_id, data.rent_id, and price fields mirror the rent record at claim time.

Endpoint​

POST /v2/users/rents/{rent_id}/users/{user_id}/tokens/{token_id}/claim

Headers​

HeaderValue
Content-Typeapplication/json
AuthorizationBearer {token}

Path Parameters​

ParameterTypeRequiredDescription
rent_idintegerYesThe unique identifier of the rent
user_idstringYesThe unique identifier of the user
token_idstringYesThe unique identifier of the token

Response​

Returns a successful response with no content when the rent is successfully claimed.

Success Response (200 OK)​

No content - successful claim.

Example​

Request​

curl -X POST "{{baseUrl}}/v2/users/rents/1/users/680c02896d91ca0145cfeb81/tokens/68aeb272d9336c619ce249f6/claim" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer \{\{token\}\}" \

Response​

200 OK
(No content)

Error Responses​

400 Bad Request​

{
    "error": "Invalid request parameters"
}

401 Unauthorized​

{
    "error": "Authentication required"
}

403 Forbidden​

{
    "error": "Access denied"
}

404 Not Found​

{
    "error": "Rent, user or token not found"
}

500 Internal Server Error​

{
    "error": "Internal server error"
}