Service provider payments

Simulate sandbox service-provider payout states

Returns deterministic sandbox-only payout lifecycle fixtures when the authenticated automation client has services.payouts.manage. External URL: /v1/sandbox/service-provider-payouts/simulate. Current Next.js implementation path: /api/platform/v1/sandbox/service-provider-payouts/simulate. This mutating route requires Idempotency-Key; SDK, CLI, and MCP sandbox simulations may call this route after explicit confirmation, while the route records only standard platform request/idempotency evidence and never creates real Stripe charges, transfers, payouts, bank movements, Xero journals, payout jobs, settlement rows, or fixture mutations.

post/sandbox/service-provider-payouts/simulate

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/sandbox/service-provider-payouts/simulate
  • Auth: HTTP bearer

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Idempotency-Keystring required

Required for mutating platform routes. Accepted format: 8 to 128 ASCII characters matching [A-Za-z0-9._:-]+.

Request body

scenario'draft' | 'approved' | 'processing' | 'reconciled' | 'partial_refund_after_payout' | 'manual_adjustment_increase' | 'manual_adjustment_decrease' | 'provider_onboarding_missing' required

Response

Sandbox payout simulation result.

public_safetyPublicSafety required(unresolved $ref)
authorizationAuthorization required(unresolved $ref)
principalPrincipal required(unresolved $ref)
livemodefalse required
request_idstring required

Changes

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