Skip to main content
POST
Simulate card payment settlement
Simulates settlement for an existing successful card payment and starts releasing the funds to the merchant’s available balance.

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
Pattern: ^cpy_[0-9a-f]{32}$

Body

application/json
data
object
required

Response

Successful Response

data
object
required