Skip to main content
POST
/
v1
/
check_clawback_eligibility
Check Clawback Eligibility
curl --request POST \
  --url https://api.amm.flashnet.xyz/v1/check_clawback_eligibility \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sparkTransferId": "550e8400-e29b-41d4-a716-446655440000"
}'
{
"accepted": false,
"error": "Transfer has invalid status for clawback"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Transfer to evaluate for clawback eligibility

Request body for clawing back stuck funds.

Clawbacks allow users to recover funds that were sent but were not processed correctly. This is a safety mechanism to prevent permanent loss of funds due to system failures or edge cases.

sparkTransferId
string
required

Spark transfer ID or transaction ID of the original payment. This is the transfer that needs to be clawed back.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Eligibility result

Response for a CheckClawbackEligibility request

accepted
boolean
required

Whether the transfer is eligible for clawback

Example:

true

error
string | null

Error message explaining why the transfer is not eligible (only present when accepted is false)

Example:

"Transfer is too old for clawback"

I