latestOpenAPI 3.1.12026-08-239938.6 MB

b1ad79e918ac

PaymentRequests

Get payment request

Get a payment request

get/payment-requests/{paymentRequestId}

Path parameters

paymentRequestIdstring required

Payment request ID (prq_*).

Query parameters

partyIdstring

Effective party ID (pty_*) for delegated payment request access.

Headers

X-Agent-IDstring nullable

Deprecated: agent identity comes from the credential. Sending this header with a party API key or user credential returns 403 agent_credential_required.

X-Instance-IDstring nullable

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

Response

Successful Response