Enkash APIs
Request Financing
POST/api/v0/finance/req-financingRequest
Body Params application/json
initiatorEntity
string
required
b2bIds
object
required
buyerB2BId
string
required
supplierB2BId
string
required
device
object
required
tag
object
required
financeRequest
object
required
initiatorB2BId
string
required
financingRequestId
string
required
financeId
array [object {2}]
required
b2bPAN
object
required
costOfFundBearer
string
required
financingRequestAmount
integer
required
financingType
string
required
invoices
array [object {27}]
required
Example
{
"initiatorEntity": "string",
"b2bIds": {
"buyerB2BId": "string",
"supplierB2BId": "string"
},
"device": {
"tag": {
"name": "GEOCODE",
"value": "string"
}
},
"financeRequest": {
"initiatorB2BId": "string",
"financingRequestId": "string",
"financeId": [
{
"faId": "string",
"financierId": [
"string"
]
}
],
"b2bPAN": {
"buyerPAN": "string",
"supplierPAN": "string"
},
"costOfFundBearer": "string",
"financingRequestAmount": 0,
"financingType": "string",
"invoices": [
{
"objectId": "string",
"supplierInvoiceNumber": "string",
"objectVersion": {
"currentVersion": 0,
"newVersion": 0
},
"ts": "string",
"statusTransition": {
"currentStatus": "CREATED",
"newStatus": "CREATED"
},
"transactionDetails": {
"taxScheme": "string",
"supplyType": "string",
"reverseChargeTax": "string",
"igstChargable": "string",
"ecommerceGstin": "string"
},
"supplierDetails": {
"b2bId": "string",
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"buyerDetails": {
"b2bId": "string",
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"placeOfSupply": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"dispatchDetails": {
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"shippingDetails": {
"gstin": "string",
"lglNm": "string",
"trdNm": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"itemLists": [
{
"serialno": "string",
"productDescription": "string",
"isService": "string",
"hsnCode": "string",
"barCode": "string",
"quantity": 0,
"freeQuantity": 0,
"unit": "string",
"unitPrice": 0,
"totalAmt": 0,
"assessmentAmount": 0,
"gstRate": 0,
"totalItemValue": 0,
"orderLineReference": "string",
"originCountry": "string",
"productSerialNumber": "string",
"itemValueDetails": [
{
"type": "string",
"value": 0
}
],
"rates": [
{
"type": "string",
"value": 0
}
],
"batchDetails": {
"batchNumber": "string",
"expiryDate": "string",
"batchWarrantyDate": "string"
},
"attributeDetails": [
{
"name": "string",
"value": "string"
}
],
"otherTaxes": [
{
"name": "string",
"rate": 0,
"amount": 0
}
]
}
],
"valueDetails": {
"assessmentValue": 0,
"totalInvoiceValue": 0,
"otherValues": [
{
"type": "string",
"value": 0
}
]
},
"supplierBankAccountDetails": {
"maskedAccountNumber": "string",
"ifsc": "string",
"beneficiaryName": "string",
"businessVPA": "string"
},
"advancePaymentDetails": {
"payeeName": "string",
"mode": "string",
"paymentTerms": "string",
"paymentInstruction": "string",
"creditTransfer": "string",
"directDebit": "string",
"creditDays": 0,
"paidAmount": 0,
"pendingDueAmount": 0
},
"invoiceReferenceDetails": {
"invoiceRemarks": "string",
"invoiceStartDate": "string",
"invoiceEndDate": "string"
},
"precedingInvoiceDetails": [
{
"invoiceNumber": "string",
"date": "string",
"otherReferenceNo": "string"
}
],
"poDetails": [
{
"poObjId": "string",
"buyerPoId": "string",
"poDate": "string"
}
],
"contractReferenceDetails": [
{
"receiptAdviceNo": "string",
"receiptAdviceDate": "string",
"batchReferenceNo": "string",
"contractReferenceNo": "string",
"extraReferenceNo": "string",
"projectReferenceNo": "string"
}
],
"additionalDocumentDetails": [
{
"url": "string",
"document": "string",
"info": "string"
}
],
"exportDetails": {
"shipBillNo": "string",
"shipBillDate": "string",
"port": "string",
"refundClaim": "string",
"foreignCurrency": "string",
"countryCode": "string",
"exportDuty": 0
},
"ewayBillDetail": {
"transporterId": "string",
"transporterName": "string",
"transportMode": "string",
"distance": 0,
"transportDocumentNo": "string",
"transportDocumentDate": "string",
"vehicleNo": "string",
"vehicleType": "string"
},
"recurringPayments": {
"originalInvoiceId": "string",
"frequency": "string",
"startDate": "string",
"endDate": "string",
"mandateDetails": "string",
"mandateExecutionDate": "string",
"mandateAmount": 0
},
"paymentMilestones": [
{
"milestoneDate": "string",
"dueAmount": 0
}
],
"shippingTermsDetails": {
"terms": "string",
"bearingParty": "string",
"charges": 0
},
"invoiceFinancingDetails": {
"dueAmount": 0,
"financingRequestAmount": 0
},
"einvoiceResponse": "string",
"eInvoiceInfo": {
"schemaVersion": "string",
"irnNumber": "string",
"irnTs": "string"
}
}
]
}
}Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
payload
string
required
response_code
integer
required
response_message
string
required
Example
{
"payload": "SUCCESS",
"response_code": 0,
"response_message": "SUCCESS"
}Last modified: 3 months ago