Run automated cash flow kick-outs

This API signals Ocrolus to run automated cash flow kick-outs using the recipient organization’s preconfigured Encore kick-out criteria. When triggered, Ocrolus evaluates all incoming Book copy jobs currently in the AWAITING_RECIPIENT state and applies the configured rules to automatically accept or reject them. After the evaluation completes, Ocrolus sends the resulting status updates to the sender organization using book.copy.kickout_evaluated webhook events.

📘

Note

This API is intended for small and medium business (SMB) funders using the Book copy feature.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json