Collections
Create Collection
Create Collection is where users can set up recurring payment schedules and subscription billing for their customers with flexible frequency options.
POST
/
collections
Copy
curl --request POST \
--url https://api.development.mona.ng/collections \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"maximumAmount": "600",
"debitType": "MERCHANT",
"startDate": "2025-05-22T05:43:00",
"expiryDate": "2025-06-19T08:42:00",
"reference": "Testing Mona Scheduled Collection--Succeed",
"schedule": {
"type": "SCHEDULED",
"frequency": "WEEKLY",
"amount": "500",
"entries": [
{
"date": "2025-05-22T05:43:00",
"amount": "200"
}
]
},
"agentId": "507f1f77bcf86cd799439011"
}'
Copy
{
"success": true,
"data": {
"id": "68554203285367d030f8d398",
"isConsented": false,
"collection": {
"maxAmount": "10000",
"expiryDate": "2025-06-24T00:00:00.000Z",
"startDate": "2025-06-20T13:12:03.075Z",
"monthlyLimit": "10000",
"schedule": {
"type": "SCHEDULED",
"frequency": null,
"entries": [
{
"date": "2025-06-22T11:11:00.000Z",
"amount": "10000"
}
],
"amount": null
},
"reference": "LOAN",
"status": "NOT_STARTED",
"lastCollectedAt": null,
"nextCollectionAt": "2025-06-20T13:12:03.075Z",
"debitType": "MERCHANT",
"loanLinkToken": "68554203285367d030f8d394"
},
"createdAt": "2025-06-20T11:12:03.816Z",
"updatedAt": "2025-06-20T11:12:03.816Z"
}
}
Authorizations
Body
application/json
Collection creation parameters
The body is of type object
.
Response
200
application/json
Collection created response
The response is of type object
.
Copy
curl --request POST \
--url https://api.development.mona.ng/collections \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"maximumAmount": "600",
"debitType": "MERCHANT",
"startDate": "2025-05-22T05:43:00",
"expiryDate": "2025-06-19T08:42:00",
"reference": "Testing Mona Scheduled Collection--Succeed",
"schedule": {
"type": "SCHEDULED",
"frequency": "WEEKLY",
"amount": "500",
"entries": [
{
"date": "2025-05-22T05:43:00",
"amount": "200"
}
]
},
"agentId": "507f1f77bcf86cd799439011"
}'
Copy
{
"success": true,
"data": {
"id": "68554203285367d030f8d398",
"isConsented": false,
"collection": {
"maxAmount": "10000",
"expiryDate": "2025-06-24T00:00:00.000Z",
"startDate": "2025-06-20T13:12:03.075Z",
"monthlyLimit": "10000",
"schedule": {
"type": "SCHEDULED",
"frequency": null,
"entries": [
{
"date": "2025-06-22T11:11:00.000Z",
"amount": "10000"
}
],
"amount": null
},
"reference": "LOAN",
"status": "NOT_STARTED",
"lastCollectedAt": null,
"nextCollectionAt": "2025-06-20T13:12:03.075Z",
"debitType": "MERCHANT",
"loanLinkToken": "68554203285367d030f8d394"
},
"createdAt": "2025-06-20T11:12:03.816Z",
"updatedAt": "2025-06-20T11:12:03.816Z"
}
}
Assistant
Responses are generated using AI and may contain mistakes.