Get Refund

GET /accounting/refunds/{id}

Group: Accounting › Refunds · Operation ID: getRefund

Returns the refund with the given identifier. Use the refund's id, not its refundNumber.

The refund returned here has the same fields as GET accounting/refunds and POST accounting/refunds/search.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "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.
id path string yes The unique identifier for the refund to return.

Response

200 Success

Under data (getRefundOutput):

Field Type Required Description
id string yes The unique identifier for the refund.
refundNumber string no The refund number, unique within the tenant, for example 'REF-1042'. Assigned on create.
refundDate string (date) yes The date the refund was issued. Format YYYY-MM-DD.
approvalStatus string no The approval status. Possible values: 'draft', 'pendingApproval', 'revise', 'approved', 'rejected'. A refund created through POST accounting/refunds is approved immediately.
refundType string yes The payment method used for the refund. Possible values: 'check', 'ach', 'wire', 'creditCard', 'directDebit', 'sepaCreditTransfer'.
currency string yes The currency of the refund. Every amount on it is in this currency. Format ISO 4217, for example 'USD'.
amount string (decimal) yes The refund amount, in the refund currency.
unappliedAmount string (decimal) no The unapplied balance remaining on the source payment, in the refund currency.
refundNote string no A free-form note attached to the refund. Absent when none was set.
customerId string yes The customer receiving the refund. See id on GET accounting/customers/:id.
customerName string no The name of the customer receiving the refund.
entityId string yes The legal entity issuing the refund. See id on GET base/entities.
paymentId string yes The source payment being refunded. See id on GET accounting/payments/:id.
paymentNumber string no The number of the source payment being refunded.
lastModifiedDate string (date-time) yes The date and time the refund last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses