Process Auto-Debit Payment
Process automatic debit payments using Stripe payment gateway
Process Auto-Debit Payment
Process automatic debit payments from customer payment methods stored in Stripe. This function charges a customer's saved payment method for a specified amount, making it ideal for recurring payments, subscriptions, or automated billing.
Technical Name: AutoDebitFunc
Properties
- Execution Mode: SYNC
- Type: NATIVE
- Category: System Functions
- Function ID:
a1b2c3d4-e5f6-7890-abcd-ef1234567890
Input Schema
Required Parameters
| Parameter | Type | Description |
|---|---|---|
connectionId | string (uuid) | UUID of the Stripe connection configuration |
customerId | string | Stripe customer ID for the auto-debit transaction |
amount | number | Amount to be debited (in the specified currency) |
currency | string | Currency code for the transaction (e.g., 'USD', 'EUR', 'GBP') |
Optional Parameters
| Parameter | Type | Description |
|---|---|---|
description | string | Optional description for the auto-debit transaction |
[Image placeholder: AutoDebit function configuration panel]
Input Example
{
"connectionId": "stripe-connection-uuid",
"customerId": "cus_1234567890",
"amount": 99.99,
"currency": "USD",
"description": "Monthly subscription payment - January 2024"
}Output Schema
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates whether the auto-debit was processed successfully |
message | string | Response message indicating success or failure details |
customerId | string | Customer ID that was processed |
amount | number | Amount that was processed |
currency | string | Currency of the processed transaction |
Output Example
Success Response
{
"success": true,
"message": "Auto-debit processed successfully",
"customerId": "cus_1234567890",
"amount": 99.99,
"currency": "USD"
}Error Response
{
"success": false,
"message": "Failed to process auto-debit: Insufficient funds",
"customerId": "cus_1234567890",
"amount": 99.99,
"currency": "USD"
}[Image placeholder: Auto-debit output visualization]
Use Cases
Recurring Subscription Payments
Automatically charge customers for monthly subscriptions:
{
"connectionId": "${stripeConnectionId}",
"customerId": "${subscription.customerId}",
"amount": "${subscription.monthlyAmount}",
"currency": "USD",
"description": "Monthly subscription - ${currentMonth}"
}Payment Retry Logic
Retry failed payments with error handling:
Start → FetchFailedPayment → AutoDebit → [If Success] UpdateStatus → [If Failed] LogError → NotifyAdmin → End[Image placeholder: Auto-debit workflow examples]
Stripe Connection Setup
Before using AutoDebit, configure a Stripe connection with your API credentials. The connectionId references this connection configuration.
Customer Requirements
For auto-debit to work, the Stripe customer must have:
- A saved payment method (card, bank account, etc.)
- A valid Stripe customer ID (starts with
cus_) - An active payment method that is not expired
Related Functions
- Call External API - Generic external API integration
- FetchMData - Retrieve customer and subscription data
- EmailNotification - Send payment confirmations