Simulate the payroll connection breaking (sandbox only)

​

Certification scenario 2: the donor changes jobs and the payroll deduction stops. This simulator plays the payroll vendor reporting a new monitoring status through the same production webhook path. The three breaking statuses pause the enrollment, arm the 60-day reconnection grace and emit enrollment.paused with reason: "payroll_connection_broken" on your feed. If the grace ends without a reconnection, GET /v1/enrollments/{id} reads terminated; today no event announces that ending, so read the enrollment to see it. degraded and active are the two statuses that deliberately do NOT pause — send them to prove the alarm does not fire on a vendor hiccup. Prerequisite, checked before anything is sent: an active enrollment; otherwise 400. Nothing in the hosted flow breaks a connection, so this simulator is how you test scenario 2, by hand or in CI.

Headers

  • Idempotency-Key
    Type: string
    min length:  
    1
    max length:  
    255
    required

    Required on every POST, before any effect: 1–255 visible ASCII characters, no spaces. The key belongs to the first body sent with it on this operation for 30 days from the moment that request arrives, including while that request is running and after a 5xx or a timeout. On an operation that creates a resource (POST /v1/churches, POST /v1/churches/import, POST /v1/church_consents, POST /v1/donor_sessions, POST /v1/manage_sessions, POST /v1/refunds and POST /v1/webhook_endpoints), a key whose request succeeded keeps its body for as long as the resource it created exists. A creation replayed with the same key and body returns the original resource with 200 and changes nothing; a 4xx releases the key.

Body

required
application/json
  • church_id
    Type: string
    required

    Roster identifier of the church this record belongs to.

  • enrollment_id
    Type: string
    required

    Identifier of the recurring giving arrangement; links its individual donations over time.

  • status
    Type: stringenum

    Payroll-connection state to simulate in the sandbox.

    values
    user_action_requiredunavailablecustomer_disableddegradedactive

Responses

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for post/sandbox/simulate/connection-broken
curl https://api.sandbox.rostergiving.com/sandbox/simulate/connection-broken \
  --request POST \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "enrollment_id": "",
  "church_id": "",
  "status": "user_action_required"
}'

{
  "status_code": 1,
  "expected_event": null
}

Simulated status update sent to the webhook edge.

Previous
Simulate the payroll vendor confirming the deduction removal (sandbox only)
Next
Simulate the bank confirming an account closure (sandbox only)