Search payment payers

POST

https://ssuccessv2.com/app/api/v2/payment/search/payer

Searches parents, families, and donors using optional text, strict matching, forced payer selection, and cursor pagination.

AuthorizationBearer

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

This endpoint expects an object.

searchstring or nullOptional<=255 characters

forcedobject or nullOptional

strict_searchboolean or nullOptional

cursorstring or nullOptional<=4096 characters

Payer matches and cursor metadata are returned in the search service success envelope.

statusstringOptional

messagestringOptional

datalist of objectsOptional

next_cursorstring or nullOptional

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/payment/search/payer \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'