# Cancel invoice API

Cancel an unpaid invoice. Its hosted link stops working. Cancelling an invoice that is already cancelled succeeds again (INV17); an invoice that is paid or has payments cannot be cancelled (INV18).

## Endpoint
- **Method**: POST
- **URL**: https://sandbox.moolre.com/open/invoice/cancel

## Headers
| Header | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| X-API-USER | string | Yes | Your Moolre username. |
| X-API-KEY | string | Yes | Your wallet private API key. A public key is refused. |

## Request Body
| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| accountnumber | string | Yes | Your Moolre wallet account number. |
| invoiceid | string | Yes | The invoiceid to cancel. |

## Response (200 Success)
The invoice is cancelled.

```json
{
  "status": 1,
  "code": "INV17",
  "message": "Invoice cancelled.",
  "data": {
    "invoiceid": "5-1",
    "status": "cancelled",
    "reference": "INV-1001",
    "invoice_name": "Term 1 fees",
    "currency": "GHS",
    "total": "100.00",
    "amount_paid": "0.00",
    "tax": "0",
    "items": [
      {
        "amount": "50.00",
        "quantity": "2",
        "description": "Tuition"
      }
    ],
    "customer": {
      "name": "Ama Mensah",
      "phone": "0240000001",
      "email": ""
    },
    "narration": "Term 1 fees",
    "due_date": "2026-12-31T23:59:59Z",
    "payment_link": "https://invoice.moolre.com/5-1",
    "payment_code": "*203*0621#",
    "metadata": null,
    "created": "2026-11-15T09:00:00Z"
  },
  "go": null,
  "meta": {
    "requestid": "req_c68f4c66115c26725c796242",
    "notices": []
  }
}
```

## Response (200 (HTTP 409 in strict mode) Cannot cancel)
The invoice is paid or has payments. data is the invoice.

```json
{
  "status": 0,
  "code": "INV18",
  "message": "This invoice has payments and cannot be cancelled.",
  "data": {
    "invoiceid": "5-1",
    "status": "paid",
    "reference": "INV-1001",
    "invoice_name": "Term 1 fees",
    "currency": "GHS",
    "total": "100.00",
    "amount_paid": "0.00",
    "tax": "0",
    "items": [
      {
        "amount": "50.00",
        "quantity": "2",
        "description": "Tuition"
      }
    ],
    "customer": {
      "name": "Ama Mensah",
      "phone": "0240000001",
      "email": ""
    },
    "narration": "Term 1 fees",
    "due_date": "2026-12-31T23:59:59Z",
    "payment_link": "https://invoice.moolre.com/5-1",
    "payment_code": "*203*0621#",
    "metadata": null,
    "created": "2026-11-15T09:00:00Z"
  },
  "go": null,
  "meta": {
    "requestid": "req_c68f4c66115c26725c796242",
    "notices": []
  }
}
```


## Fields every response can carry

These fields are additive: existing fields keep their names, order and types.

| Field | Meaning |
| :--- | :--- |
| error | On a failure: { code, message, fields: [{ field, code, message }] } listing every failing field. |
| meta | Always present, last in the object. meta.replayed is true only when the response is the stored answer to a repeated Idempotency-Key (absent otherwise). meta.requestid is the unique id of the request (also the X-Request-Id response header): quote it when you contact support. meta.notices is always an array, empty when there is nothing to report; each notice is { code, message, docs? }, for example that a deprecated way of sending credentials was used. See [Deprecations](https://docs.moolre.com/guides/deprecations). |

There is no outcome field. Decide the result from status, code and, on payment and transfer endpoints, data.txstatus (0 pending, 1 succeeded, 2 failed). These codes mean the result is unknown and may still succeed, so treat them as pending and check the status: PY01, PY02, TR01, TR02, TP11, TP18, APY10, APY16, ASL06, SYS500. Status 1 with TR08, OBGH01, OTGH01, OBNG01, GHQ03 or OM03 is final success; any other status 1 is an accepted, unfinished request.

Send X-Moolre-Http-Status: strict to receive real HTTP status codes (400, 401, 403, 404, 409, 422, 429, 5xx) instead of HTTP 200. See [Responses and request IDs](https://docs.moolre.com/guides/responses).
