Skip to main content
GET
Get payment intent

Authorizations

Authorization
string
header
required

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

Headers

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

paymentIntentId
string
required

Payment intent ID (pmi_*).

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

Query Parameters

customerPartyId
string

Customer party to act for (pty_*), when acting under a delegation. Omit for an intent your own party created.

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

Response

Successful Response

data
PaymentIntentResource · object
required