This endpoint allows users to recover funds that were sent to an LP wallet but were not properly processed. This is a safety mechanism to prevent permanent loss of funds.
To be eligible for clawback, a transfer must:
Requires a valid JWT bearer token. The token’s public key must match
the sender_public_key in the request.
sender_public_key - Public key of the original senderspark_transfer_id - Transfer ID to claw backlp_identity_public_key - LP wallet that received the fundsnonce - Unique value for replay protectionsignature - Request signature200 OK with tracking information if clawback is accepted400 Bad Request if validation fails or transfer is ineligible401 Unauthorized if authentication fails409 Conflict if nonce already used500 Internal Server Error if clawback processing failsBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Clawback request details including transfer ID and authentication
Request body for clawing back stuck funds.
Clawbacks allow users to recover funds that were sent to an LP wallet but were not processed correctly. This is a safety mechanism to prevent permanent loss of funds due to system failures or edge cases.
Public key of the original sender requesting the clawback. Must match the authenticated user's public key.
"02abcdef0123456789abcdef0123456789abcdef0123456789abcdef01234567"
Spark transfer ID or transaction ID of the original payment. This is the transfer that needs to be clawed back.
"550e8400-e29b-41d4-a716-446655440000"
Identity public key of the LP wallet where the funds were sent. This must be a valid LP wallet that exists in the system.
"03aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899"
Unique nonce for replay protection. Each clawback request must use a unique nonce.
"clawback-nonce-123456"
Hex-encoded secp256k1 signature of the request.
Must be signed by the private key corresponding to sender_public_key.
"3045022100a7e5d4f8b2c9a1e6f0d5b8c4a9e7f2d1c8b5a4e9f0d6c5b3a2e1d0c9b8a7f02201f2e3d4c5b6a7980e9f0a1b2c3d4e5f67889a0b1c2d3e4f5a6b7c8d9e0f1a2b3"
Clawback accepted for processing
Response for a successful clawback request
Unique request ID for tracking this clawback
"01HJZKFABCDEFGHJKLMNPQRSTVW"
Whether the clawback was accepted for processing
true
Internal request ID from the settlement service
"settlement-internal-123"
Spark status tracking ID for monitoring the refund
"spark-track-456"
Settlement service request ID for correlation
"018D5E56-9D80-7890-A1B2-C3D4E5F6G7H8"
Optional error message if the clawback was rejected
"Transfer is too old for clawback"