Skip to main content

Finalise Order Response

This endpoint is initiated by the DisbursementPartner in response to GetDisbursementProductDetailsRequest providing the details of a specific product.

Request Body
metadata object REQUIRED

Metadata specific to each API request.

version string REQUIRED
originatorOrgId string

The organisation id on the Participant Registry.

originatorParticipantId string

The participant id on the Participant Registry. This will be different for every role under the same organisation.

timestamp string REQUIRED
traceId string REQUIRED
requestId string REQUIRED

UUID used to tie request and response and for idempotency

productData object REQUIRED

Product Metadata specific to each API request.

productId string REQUIRED

The product id on the Product Registry.

productNetworkId string

The product network id on the Product Registry.

response object

Status of response. Whether success or has encountered error

status string REQUIRED

Possible values: [SUCCESS, ERROR]

responseDetail string
order object
orderId string

The unique identifier for the order

status string

Possible values: [SUCESS, FAILED]

The status of the order

statusMessage string

The message against the order status

items object[]
id string REQUIRED
name string REQUIRED
description string REQUIRED
price string REQUIRED
thumbnail string
images string[]
tags string[]
currency string REQUIRED
quantity object
value string
unit string
shippingDetails object
type string REQUIRED

Possible values: [PRIMARY, OTHER]

desctiption string
phone string REQUIRED
email string
address object
hba string REQUIRED
srl string REQUIRED
landmark string
als string
vtc string
pinCode string REQUIRED
po string
district string
state string REQUIRED
country string REQUIRED
url string
latitude string
longitude string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

totalAmount number

The total amount of the order that will be come the loan application amount

performaInvoice object
id string
source string REQUIRED

Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER]

sourceIdentifier string REQUIRED
format string REQUIRED

Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL]

reference string REQUIRED
type string REQUIRED

Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER]

isDataInline boolean REQUIRED
data string REQUIRED
payeeAccountDetails object
id string
description string
status string

Possible values: [ACTIVE, INACTIVE]

accountDataType string REQUIRED

Possible values: [ACCOUNT, VPA]

data object REQUIRED
accountType string

Possible values: [CURRENT, SAVING, OVERDRAFT, ESCROW, WALLET]

accountIFSC string
accountNumber string
vpa string
maskedAccountNumber string
accountHolderName string
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string