API DocsAPI Docs / Payments / Update Withdrawal Status

PUT /api/v1/payments/withdrawal/{payment}

Records an operator's decision on a withdrawal request: whether the payout has been transferred, and whether the request is rejected.

The two are independent. is_done records only that the money reached the user's bank account — it has no effect on the user's balance, because a withdrawal holds its amount from the moment it is created (see How the balance is computed). The hold is controlled by rejected_at, which this endpoint sets and clears via is_rejected. Rejecting a withdrawal returns the held amount to the user's spendable balance while keeping the row and its history.

Permissions

Request Body Parameters

Request Example

{
  "is_done": true,
  "description": "Updated note"
}

Reject a request

Releases the hold and returns the amount to the user's spendable balance.

{
  "is_done": false,
  "is_rejected": true
}

Undo a rejection

Re-applies the hold. This can push a balance negative if the user spent the released funds in the meantime — it is an operator reversing their own decision, and is permitted deliberately so a rejected row is never stuck.

{
  "is_done": false,
  "is_rejected": false
}

Response

200 OK

Returns the updated withdrawal payment resource.

{
  "data": {
    "id": 123,
    "user_id": 10,
    "type": "withdrawal",
    "amount": 150.00,
    "description": null,
    "payable_type": null,
    "payable_id": null,
    "meta": null,
    "is_done": true,
    "rejected_at": null,
    "created_at": "2026-01-01T00:00:00.000000Z"
  }
}

Error Responses

Completing a rejected withdrawal

A rejected withdrawal was never paid out, so it cannot be marked completed. Both {"is_done": true, "is_rejected": true} and {"is_done": true} against a row whose rejected_at is already set return 422 naming is_done, and leave the row untouched:

{
  "errors": {
    "is_done": ["A rejected withdrawal cannot be marked as completed."]
  }
}

To pay out a request that was previously rejected, un-reject and complete it in the same call: {"is_done": true, "is_rejected": false}.