Simulate payroll connection (sandbox only)

​

Completes the certification loop: simulates the payroll vendor confirming the direct-deposit switch for an enrollment, through the same production webhook path. The resulting enrollment.activated arrives on your webhook endpoint and on the feed. Prerequisites, checked before anything is sent: the enrollment is pending and its donor reached the paycheck step of the hosted flow (identity verification, the agreements and the payroll authorization come first — a donor whose account is in review waits before it), or the enrollment is paused and the donor is reconnecting. Otherwise 400 says which one is missing. This simulator is for scripts and CI that do not drive the payroll window: in the hosted sandbox flow, a person connects the payroll through the payroll provider's window in its test mode, which reaches the same activation.

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.

Responses

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

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

Simulated confirmation sent to the webhook edge.

Previous
Simulate a payroll deposit (sandbox only)
Next
Simulate the payroll vendor confirming the deduction removal (sandbox only)