API Conventions - Dollr Developer Docs

Base URL and versioning

All endpoints use the v1 prefix:

https://api.heydollr.app/v1/<resource>

See Environments for credentials and testing guidance.

Some fields accept the same logical ID in different JSON types depending on the endpoint:

Field	Endpoint	JSON type	Example
`session_id`	`POST /v1/executions/*`	string	`"55"`
`session_id`	`POST /v1/realtime-keys/collection`	integer	`55`
`payment_account_id`	Executions	string	`"18"`
`payout_account_id`	Sessions / executions	integer or number	`18`
`source_id`	Sessions, status, predictions	integer	`101`

When in doubt, match the type shown in API Reference for that specific endpoint.

A frequent source of 422 errors:

Context	Field name	Used on
Creating checkout source	`source_kind`	`POST /v1/checkouts/create`
Sessions, status, links, predictions	`source_type`	`POST /v1/sessions/checkout`, `GET /v1/status/source`, etc.

Values are the same: INVOICE or ORDER.

// Checkouts create
{ "source_kind": "INVOICE" }

// Checkout session
{ "source_type": "INVOICE", "source_id": 101 }

SUBSCRIPTION appears in some OpenAPI enums but is not publicly supported yet.

{
  "detail": [
    {
      "loc": ["body", "currency"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

Inspect the detail array for field-level messages.

Code	Meaning	Typical action
`200`	Success	Use response body
`401`	Unauthorized	Refresh JWT
`403`	Forbidden	Check verification / permissions
`404`	Not found	Verify resource ID
`422`	Validation error	Fix payload per `detail`
`429`	Rate limited	Back off; honor `Retry-After`
`5xx`	Server error	Retry with exponential backoff