7. Invoke/Revoke Funds

This API used for Revoking and Invoking activities from the lender side for the Loans according to their use case. Depending on the conditions such as errors, loan repayment, or breaches, the assets can be invoked or revoked:

Revoke Assets: If there is an error, the loan is repaid, or there are issues in disbursement or prepayment, the assets can be revoked.


Invoke Assets: If there is a Days Past Due (DPD) or a breach, the pledged assets can be invoked to secure the lender’s interest.


In this API,
Input: Invoke or Revoke, for a particular user_id and order_id which is associated to the loans they have given in the first place.
Output: Confirmation of action taken (revoke/invoke).


Input Type

InputTypeDescription
finsire_idstringA valid id generated during user creation
order_idstringA valid order id
invoke_or_revokestringPass 'R' for revoke and 'I' for invoke

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
param is missing or the value is empty: order_idorder_id is a required field
param is missing or the value is empty: invoke_or_revokeinvoke_or_revoke is a required field

You can try out this API here.