Skip to main content

Create Withdrawal Request

curl -X POST https://api.kinconecta.com/api/withdrawal_requests \
  -H "Content-Type: application/json" \
  -d '{
    "guideId": 789,
    "requestedAmount": 500.00,
    "status": "PENDING",
    "bankReference": "BANK123456",
    "notes": "Withdrawal to primary bank account",
    "requestedAt": "2026-04-15T09:00:00"
  }'
Create a new withdrawal request for a guide.

Request Body

guideId
integer
required
ID of the guide requesting withdrawal
requestedAmount
decimal
required
Amount to withdraw
status
enum
required
Status of the withdrawal request
  • PENDING: Request is pending review
  • APPROVED: Request has been approved
  • REJECTED: Request was rejected
  • PAID: Withdrawal has been paid
  • CANCELLED: Request was cancelled
bankReference
string
Bank account reference or identifier
notes
string
Additional notes about the withdrawal
requestedAt
datetime
required
Timestamp when the withdrawal was requested
processedAt
datetime
Timestamp when the withdrawal was processed
processedByUserId
integer
ID of the admin user who processed the withdrawal

Response

withdrawalId
integer
Unique identifier for the withdrawal request
guideId
integer
ID of the guide
requestedAmount
decimal
Requested withdrawal amount
status
enum
Withdrawal status
bankReference
string
Bank account reference
notes
string
Notes about the withdrawal
requestedAt
datetime
When the withdrawal was requested
processedAt
datetime
When the withdrawal was processed
processedByUserId
integer
ID of the admin who processed it

Get All Withdrawal Requests

curl https://api.kinconecta.com/api/withdrawal_requests
Retrieve all withdrawal requests in the system.

Response

Returns an array of withdrawal request objects.

Get Withdrawal Request by ID

curl https://api.kinconecta.com/api/withdrawal_requests/123
Retrieve a specific withdrawal request by its ID.

Path Parameters

id
integer
required
The withdrawal request ID

Response

Returns a single withdrawal request object.

Update Withdrawal Request

curl -X PUT https://api.kinconecta.com/api/withdrawal_requests/123 \
  -H "Content-Type: application/json" \
  -d '{
    "status": "APPROVED",
    "processedAt": "2026-04-15T10:30:00",
    "processedByUserId": 1,
    "notes": "Approved and scheduled for payment"
  }'
Update an existing withdrawal request (typically used by admins to process requests).

Path Parameters

id
integer
required
The withdrawal request ID

Request Body

All fields from the create request are optional. Only provide the fields you want to update.
status
enum
Updated status (PENDING, APPROVED, REJECTED, PAID, CANCELLED)
processedAt
datetime
When the request was processed
processedByUserId
integer
ID of the admin processing the request
notes
string
Updated notes

Response

Returns the updated withdrawal request object.

Delete Withdrawal Request

curl -X DELETE https://api.kinconecta.com/api/withdrawal_requests/123
Delete a withdrawal request by its ID.

Path Parameters

id
integer
required
The withdrawal request ID

Response

Returns 204 No Content on successful deletion.

Build docs developers (and LLMs) love