Lifecycle API

Simulate a sandbox lifecycle response

Advance a submitted synthetic sandbox bill through deterministic accepted, processed, rejected, denied, partial-payment, or paid scenarios.

POSThttps://app.mindbill.org/partner/v2/sandbox/bills/{billId}/simulate

Advance a submitted synthetic sandbox bill through deterministic accepted, processed, rejected, denied, partial-payment, or paid scenarios. This endpoint is unavailable to live credentials and is intended for demos and integration tests.

AuthenticationServer API key or browser session + Origin

Permissions by credentialServer: bills:submit · Browser: bills:act

IdempotencyRequired for safe retries

Use this URL with a server API key or a browser session and its exact allowed Origin. Both credentials use the same request and response contract. See the component API inventory for exact paths and SDK methods.

Path parameters

FieldTypeDescription

billIdRequired

string

MindBill bill ID.

Request body

FieldTypeDescription

scenarioRequired

string

Deterministic synthetic response to apply.

amount

number

Optional payer-reported amount used by partial-payment scenarios.

reasonCode

string

Optional synthetic adjustment or rejection reason code.

Examples

curl 'https://app.mindbill.org/partner/v2/sandbox/bills/{billId}/simulate' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data @request.json \
  --header 'Idempotency-Key: example-write-0001'

curl 'https://app.mindbill.org/partner/v2/sandbox/bills/{billId}/simulate' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example' \
  --header 'Content-Type: application/json' \
  --data @request.json \
  --header 'Idempotency-Key: example-write-0001'

Response

200

Response fields are documented below.

FieldTypeDescription

dataRequired

object

Synthetic simulation result and updated bill state.