Encore

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 <glossary: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.

post/v1/book/copy-jobs/run-kickouts

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/book/copy-jobs/run-kickouts
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Response

Success

Example response

{
  "response": {
    "job_count": 9
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.