Simulate the donor signing in to their payroll (sandbox only)

​

For scripts and CI that do not drive the payroll window. In the hosted flow, the donor signs in to their payroll in the payroll provider's window, and then accepts the recurring authorization and saves the gift on the payroll-confirm screen. This simulator plays that sign-in: once the donor reaches the payroll screen (payroll-signin), call it, and within a few seconds the flow closes the window and shows payroll-confirm. Tick agree-payroll-auth, click payroll-install, then simulate the payroll's confirmation with POST /sandbox/simulate/payroll-connected. Prerequisites, checked before anything is recorded: the enrollment is pending and its donor reached the payroll screen (identity verification and the agreements come first — a donor whose account is in review waits before it). Otherwise 400 says which one is missing. Calling it again for the same payroll screen changes nothing.

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
Request Example for post/sandbox/simulate/payroll-signin
curl https://api.sandbox.rostergiving.com/sandbox/simulate/payroll-signin \
  --request POST \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "enrollment_id": "",
  "church_id": ""
}'

{
  "next_screen": "payroll-confirm"
}

Simulated sign-in recorded.

Previous
Simulate a payroll deposit (sandbox only)
Next
Simulate payroll connection (sandbox only)