Skip to main content
POST
/
processors
/
{id}
/
reclaim
Create reclaim request
curl --request POST \
  --url https://olive-gateway-a6ba.onrender.com/api/v1/processors/{id}/reclaim \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "1000.00"
}
'
{}

​
Create Reclaim Request

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

​
Endpoint

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

​
Authentication

​
Authorization
string
required
Bearer token (Processor JWT)

​
Path Parameters

​
id
string
required
Processor UUID

​
Request Body

​
amount
string
required
Amount to reclaim (e.g., “1000.00”)
​
reason
string
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

Authorizations

​
Authorization
string
header
required

JWT token from admin login for administrative operations. Format: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Path Parameters

​
id
string
required

Processor ID

Body

application/json

Reclaim request details

​
amount
string
required
Example:

"1000.00"

​
reason
string
Example:

"Cash out request for weekly settlements"

Response

Reclaim request created successfully

The response is of type object.