Refund

Amount of the refund, in USD cents. It does not change after creation.

Whether the request also cancelled the donor's recurring gift.

Roster identifier of the church that received the donation.

When the refund was created, in UTC.

Currency of the amount; always USD.

The donation this refund returns, the id of its donation.updated snapshot.

Why a failed refund ended; null in every other status. not_refundable: Roster cannot return this donation through a refund and handles it directly. bank_error: the bank could not send the money.

The part of the refund taken from each fund of the donation's split, in USD cents, fixed when the refund is created. The parts add up to amount_minor, and no fund returns more than what is left of it: each part is in proportion to what is left in each fund, with the cents left by rounding going to the funds with the largest remainders (a tie goes to the fund listed first), so a refund of what is left empties every fund. null when the donation has no split.

Identifier of the refund.

Your key-value pairs, as sent in POST /v1/refunds; null when none were sent and on refunds Roster created.

Always refund.

What a pending refund waits for; null in every other status. in_review: the donation is in review at Roster, and the refund waits for that review to end. awaiting_approval: Roster is checking the refund before sending the money. processing: the money was sent to the donor's bank and waits for the bank's confirmation.

Why the donation is refunded, as sent in POST /v1/refunds. Roster also creates refunds on its own, for money that reached the donor's account and is not passed on to the church: after_cancellation when it arrived after the donor's recurring gift was cancelled, other otherwise.

Where the refund is. pending: on its way; pending_reason says what it waits for. requires_action: Roster needs a bank account from the donor to send the money; Roster emails the donor a link to add it, and the refund moves on by itself once they do. succeeded: the donor's bank received the money; if that bank later sends it back, the refund returns to requires_action. failed: the refund ended without sending the money; see failure_reason. canceled: canceled by you or by Roster before the money was sent. failed and canceled free the amount, which can be refunded again.

When the refund last changed, in UTC.