Documentation

Record Payment

Table of Contents

Record a payment already received outside QReserve, such as a cheque. For manual payments, the API key user needs invoice editing and payment recording permissions. This workflow records the payment in QReserve and can update the invoice’s paid status.

POST /invoices/{invoice_id}/record_payment

Path Parameters

Parameter Type Required Description
invoice_id string Yes QReserve ID of the invoice.

Request Body

Parameter Type Required Description
amount integer Yes Payment amount in hundredths of a currency unit. For example, use 2500 for CAD 25.00.
currency_code string No Defaults to the site’s currency code.
payment_source string No Use manual for a manually recorded payment.
payment_method string No Method shown on the record, such as Cheque.
received_date string No Date received (YYYY-MM-DD). Defaults to today in the site’s time zone.
reference_number string No External reference, such as a cheque number.
success boolean No Whether the payment succeeded. Defaults to true.
receipt_email string No Email address to receive the receipt.
status string No Additional status text for the payment record.

For terminal integrations the same route can update a pending attempt by its order_id. Completed payments and other finalized attempts cannot be edited through this route.

Example

curl -X POST 'https://api.qreserve.com/invoices/INVOICE_ID/record_payment' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"amount":2500,"currency_code":"CAD","payment_source":"manual","payment_method":"Cheque","received_date":"2026-10-15","reference_number":"CHQ-1042"}'

Response

data contains the payment record, including its ID and associated invoice. The example is abbreviated.

{
  "status": "success",
  "data": {
    "invoice_payment_record_id": "PAYMENT_RECORD_ID",
    "amount": 2500,
    "amount_dec": 25,
    "currency_code": "CAD",
    "success": true,
    "payment_source": "manual",
    "payment_method": "Cheque",
    "received_date": "2026-10-15",
    "reference_number": "CHQ-1042",
    "invoice": {
      "invoice_id": "INVOICE_ID"
    }
  }
}

Use a current, active invoice. Depending on its status, an expired or voided invoice can reject the request.

See the Invoices API overview for shared IDs and permissions.