Create Collection

cURL

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",
  "schedule": {
    "type": "SCHEDULED",
    "frequency": "WEEKLY",
    "amount": "500",
    "entries": [
      {
        "date": "2025-05-22T05:43:00",
        "amount": "200"
      }
    ]
  },
  "reference": "Testing Mona Scheduled Collection--Succeed",
  "agentId": "507f1f77bcf86cd799439011"
}
'

{
  "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"
  }
}

POST

collections

cURL

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",
  "schedule": {
    "type": "SCHEDULED",
    "frequency": "WEEKLY",
    "amount": "500",
    "entries": [
      {
        "date": "2025-05-22T05:43:00",
        "amount": "200"
      }
    ]
  },
  "reference": "Testing Mona Scheduled Collection--Succeed",
  "agentId": "507f1f77bcf86cd799439011"
}
'

{
  "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

x-api-key

string

header

required

Body

application/json

Collection creation parameters

maximumAmount

string

required

The maximum amount for the collection in kobo (Nigerian minor currency unit)

Example:

"600"

debitType

enum<string>

required

Type of debit initiation

Available options:

MONA,

MERCHANT

Example:

"MERCHANT"

startDate

string<date-time>

required

Start date for the collection

Example:

"2025-05-22T05:43:00"

expiryDate

string<date-time>

required

Expiry date for the collection

Example:

"2025-06-19T08:42:00"

schedule

object

required

Schedule configuration for the collection

Show child attributes

schedule.type

enum<string>

required

Available options:

SCHEDULED,

SUBSCRIPTION

Example:

"SCHEDULED"

schedule.frequency

enum<string>

required

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

SEMI_ANNUAL,

ANNUAL

Example:

"WEEKLY"

schedule.amount

string

Fixed amount for the collection in kobo (Nigerian minor currency unit)

Example:

"500"

schedule.entries

object[]

List of individual collection entries

Show child attributes

schedule.entries.date

string<date-time>

required

Example:

"2025-05-22T05:43:00"

schedule.entries.amount

string

required

Amount for this collection entry in kobo (Nigerian minor currency unit)

Example:

"200"

reference

string

Optional reference for the collection

Example:

"Testing Mona Scheduled Collection--Succeed"

agentId

string

ObjectId of the user associated with your company that is the agent processing the collection

Example:

"507f1f77bcf86cd799439011"

Response

Collection created response

success

boolean

required

Indicates if the request was successful

Example:

true

data

object

required

Show child attributes

data.id

string

required

Unique collection identifier

Example:

"68554203285367d030f8d398"

data.isConsented

boolean

required

Whether the user has consented to the collection

Example:

false

data.collection

object

required

Detailed collection information

Show child attributes

data.collection.maxAmount

string

Maximum amount for the collection in kobo (Nigerian minor currency unit)

Example:

"10000"

data.collection.expiryDate

string<date-time>

Expiry date for the collection

Example:

"2025-06-24T00:00:00.000Z"

data.collection.startDate

string<date-time>

Start date for the collection

Example:

"2025-06-20T13:12:03.075Z"

data.collection.monthlyLimit

string

Monthly limit for the collection in kobo (Nigerian minor currency unit)

Example:

"10000"

data.collection.schedule

object

Schedule configuration for the collection

Show child attributes

data.collection.schedule.type

enum<string>

Available options:

SCHEDULED,

SUBSCRIPTION

Example:

"SCHEDULED"

data.collection.schedule.frequency

enum<string> | null

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

SEMI_ANNUAL,

ANNUAL

Example:

null

data.collection.schedule.entries

object[]

List of individual collection entries

Show child attributes

data.collection.schedule.entries.date

string<date-time>

required

Example:

"2025-06-22T11:11:00.000Z"

data.collection.schedule.entries.amount

string

required

Amount for this collection entry in kobo (Nigerian minor currency unit)

Example:

"10000"

data.collection.schedule.amount

string | null

Fixed amount for the collection in kobo (Nigerian minor currency unit)

Example:

null

data.collection.reference

string

Reference for the collection

Example:

"LOAN"

data.collection.status

string

Current status of the collection

Example:

"NOT_STARTED"

data.collection.lastCollectedAt

string<date-time> | null

Date of last collection

Example:

null

data.collection.nextCollectionAt

string<date-time>

Date of next collection

Example:

"2025-06-20T13:12:03.075Z"

data.collection.debitType

enum<string>

Type of debit initiation

Available options:

MONA,

MERCHANT

Example:

"MERCHANT"

data.collection.loanLinkToken

string

Loan link token

Example:

"68554203285367d030f8d394"

data.createdAt

string<date-time>

required

Creation timestamp

Example:

"2025-06-20T11:12:03.816Z"

data.updatedAt

string<date-time>

required

Last update timestamp

Example:

"2025-06-20T11:12:03.816Z"

Collections Create a Payment

⌘I

Introduction

SDK Components

API Reference

Authorizations

Body

Response