Retrieve payer fee allocations

Retrieves payable fee, pledge, and unallocated-payment information for a selected payer and optional payment or plan context.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
payer_idintegerRequired
payer_typestringRequired
payment_idinteger or nullOptional
plan_idinteger or nullOptional
donor_idinteger or nullOptional

Response

Payer allocation totals and selectable fees are returned as a success JSON payload
statusstringOptional
messagestringOptional
dataobjectOptional
Fee allocation result for the selected payer.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error