Mandates

Amend Mandate

Request a change to the maximum collection amount on an active mandate

Request an amendment to the maximum collection amount on an active mandate.

Endpoint

POST /api/mandates/{mandate_id}/amend

Authentication: Required (API Key)

Description

Submits an amendment request to the bank to update the maximum amount that can be collected per instalment. The amendment is not applied immediately, it takes effect once the bank approves it, which is indicated by mandate_action_date in the response.

maximum_amount sets the ceiling for what can be collected per instalment. To actually change the instalment amount for the upcoming instalments, use the Update Subscription endpoint.

Important Restrictions

  • Only mandates with status active can be amended

Parameters

Path Parameters

ParameterTypeRequiredDescription
mandate_idintegerYesThe NjiaPay internal mandate ID

Body Parameters

ParameterTypeRequiredDescription
max_amountintegerYesNew maximum collection amount in minor units (cents). E.g., 1500 = R15.00

Example Request

curl -X POST "https://api.njiapay.com/api/mandates/42/amend" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"max_amount": 1500}'

Response

Success (200 OK)

{
  "contract_number": "MANDATE-12345",
  "transaction_type": "TT2",
  "mandate_action_date": "2025-07-01",
  "maximum_amount": 1500,
  "instalment_amount": null
}
FieldTypeDescription
contract_numberstring | nullContract number at the provider
transaction_typestring | nullTransaction type used for the amendment
mandate_action_datestring | nullDate when the amendment becomes active at the bank
maximum_amountinteger | nullNew maximum amount once the amendment is accepted by the bank
instalment_amountinteger | nullNew instalment amount once the amendment is accepted by the bank

Error Responses

403 Forbidden

{
  "detail": "Mandate does not belong to this merchant"
}

404 Not Found

{
  "detail": "No active mandate found for this reference_id"
}

409 Conflict

{
  "detail": "Mandate not active. Only active mandates can be amended"
}

502 Bad Gateway

{
  "detail": "Mandate amending failed at payment provider"
}

Causes:

  • The payment provider returned an error or is unreachable