DOCUMENTATIONv2

GET

Payments

List payment intents

/api/v2/payments

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

PURPOSE + BUSINESS CONTEXT

List payment intents involving the active workspace and distinguish proposed, cancelled, future execution, and settlement states without inferring money movement.

WHEN THIS CALL IS USEFUL

Call this to drive payer and payee operations queues, reconcile ambiguous creates or cancellations, and select a payment for a fresh detail read.

OUTCOME · Observe and reconcile

What changes

Read-only. It cannot authorize, reserve, cancel, submit, confirm, settle, refund, or mutate a balance.

WHY IT MATTERS

Provides one bounded reconciliation queue for both sides of a payment relationship.
Explicit negative safety flags prevent dashboards and agents from turning an intent into a false settlement claim.

ISOLATION + AUTHORITY

Only payments whose payer or payee is the authenticated workspace are returned. The projection excludes profile identities, raw account selectors, balances, credentials, keys, and unrelated payment records.

BEFORE YOU CALL

A bearer token with payments:read.
An authenticated active workspace and, when filtering, a documented state, direction, limit, and cursor.

WHAT TO DO NEXT

Read one payment for its current version, commitments, and cancellation evidence.
Cancel only an outgoing intent that remains exactly AUTHORIZATION_REQUIRED.

AGENT GUIDANCE

Use direction=outgoing for payer intents and direction=incoming for payee visibility.
Interpret the explicit boolean safety fields independently from status; false never means unavailable data may be assumed true.
Preserve decimal strings and re-read detail before any consequential follow-up.

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_…

cursorqueryOptional

32-character lowercase hexadecimal cursor · nullableCursor returned by the preceding page; reuse only with identical state and direction filters.EXAMPLEb4f2ed5fcfa7474d90f976a838670b14

limitqueryOptional

integer · 1–200 · nullableMaximum records to return; defaults to 50 and cannot exceed 200.Schema range: 0 to unboundedEXAMPLE50

statequeryOptional

uppercase payment lifecycle state · nullableExact payment-intent lifecycle filter. Omit it to use the documented default or unfiltered behavior.EXAMPLEAUTHORIZATION_REQUIRED

directionqueryOptional

incoming | outgoing | all · nullableRelationship to the authenticated workspace: incoming, outgoing, or all.EXAMPLEall

X-Request-IDheaderOptional

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

RESPONSES

Status and payload examples

200Owner-isolated incoming and outgoing intents. AUTHORIZATION_REQUIRED means recorded but not reserved, submitted, confirmed, or settled.Read completed · JSON RESPONSE+

{
  "direction": "example-direction",
  "items": [
    {
      "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
    }
  ],
  "limit": 0,
  "next_cursor": "example-next-cursor"
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then read one payment for its current version, commitments, and cancellation evidence.
RETRY SAFETY: For another page, send the returned opaque cursor unchanged with the same filters. Restart without a cursor when a new snapshot is required.
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.

422Path, query, or body validation failed.Request must change · JSON RESPONSE+

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

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. A corrected read may be sent as a new attempt.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. 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

List owner-visible incoming or outgoing payment intents and reconcile their explicit pre-settlement lifecycle and safety 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 ↗