Skip to main content

Payment Method Service

Overview​

The Payment Method Service enables you to securely store and manage customer payment methods at payment processors. By tokenizing payment details, you can offer one-click checkout experiences and recurring billing without handling sensitive card data or maintaining PCI compliance overhead.

Business Use Cases:

  • One-click checkout - Returning customers pay with saved payment methods without re-entering card details
  • Subscription billing - Store payment methods for automated recurring charges
  • Mobile wallet integration - Securely vault wallet tokens for future payments
  • Fraud reduction - Tokenized payments reduce fraud liability and improve authorization rates

The service creates secure tokens at the underlying payment processor (Stripe, Adyen, etc.), allowing you to reference payment methods in future transactions without storing sensitive data in your systems.

Operations​

OperationDescriptionUse When
TokenizeStore payment method securely at the processor. Replaces raw card details with token for one-click payments and recurring billing.First-time checkout, saving card for later, subscription setup

Common Patterns​

One-Click Checkout for Returning Customers​

Save payment methods during first purchase to enable faster checkout for returning customers.

sequenceDiagram
    participant App as Your App
    participant CS as Connector Service
    participant PP as Payment Provider

    Note over App: First-time customer checkout
    App->>CS: 1. Tokenize (card details)
    CS->>PP: Store payment method securely
    PP-->>CS: Return payment_method_token
    CS-->>App: Return payment_method_token (pm_xxx)
    Note over App: Store token with customer profile
    App->>CS: 2. Authorize (with token)
    CS->>PP: Charge tokenized payment method
    PP-->>CS: Return authorization
    CS-->>App: Return connector_transaction_id (AUTHORIZED)
    Note over App: Future purchase (returning customer)
    App->>CS: 3. Authorize (with stored token)
    CS->>PP: Charge saved payment method
    PP-->>CS: Return authorization
    CS-->>App: Return connector_transaction_id (AUTHORIZED)

Flow Explanation:

  1. Tokenize payment method - When a customer enters their payment details for the first time, call the Tokenize RPC. The payment processor securely stores the card details and returns a payment_method_token (e.g., Stripe's pm_xxx). Store this token in your customer database for future use.

  2. Authorize with token - For the immediate purchase, call the Payment Service's Authorize RPC with the payment_method_token. This reserves funds on the customer's payment method. The response includes a connector_transaction_id and status AUTHORIZED.

  3. Future purchases - For subsequent purchases, retrieve the stored payment_method_token from your database and call the Payment Service's Authorize RPC with it. The customer does not need to re-enter their payment details, enabling a one-click checkout experience.

Benefits:

  • Faster checkout for returning customers (fewer steps, reduced friction)
  • Reduced cart abandonment rates
  • No PCI compliance overhead for stored payment data
  • Consistent customer experience across devices

Subscription Setup with Stored Payment Method​

Combine Customer Service and Payment Method Service for seamless subscription onboarding.

sequenceDiagram
    participant App as Your App
    participant CS as Connector Service
    participant PP as Payment Provider

    Note over App: New subscription signup
    App->>CS: 1. Create (customer details)
    CS->>PP: Create customer profile
    PP-->>CS: Return connector_customer_id (cus_xxx)
    CS-->>App: Return connector_customer_id
    App->>CS: 2. Tokenize (card + connector_customer_id)
    CS->>PP: Store payment method for customer
    PP-->>CS: Return payment_method_token (pm_xxx)
    CS-->>App: Return payment_method_token
    Note over App: Store tokens for billing
    App->>CS: 3. SetupRecurring (mandate setup)
    CS->>PP: Create recurring payment mandate
    PP-->>CS: Return mandate_reference
    CS-->>App: Return mandate_reference
    App->>CS: 4. Authorize (token + mandate)
    CS->>PP: Charge with stored payment method
    PP-->>CS: Return authorization
    CS-->>App: Return connector_transaction_id (AUTHORIZED)
    App->>CS: 5. Capture
    CS->>PP: Finalize charge
    PP-->>CS: Return capture confirmation
    CS-->>App: Return status: CAPTURED

Flow Explanation:

  1. Create customer - First, call the Customer Service's Create RPC to create a customer profile at the payment processor. This returns a connector_customer_id that links all payment methods and transactions to the customer.

  2. Tokenize payment method - Call the Tokenize RPC with the customer's payment details and the connector_customer_id. The payment processor securely stores the payment method and returns a payment_method_token linked to the customer.

  3. Setup recurring mandate - Call the Payment Service's SetupRecurring RPC to create a payment mandate. This obtains customer consent for future recurring charges and returns a mandate_reference.

  4. Authorize initial payment - Call the Payment Service's Authorize RPC with both the payment_method_token and mandate_reference to charge the initial subscription fee.

  5. Capture payment - Call the Payment Service's Capture RPC to finalize the charge and transfer funds.

Benefits:

  • Seamless subscription signup flow
  • Stored payment credentials for all future billing
  • Mandate-based recurring charges without customer interaction
  • Unified customer profile across all payments

Next Steps​