DPDzero: API integration docs

Using API integration DPDzero can keep the data in sync with your system. This document prescribes a minimal API structure that you would need to build to keep data in sync once you have allocated cases to us.

Authentication

Since its your system, DPDzero does not prescribe any authentication mechanisms. Please share the API credentials and documentation on how to authenticate API requests.

Get loan details

Sample request

{
	"loan_number": "ABC-123"
}

Sample response

{
  "earliest_unpaid_due_date": "2023-12-01", // earliest due date that is not paid
	"status": "COLLECTED/PENDING", // If status is COLLECTED, DPDzero will stop collection efforts
	"total_amount_due": "200.00", // 0 if already paid
	"payment_link": "https://rzp.io/ahdahd", // at least 3 days of validity
	"last_repayments": [// If status is COLLECTED
     { 
		  	"date": "2023-12-01",
			  "repayment_amount": "200.00",
   			"repayment_reference": "17315176512"
	   },
     {
		  	"date": "2023-12-01",
			  "repayment_amount": "200.00",
   			"repayment_reference": "17315176512"
	   },
  ]
}

Update payment API (optional)

If DPDzero is managing your Cashfree/Razorpay/PhonePe, you may want your system to be updated in real time with transactions. You need to provide an API that has parameters such as following.

Sample Request

{
        "txndatetime": "2023-08-08T13:13:36",
        "amount_paid": "100.00",
        "pg": "CashFree|PhonePe",
        "transaction_id": "PRQK77LKRS0",
        "loan_number": "ABC-123"
}

Response

{
	"status": "SUCCESS/FAILURE",
	"message": "Updated successfully"
}