/settlements

GET https://api.lenco.co/access/v2/settlements

Retrieve information about all your collection settlements

Response Schema:

JSON

{
    "status": boolean,
    "message": string,
    "data": [
	    {
		    "id": string,
		    "amountSettled": string,
		    "currency": string,
		    "createdAt": date-time,
		    "settledAt": date-time | null,
		    "status": "pending" | "settled",
		    "type": "instant" | "next-day",
		    "accountId": string,
		    "collection": {
		        "id": string,
		        "initiatedAt": date-time,
		        "completedAt": date-time | null,
		        "amount": string,
		        "fee": string | null,
		        "bearer": "merchant" | "customer",
		        "currency": string,
		        "reference": string | null,
		        "lencoReference": string,
		        "type": "card" | "mobile-money" |"bank-account",
		        "status": "pending" | "successful" | "failed" | "otp-required" | "pay-offline",
		        "source": "banking-app" | "api",
		        "reasonForFailure": string | null,
		        "settlementStatus": "pending" | "settled" | null,
		        "settlement": null,
		        "mobileMoneyDetails": {
		            "country": string,
		            "phone": string,
		            "operator": string,
		            "accountName": string | null,
		        } | null,
		        "bankAccountDetails": null,
		        "cardDetails": null,
		    };
		}
	],
    "meta": {
        "total": number,
        "pageCount": number,
        "perPage": number,
        "currentPage": number
    }
}