Void or refund a fundraising payment

POST

https://ssuccessv2.com/app/api/v1/fundraising/payment/campaign/void-refund/:id

Voids or refunds an eligible non-manual payment through its merchant account, optionally including the processing fee and a note. The resulting payment resource is returned.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired

Request

This endpoint expects an object.

notestring or nullOptional

refund_processing_feebooleanOptionalDefaults to false

Response

Payment voided or refunded.

statusstring

messagestring

datamap from strings to any

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/fundraising/payment/campaign/void-refund/501 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"status": "success",
3	"message": "",
4	"data": {
5	"id": 501,
6	"amount_payment": 125,
7	"status": "refunded"
8	}
9	}