Skip to main content
POST
Cancel payment request

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

paymentRequestId
string
required

Payment request ID (prq_*).

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

Response

Successful Response

data
PaymentRequestResource · object
required