Disburse Loan to Linked Account

post

https://api.cloud.mbanq.com/v1/loans/{loanId}?command=disburseToSavings

Purpose - Use this API to disburse a loan to a linked Account. The linked account is configured during the creation of loan. You need to specify the LoanId.

Behaviour - A successful response from this API indicates that the specified loan was disbursed to the linked account. Response includes all the changes to the loan status along with actual disbursement date.

Path Params

loanId

integer

required

The associated loan Id.

Query Params

command

string

In this case the command is always 'disburseToSavings'.

Body Params

locale

string

required

Defaults to en

The locale of the client. 'en' will be passed as default. Pattern: 'XX' Example: 'en'

dateFormat

string

required

If the field 'actualDisbursementDate' is passed, then this parameter is mandatory. It specifies the dataformat, that's being used. Pattern: 'XXX' Example: 'dd MMMM yyyy'

transactionAmount

integer

required

The associated transaction amount. Example: 1000

actualDisbursementDate

string

required

The expected actual disbursement date.The date format should be as per the format mentioned in the dateFormat parameter. Pattern: 'XXX' Example: '28 March 2024'

note

string

required

Any additional details. Example : note

Headers

tenantId

string

required

Defaults to z01j3e71zd6zkq908vyf5861a8

The ID of your banking instance visible in the MBANQ Console.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The loan disbursement is successful.

400The request fails if linked account for payment is not provided.