Skip to main content

Create Reclaim Request

POST/processors/{id}/reclaimOpen in the API playground →

Submit a request to reclaim (withdraw) funds from processor account. Admin will review.

Endpoint​

POST /api/v1/processors/:id/reclaim

Authentication​

Authorizationstringheaderrequired

Bearer token (Processor JWT)

Path Parameters​

idstringpathrequired

Processor UUID

Request Body​

amountstringbodyrequired

Amount to reclaim (e.g., "1000.00")

reasonstringbody

Reason for reclaim request

Response​

{
  "success": true,
  "request_id": "reclaim_abc123",
  "message": "Reclaim request submitted successfully"
}

Workflow​

  1. Processor submits reclaim request
  2. Request status is pending
  3. Admin reviews and approves/rejects
  4. On approval, funds are transferred

Errors​

CodeDescription
400Invalid amount or exceeds balance
404Processor not found
401Unauthorized