DOCUMENTATIONv2

GET

Payments

Get payment intent

/api/v2/payments/{payment_uuid}

AUTHENTICATIONBearer token · payments:readAUTHORITATIVE OWNERpayment-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Read one payer- or payee-visible payment intent with exact terms, lifecycle version, commitments, cancellation evidence, and non-settlement flags.

WHEN THIS CALL IS USEFUL

Call this before cancellation, after an ambiguous mutation, when showing payment detail, or whenever cached payment state may be stale.

OUTCOME · Inspect intent

What changes

Read-only. It returns the retained control-plane record and cannot alter payment, ledger, rail, request, wallet, or balance state.

WHY IT MATTERS

Provides the authoritative reconciliation point for one payment intent.
Lets both payer and payee distinguish an authorization-required proposal from cancellation and any future execution states.

ISOLATION + AUTHORITY

Only the payer or payee workspace can read the record. The response contains opaque source references and commitments but no balances, raw accounts, credentials, signing material, or private actor identifiers.

BEFORE YOU CALL

A bearer token with payments:read.
A canonical payment_uuid obtained from the authenticated workspace’s payment collection or a just-completed mutation.

WHAT TO DO NEXT

If the caller is the payer and status remains AUTHORIZATION_REQUIRED, it may cancel with the exact current version.
Otherwise wait for and use only separately documented lifecycle operations.

AGENT GUIDANCE

Use version and status together for any conditional follow-up.
Do not interpret a commitment as confirmation of funds; it commits to this control-plane record only.
If the record is not visible, treat 404 as both not found and not authorized—never probe identifiers across workspaces.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing payments:read authority.EXAMPLEBearer hc_live_…

payment_uuidpathRequired

identifierWorkspace-visible payment identifier. It selects the exact payment uuid addressed by this route.EXAMPLEpayment-uuid-01

X-Request-IDheaderOptional

stringOptional caller correlation identifier. The gateway emits the effective value on the response.

RESPONSES

Status and payload examples

200Current authoritative intent state and commitments. Evaluate every explicit authority and side-effect flag before describing payment progress.Read completed · JSON RESPONSE+

{
  "amount": "100.00",
  "authorization_required": true,
  "balance_mutation_performed": true,
  "cancellation_reason_code": "example-cancellation-reason-code",
  "cancelled_at": "2026-09-02T18:30:00Z",
  "created_at": "2026-09-02T18:30:00Z",
  "currency": "USD",
  "external_reference": "example-external-reference",
  "memo": "example-memo",
  "payee_workspace_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "payer_workspace_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "payment_method": "example-payment-method",
  "payment_request_uuid": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "payment_source_reference": "example-payment-source-reference",
  "payment_uuid": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "purpose_code": "example-purpose-code",
  "rail_submission_created": true,
  "reconciliation_required": true,
  "request_commitment": "example-request-commitment",
  "reservation_created": true,
  "settlement_authority_granted": true,
  "state_commitment": "example-state-commitment",
  "status": "example-status",
  "updated_at": "2026-09-02T18:30:00Z",
  "version": 0
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then if the caller is the payer and status remains AUTHORIZATION_REQUIRED, it may cancel with the exact current version.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Re-read the owner-visible request or payment record and compare its status, version, exact decimal terms, commitments, and explicit safety flags before reusing the same Idempotency-Key with an equivalent mutation.

401Bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for the owner-isolated payment-request and authorization-required intent control plane; authorization, reservation, rail execution, settlement, refunds, and receipts remain separate capabilities.
ESCALATE WHEN: Escalate when a record progressed beyond AUTHORIZATION_REQUIRED, source or rail state is ambiguous, a linked request cannot be reconciled, or a caller needs value movement, settlement, refund, or receipt authority that the implemented Payments control plane does not provide.

403The principal lacks the required scope, role, tenant, or step-up authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for the owner-isolated payment-request and authorization-required intent control plane; authorization, reservation, rail execution, settlement, refunds, and receipts remain separate capabilities.
ESCALATE WHEN: Escalate when a record progressed beyond AUTHORIZATION_REQUIRED, source or rail state is ambiguous, a linked request cannot be reconciled, or a caller needs value movement, settlement, refund, or receipt authority that the implemented Payments control plane does not provide.

404The requested resource does not exist within the authenticated authority boundary.Resource not visible · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
STATE RECONCILIATION: Re-read the owner-visible request or payment record and compare its status, version, exact decimal terms, commitments, and explicit safety flags before reusing the same Idempotency-Key with an equivalent mutation.
ESCALATE WHEN: Escalate when a record progressed beyond AUTHORIZATION_REQUIRED, source or rail state is ambiguous, a linked request cannot be reconciled, or a caller needs value movement, settlement, refund, or receipt authority that the implemented Payments control plane does not provide.

503The authoritative service or read model is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Re-read the owner-visible request or payment record and compare its status, version, exact decimal terms, commitments, and explicit safety flags before reusing the same Idempotency-Key with an equivalent mutation.
ESCALATE WHEN: Escalate when a record progressed beyond AUTHORIZATION_REQUIRED, source or rail state is ambiguous, a linked request cannot be reconciled, or a caller needs value movement, settlement, refund, or receipt authority that the implemented Payments control plane does not provide.

OPERATIONAL NOTES

Security and lifecycle guarantees

Return one owner-visible payment intent with exact terms, commitments, version, cancellation evidence, and explicit non-settlement flags. Authoritative owner: payment-service.
The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗