Peach Payments

Peach Payments Orchestration Interactive Documentation

Learn how to integrate Peach Payments payment flows with live code editors, real API calls, and interactive SDK demos.

Payment Flows

Choose a payment flow to explore its implementation step by step.

Purchase

One-time payment with automatic capture. The payment is captured immediately when the customer completes the checkout.

Key Differences

capture_method: 'automatic'Single-step capture

Use Cases

  • E-commerce checkout
  • One-time purchases
  • Digital goods

Pre-Authorization

Authorize now, capture later. Useful when you need to verify funds before shipping or providing a service.

Key Differences

capture_method: 'manual'Two-step process: authorize then capture

Use Cases

  • Hotel bookings
  • Car rentals
  • Pre-orders

Save Card for Returning Customers

Save payment methods for returning customers who will be present during future checkouts. This is Customer-Initiated Transaction (CIT) flow - the customer authenticates each payment, providing the highest security. Ideal for e-commerce 'remember my card' features and account wallets.

Key Differences

setup_future_usage: 'on_session' - Customer present for future chargesSDK automatically shows saved cards when customer_id is set

Use Cases

  • E-commerce 'Remember my card' feature
  • One-click checkout for returning customers
  • Customer payment wallet/account

Recurring Payments & Subscriptions

Set up recurring payments where you charge customers without them being present (Merchant-Initiated Transactions). Uses mandates to establish formal authorization with defined limits, providing the strongest protection against disputes. Choose between charging an initial amount (subscriptions) or zero-auth (free trials).

Key Differences

mandate_data establishes formal recurring authorizationCustomer authenticates once, you charge many times

Use Cases

  • SaaS subscriptions
  • Membership fees
  • Streaming services

Gateway Agnostic MITs

Route MIT (Merchant-Initiated Transaction) payments across multiple processors for better success rates and resilience. Enable this feature and Orchestration handles the technical details - your saved cards work across PeachPayments, ACI, Cybersource, and MPGS.

Key Differences

MIT payments route to any supported processorNo lock-in to original tokenizing gateway

Use Cases

  • High-volume subscription businesses
  • Multi-region payment optimization
  • Processor redundancy/failover

Manual Capture

Authorize funds first, then capture later after delivering goods or services. Also known as 'Auth and Capture' or two-step flow.

Key Differences

capture_method: 'manual'Two-step: authorize then capture

Use Cases

  • Hotel bookings
  • Car rentals
  • Pre-orders

Incremental Authorization

Request additional funds after an initial authorization for scenarios where final costs are uncertain, like hotel stays or car rentals.

Key Differences

request_incremental_authorization: trueNon-SCA regions only

Use Cases

  • Hotel room service & stay extensions
  • Car rental extra charges
  • Variable usage-based billing

Overcapture

Capture more than the originally authorized amount for scenarios like tips, additional shipping costs, or price adjustments.

Key Differences

enable_overcapture: trueManual capture only

Use Cases

  • Tips and gratuities
  • Additional shipping charges
  • Price adjustments

Extended Authorization

Extend the authorization hold period beyond standard timeframes for industries with variable completion times.

Key Differences

request_extended_authorization: trueManual capture only

Use Cases

  • Hotel extended stays
  • Car rentals with variable return
  • Custom manufacturing orders

Payment Links

Generate secure, shareable payment links by creating a payment with payment_link: true. No SDK integration required - perfect for email campaigns, SMS, invoices, or social commerce.

Key Differences

payment_link: true on /payments endpointNo SDK integration required

Use Cases

  • Email marketing campaigns
  • SMS payment requests
  • Social commerce

Webhooks

Receive real-time HTTP push notifications for payment events. Configure via API or Dashboard for reliable payment status tracking and automated workflows.

Key Differences

Configure via API or Dashboardwebhook_details on Business Profile

Use Cases

  • Order fulfillment automation
  • Payment status synchronization
  • Dispute management

Quick Start

1

Choose a Flow

Select the payment flow that matches your use case.

2

Edit & Test

Modify the API request and see real responses from the sandbox.

3

Complete Payment

Use test cards to complete the payment through the SDK.