This API is used to view detailed information about a specific overdraft account associated with a user. It can be useful for account managers, customer service representatives, or the users themselves to track the status and specifics of their overdraft account.

Input

To fetch the information of a specific overdraft account, you need to provide the following details:

Customer ID: The unique identifier of the user whose overdraft account details you want to fetch (e.g., "32ce79860a45cd4857be9df097f46b4f8d").

Order ID: The unique identifier of the overdraft account you want to fetch details for (e.g., "e90dfdf6-b467-4fa6-a52c-784b1a65f2be").

Authorization Key: A secure key to authenticate the request. This key must be included in the headers of your request.

Output

The response from this API provides detailed information about the specified overdraft account.

Loan Amount: The total amount of the loan.

Disbursed Amount: The amount of money that has already been given to the user.

Remaining Amount: The amount of money that is still available to be withdrawn from the loan.

Loan Start Date: The date when the loan was initiated.

Amount Due: The amount of money that the user needs to repay.

Interest Rate: The rate of interest applied to the loan.

Input Type

InputTypeDescription
finsire_idstringA valid id generated during user creation
order_idstringA unique id for each order which you can fetch from the last API

Common error scenarios

The following are the common error scenarios in sending an API request:

ErrorDescription
param is missing or the value is empty: finsire_idfinsire_id is a required field

📘

Try out the API here