Charge mandate

Charge mandate

POST /api/v1/merchant/external/direct-debit/mandate/charge

Charge a particular mandate with a specific amount

Headers

Name
Value

Content-Type

application/json

api-key

your organisation api key

Body

Name
Type
Description

mandate

string

mandate ID

amount

number

Amount to be charged

loan

string

loan ID (optional)

Response

{
    "status":true,
    "detail":"Mandate Charged succesfully",
    "data":{
        "amount": 1000,
        "narration": "mandate test via nibsseasypay",
        "mandateReference": "clars-2023089819319021212",
        "transactionReference": "clars-202308981931902"
      }
}

Last updated