Skip to main content
POST
Draft payment proposals from a conversation (ALPHA)

Authorizations

x-api-key
string
header
required

Path Parameters

payment_agent_id
string
required

Body

application/json

A freeform proposals conversation. The server is stateless — send the whole history in messages on each call. prompt is a convenience for a single-shot turn (or the latest user message); it is appended after messages. At least one of prompt or messages must be non-empty. Supplying both is valid only when messages does not already end with a user turn; otherwise the request is rejected with 400 (two consecutive user turns are not allowed).

prompt
string

Single-shot input, appended as the latest user turn.

messages
object[]

The conversation so far, oldest first.

Response

The agent's next step — a reply, proposals, or both

The agent's next step. At least one of proposals or reply is always present in a successful response — proposals at high confidence (optionally with a short reply note), or reply alone when the agent needs more from the user.

proposals
object[]

Validated action-series proposals, ready to accept via POST /instructions. Present only at high confidence.

reply
string

The agent's conversational reply — a clarifying question or confirmation. Present without proposals when the agent needs more from the user; may accompany proposals as a short note.

conversation_status
enum<string>

How the boundary screen treated this turn. ok is a normal payments turn; warned means the request was off-topic and the customer was warned but may continue; blocked means the conversation has been terminated (repeated off-topic turns or a manipulation attempt) — the client should stop serving it and offer a fresh chat.

Available options:
ok,
warned,
blocked