v6

OpenAPI 3.1.12026-08-027636.5 MB

Payments

Get payment

Get a sent payment

get/payments/{paymentId}

Path parameters

paymentIdstring required

Payment ID (pay_*).

Query parameters

partyIdstring

Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

Headers

X-Agent-IDstring nullable

Agent (agt_*) to attribute this request to when authenticating with a party API key; omit for agent keys and agent-scoped OAuth grants, which already carry agent identity.

X-Instance-IDstring nullable

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

Response

Successful Response