Customers can use this endpoint to settle their loan completely by paying the remaining outstanding balance in one transaction.
[https://finlend.fincode.software/api/v1/services/user/payoff-loan](https://finlend.fincode.software/api/v1/services/user/payoff-loan)
The JWT Access Token obtained from the /login or /refresh-token endpoint.
Unique idempotency key for the request to prevent duplicate processing.
The date and time at which the request was initiated (ISO 8601 format).
x-fapi-customer-ip-address
The IP address of the customer making the request.
Unique identifier for the interaction/session.
Content-Type
string
default:"application/json"
required
Must be application/json.
Request Body
The unique identifier (UUID) of the loan application to pay off.
Method of payment. Options: WALLET, BANK_TRANSFER, CARD, etc.
Transaction PIN for authorization (if required).
Optional payoff amount. If not provided, the system will calculate the full outstanding balance.
Response
Returns confirmation of the loan payoff with final settlement details.
Overall status of the API request.
Payoff confirmation details.
Unique identifier for the payoff transaction.
Identifier of the loan application.
The amount that was paid to settle the loan.
Remaining balance after payoff (should be 0).
Updated status of the loan (should be PAID_OFF or COMPLETED).
Reference number for the payoff transaction.
Date and time when the loan was paid off.
Code Examples
curl --location --request POST 'https://finlend.fincode.software/api/v1/services/user/payoff-loan' \
--header 'X-Auth-Token: YOUR_JWT_ACCESS_TOKEN' \
--header 'x-idempotency-key: unique-key-12345' \
--header 'x-fapi-auth-date: 2024-01-15T10:30:00Z' \
--header 'x-fapi-customer-ip-address: 192.168.1.1' \
--header 'x-fapi-interaction-id: interaction-12345' \
--header 'Content-Type: application/json' \
--data '{
"loanApplicationId": "123e4567-e89b-12d3-a456-426614174000",
"paymentMethod": "WALLET",
"transactionPin": "1234"
}'