Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Trigger Disbursement Status Response

This API is invoked by the lender to inform the LSP about the status of the previously initiated trigger disbursement status request.

Response Parameters for the Trigger Disbursement Status Response API: w (click to view)
ParameterTypeDescription
ack:wwwwwwww
  {error, traceId, timestamp}
ObjectJSON object for acknowlegement
    Parameters for the ack object:
ParameterTypeDescription
errorStringErrors in the current request received. If no errors are found, error = 0.
traceIdStringIdentification for tracing
timestampTime-
stamp
YYYY-MM-DDThh:mm:ssZ+/-hh:mm
(eg 1997-07-16T19:20:30+05:30)
Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30)
The request for this API contains the parameters:  requestId  (UUID for the previous API request), and an object for  payment, which provides the updated payment details, including a status update and a payment ID.       (click to open tables)
ParameterTypeDescription
metadata:wwtwwwww
   {param1, param2,...}
*Object
Strings
Metadata specific to each API response.
  Parameters for the metadata object:     click to open)
FieldTypeDescription
versionStringOCEN Version
timestampTime-
Stamp
YYYY-MM-DDThh:mm:ssZ+/-hh:mm
(eg 1997-07-16T19:20:30+05:30)
Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30)
traceIdStringIdentification for tracing
orgIdStringOrigin ID
response: {error}ObjectObject contains one parameter, "error:", which indicates if any errors were found in the current request received. If none are found, error = 0.
requestIdwwwwwtwww*StringUnique reference ID for the Trigger Disbursement Status Request (UUID used to tie request and response and for idempotency).
payment:  {...,{...}}*ObjectUpdated payment details. The "id" parameter (Payment ID updated by lender) is used to check the status of the specific payment transaction.
  Parameters for the payment object:
      (click to open)
id*StringUnique reference ID (UUID) of the payment request (generated by LSP)
descriptionStringA short description for the payment
dateDate-
time
Date and time (ISO representation) when the payment transaction is done
totalAmountStringTotal amount paid by the lender for the current payment - 2 digit precision
installmentNumberStringThe installment number for the current payment
statusStringStatus of the current payment transaction
useSavedPaymentOptionBooleantrue if using the Saved Payment Option
paymentMethodTypeStringPayment method used for the transaction. To be populated when payment is done
txnRefNoStringReceipt number of the transactions
extensibleDataJSONFor any new data that needs to be added
* = Required
Note: This request should also include the  loanId parameter, which is a reference for the loan whose disbursement status was requested.
Language
Click Try It! to start a request and see the response here!