Skip to main content
POST
Sandbox: settle a card payment
Use this endpoint after a Sandbox card payment succeeds. In production, payments settle automatically. Returns the card payment. If settledAt is null, get the card payment again to check settlement. See Accept in Sandbox for a walkthrough.

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

Idempotency-Key
string
required

Unique key for safely retrying a request without creating duplicates.

Maximum string length: 255
X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Path Parameters

cardPaymentId
string
required

Card payment ID (cpy_*). The payment must have succeeded.

Pattern: ^cpy_[0-9a-f]{32}$

Body

application/json
data
object
required

Response

Successful Response

data
CardPaymentResource · object
required