Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.hellgate.io/llms.txt

Use this file to discover all available pages before exploring further.

The Payments API provides endpoints for creating payment transactions, managing their lifecycle, and accessing payment data. Commerce V1 uses an event-driven architecture where payments trigger CloudEvents throughout their lifecycle.

​
Payment Operations

Create new payment transactions through the payment creation endpoint. Payments can be processed across multiple payment instruments including cards, SEPA Direct Debit, ACH, and bank transfers. Key capabilities:
  • Payment creation: Initiate new payment transactions with comprehensive payment details
  • Capture: Finalize pre-authorized payments when ready to settle
  • Void: Cancel authorized but uncaptured transactions
  • Refund: Return funds to customers for captured payments
  • Payment verification: Verify payment status and details

​
Payment Lifecycle

Commerce V1 manages payment state transitions through its flow engine. Payment state changes are communicated via the StateChanged event, allowing your integration to track payment progress in real-time. The payment lifecycle typically follows this pattern:
  1. Payment intent created via API
  2. Payment flows through configured processing logic
  3. State changes trigger events to your listeners
  4. Transaction reaches terminal state (success/failure)
  5. Settlement events provide final reconciliation data

​
Payment Data Access

Query payment data through list and detail endpoints. The API supports pagination for listing payments and provides detailed transaction history for each payment, including all state transitions and processor responses.

​
Platform Payments

For marketplace and platform scenarios, Commerce V1 supports distribution of payment amounts across multiple seller accounts. Use the distribution request endpoint to split payments between platform and seller accounts according to your business model. For detailed integration guidance, see the Integration Overview.