v1

latestOpenAPI 3.0.32026-07-24190128.9 KB

Request loan closure

The API will initiate the request to close an existing user loan. It will return appropriate errors if, for some reason, loan closure request cannot be initiated

post/backend/{gatewayname}/v1/loan/{unityuserid}/closure/{lid}

Path parameters

gatewaynamestring required
unityuseridstring required
lidstring required

Headers

x-gateway-secretstring required

Required | apiSecret shared for authentication

x-gateway-authtokenstring required

Required | JWT created with payload {"iss":"<your_gateway_name>"}, and signed with the shared secret

Request body

lenderstring required

Response

200

successboolean
messagestring
dataobject

Example response

{
  "success": true,
  "message": "Loan closure request taken successfully"
}