Request drawdown

POST /v1/draw-downs/customer-partner/{{customer_partner_id}}/request

This endpoint can be called when you want to make a request for a drawdown from your lockbox account.

Payload

This is the payload required to request for a drawdown. If you have not gone through our guide on a quick set up to making api requests, check here

JSON

{
	"amount": 10000,
	"tenor": 30
}

---

The payload object

Compulsory Fields

---

amount _^string
This is how much is being requested.

---

tenor _^string
This is the number of days the drawdown will last.

---

Response

This is the expected response if the request is successful

JSON

{
    "status": "success",
    "message": "Drawdown requested successful",
    "data": {
        "id": "FVkuOXiN9PJiZkEW",
        "customer_partner_id": "OXeSAn4RLEHnOxYB",
        "drawdown_id": null,
        "credit_limit_id": "HCj2LdgxUUuZkuGG",
        "user_id": "7V2xy757VuBQJzIy",
        "amount": "10.00",
        "tenor": 7,
        "status": "requested",
        "deleted_at": null,
        "created_at": "2022-11-30T11:59:42.000Z",
        "updated_at": "2022-11-30T11:59:42.000Z",
        "user": {
            "id": "7V2xy757VuBQJzIy",
            "first_name": "Fawaz",
            "last_name": "Kekere-Ekun",
            "email": "[email protected]",
            "app_key": "$2a$10$nMf.14ct/ga1KPVruF9zDO6C6k8wH/njIsqQUCty8Dd/kxt/JVMyi",
            "is_deleted": false,
            "created_at": "2022-04-21T15:50:24.000Z",
            "updated_at": "2022-09-28T23:41:11.000Z",
            "completed_guides": [
                "transaction-upload-without-drawdown-id",
                "transaction-upload",
                "payment-upload"
            ]
        }
    }
}