Update a refund

Operation ID: updateRefund

Group: Accounting › Refunds

Open in the interactive reference

PATCH /accounting/refunds/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates a refund with the fields you send. A field you leave out keeps its current value.

Use the refund's id, not its refundNumber.

A refund whose approvalStatus is 'approved' can't be updated. Every refund created with POST accounting/refunds is approved at once, so it can't be changed here. customerId, entityId, paymentId, and currency can't be changed.

The response is the updated refund. GET accounting/refunds/:id also returns unappliedAmount, refundNote, customerName, and paymentNumber.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the refund you want to update. Example: "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45".

Request body

Required, application/json: updateRefundInput.

Field Type Required Description
refundDate date no The new issue date. Use format YYYY-MM-DD. Must fall in an open accounting period. Omit to leave it unchanged.
refundType any no The new payment method. Omit to leave it unchanged. One of: "check", "ach", "wire", "creditCard", "directDebit", "sepaCreditTransfer".
refundNote string no A new free-form note. Omit to leave it unchanged.
amount decimal no The new refund amount, in the refund currency. Must be greater than 0. Omit to leave it unchanged. Example: "175.00". 
{
  "refundDate": "2026-01-15",
  "refundType": "check",
  "refundNote": "<refundNote>",
  "amount": "175.00"
}

Response

200 Success

Under data (updateRefundOutput):

Field Type Required Description
id string yes The unique identifier for the refund. Example: "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45".
refundNumber string no The refund number, unique within the tenant, for example 'REF-1042'. Example: "REF-1042".
refundDate date yes The date the refund was issued. Format YYYY-MM-DD. Example: "2026-08-01".
approvalStatus string no The approval status after the change. Possible values: 'draft', 'pendingApproval', 'revise', 'approved', 'rejected'. Example: "pendingApproval".
refundType string yes The payment method used for the refund. Possible values: 'check', 'ach', 'wire', 'creditCard', 'directDebit', 'sepaCreditTransfer'. Example: "ach".
currency string yes The currency of the refund. Every amount on it is in this currency. Format ISO 4217, for example 'USD'. Example: "USD".
amount decimal yes The refund amount, in the refund currency. Example: "175.00".
customerId string yes The customer receiving the refund. See id on GET accounting/customers/:id. Example: "9c2a6a10-7d34-4c8e-9b21-5a0f3e6d81b7".
entityId string yes The legal entity issuing the refund. See id on GET base/entities. Example: "1a24d5e9-3b7d-4f80-9c6d-2e8f70b13a45".
paymentId string yes The source payment being refunded. See id on GET accounting/payments/:id. Example: "5a0f3e6d-81b7-4c8e-9b21-9c2a6a107d34".
lastModifiedDate date-time yes The date and time the refund last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-08-01T10:02:11.000Z". 
{
  "data": {
    "id": "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
    "refundNumber": "REF-1042",
    "refundDate": "2026-08-01",
    "approvalStatus": "pendingApproval",
    "refundType": "ach",
    "currency": "USD",
    "amount": "175.00",
    "customerId": "9c2a6a10-7d34-4c8e-9b21-5a0f3e6d81b7",
    "entityId": "1a24d5e9-3b7d-4f80-9c6d-2e8f70b13a45",
    "paymentId": "5a0f3e6d-81b7-4c8e-9b21-9c2a6a107d34",
    "lastModifiedDate": "2026-08-01T10:02:11.000Z"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
REFUND_ALREADY_APPROVED 400
INVALID_AMOUNT 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses