Plan Withdrawals

Refund

post

Submits a refund request using the provided installmentRequestId/checkout_id and amount. If the request is eligible, it is processed immediately; otherwise it remains pending for review.

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

installmentRequestIdstring · uuidRequired

amountnumber · doubleRequired

reasonstringRequired

Responses

200

Refund request accepted successfully. Response contains the requestId and status (DONE or PENDING).

*/*

withdrawalRequestIdstring · uuidOptional

statusstring · enumOptionalPossible values:

400

Validation error (missing/invalid fields, invalid amount, or amount exceeds paid amount).

*/*

post

/v1/refund

HTTPcURLJavaScriptPython

POST /v1/refund HTTP/1.1
Host: api.sandbox.jeel.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "installmentRequestId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 1,
  "reason": "text"
}

{
  "withdrawalRequestId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "DONE"
}

Get refund status

get

Returns the current status of the refund request. The {id} can be either an InstallmentRequest ID or an IntegrationCheckout ID.

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Responses

200

Refund status returned successfully

*/*

statusstring · enumOptionalPossible values:

rejectionReasonstringOptional

400

Invalid request

*/*

404

Refund request not found

*/*

get

/v1/refund/{id}

HTTPcURLJavaScriptPython

GET /v1/refund/{id} HTTP/1.1
Host: api.sandbox.jeel.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "DONE",
  "rejectionReason": "text"
}