Create a refund

Operation ID: createRefund

Group: Accounting › Refunds

Open in the interactive reference

POST /accounting/refunds

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

Creates a refund against a source payment. The refund is created with approvalStatus 'approved', which sends it to the payment provider. There is no separate approval step.

customerId, entityId, and currency come from the source payment and aren't inputs.

When the payment doesn't have enough unapplied balance, list invoices in unapply. The payment is unapplied from those invoices before the refund is created, in the same request.

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.

Request body

Required, application/json: createRefundInput.

Field Type Required Description
paymentId string yes The source payment being refunded. See id on GET accounting/payments/:id. Example: "5a0f3e6d-81b7-4c8e-9b21-9c2a6a107d34".
refundDate date yes The date the refund is issued. Use format YYYY-MM-DD. Must fall in an open accounting period. Example: "2026-08-01".
refundType any yes The payment method used for the refund. One of: "check", "ach", "wire", "creditCard", "directDebit", "sepaCreditTransfer". Example: "ach".
amount decimal yes The refund amount, in the source payment's currency. Must be greater than 0. Example: "150.00".
refundNote string no A free-form note attached to the refund. Example: "Customer requested partial refund".
unapply array<object> no Invoices to unapply the source payment from before the refund is created, freeing balance for the refund. The amount unapplied from each invoice is recognized on refundDate.
unapply[].invoiceId string yes The invoice to unapply the payment from. See id on GET accounting/invoices/:id.
unapply[].amount decimal yes The amount to unapply from this invoice, in the payment currency. 
{
  "paymentId": "5a0f3e6d-81b7-4c8e-9b21-9c2a6a107d34",
  "refundDate": "2026-08-01",
  "refundType": "ach",
  "amount": "150.00",
  "refundNote": "Customer requested partial refund",
  "unapply": [
    {
      "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amount": "19.99"
    }
  ]
}

Response

200 Success

Under data (createRefundOutput):

Field Type Required Description
id string yes The unique identifier for the created refund. Example: "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45".
refundNumber string no The refund number, unique within the tenant, for example 'REF-1042'. Assigned on create. 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, always 'approved' immediately after create. Example: "approved".
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, derived from the source payment. 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: "150.00".
customerId string yes The customer receiving the refund, derived from the source payment. See id on GET accounting/customers/:id. Example: "9c2a6a10-7d34-4c8e-9b21-5a0f3e6d81b7".
entityId string yes The legal entity issuing the refund, derived from the source payment. 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-01T09:12:44.000Z". 
{
  "data": {
    "id": "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
    "refundNumber": "REF-1042",
    "refundDate": "2026-08-01",
    "approvalStatus": "approved",
    "refundType": "ach",
    "currency": "USD",
    "amount": "150.00",
    "customerId": "9c2a6a10-7d34-4c8e-9b21-5a0f3e6d81b7",
    "entityId": "1a24d5e9-3b7d-4f80-9c6d-2e8f70b13a45",
    "paymentId": "5a0f3e6d-81b7-4c8e-9b21-9c2a6a107d34",
    "lastModifiedDate": "2026-08-01T09:12:44.000Z"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
PAYMENT_NOT_FOUND 400
INVOICE_NOT_FOUND 400
INVALID_AMOUNT 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses