Skip to main content
POST
https://finlend.fincode.software
/
api
/
v1
/
services
/
user
/
payoff-loan
[https://finlend.fincode.software/api/v1/services/user/payoff-loan](https://finlend.fincode.software/api/v1/services/user/payoff-loan)
{
  "status": "<string>",
  "data": {
    "repaymentId": "<string>",
    "loanApplicationId": "<string>",
    "payoffAmount": 123,
    "remainingBalance": 123,
    "loanStatus": "<string>",
    "transactionReference": "<string>",
    "payoffDate": "<string>"
  }
}
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)

Request Headers

X-Auth-Token
string
required
The JWT Access Token obtained from the /login or /refresh-token endpoint.
x-idempotency-key
string
required
Unique idempotency key for the request to prevent duplicate processing.
x-fapi-auth-date
string
required
The date and time at which the request was initiated (ISO 8601 format).
x-fapi-customer-ip-address
string
required
The IP address of the customer making the request.
x-fapi-interaction-id
string
required
Unique identifier for the interaction/session.
Content-Type
string
default:"application/json"
required
Must be application/json.

Request Body

loanApplicationId
string
required
The unique identifier (UUID) of the loan application to pay off.
paymentMethod
string
required
Method of payment. Options: WALLET, BANK_TRANSFER, CARD, etc.
transactionPin
string
Transaction PIN for authorization (if required).
payoffAmount
number
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.
status
string
default:"SUCCESS"
Overall status of the API request.
data
object
Payoff confirmation details.

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"
}'