Refund contribution

Issue a refund against a gateway-processed contribution, splitting the refund across its line items. Each allocation refunds part of one line item; the line item ids and their remaining refundable balances come from the contribution's allocations on /api/contributions/{id}. Only gateway transactions that are not already voided can be refunded.

Required permission: Can Refund

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the contribution to refund

Body Params

The per-designation refund allocations

The per-line-item amounts that make up a refund.

allocations
array of objects | null
required

The slices of the refund, one per line item being refunded. Each amount is taken from the remaining refundable balance of that line item.

allocations*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json