> ## Documentation Index > Fetch the complete documentation index at: https://docs.tagada.io/llms.txt > Use this file to discover all available pages before exploring further. # Create payment flow > Create a new payment flow (processor orchestration configuration). Requires org:admin role. A payment flow defines: - **strategy**: `simple` (single processor) or `cascade` (fallback chain) - **processorConfigs**: weighted list of processors to route payments through - **fallbackProcessorConfigs**: ordered fallback processors when primary fails - **pickProcessorStrategy**: `weighted`, `lowestCapacity`, or `automatic` - **threeDsEnabled**: whether 3D Secure is enforced - **stickyProcessorEnabled**: reuse last successful processor for returning customers - **abuseDetectionConfig**: optional fraud/velocity rules ## OpenAPI ````yaml /openapi.json post /api/public/v1/payment-flows/create openapi: 3.0.3 info: title: TagadaPay API description: >- # TagadaPay API Documentation Welcome to the TagadaPay API. This REST API lets you process payments, manage subscriptions, handle customers, deploy plugins, and orchestrate checkout funnels — all programmatically. ## Authentication Authenticate every request with a Bearer token. Get your API key from the [TagadaPay Dashboard](https://app.tagada.io). ``` Authorization: Bearer your-api-key ``` All requests must be made over HTTPS with `Content-Type: application/json`. ## Rate Limits | Plan | Requests/min | Burst | |------|-------------|-------| | Standard | 100 | 150 | | Premium | 500 | 750 | Exceeding the limit returns `429 Too Many Requests`. ## Errors | Code | Meaning | |------|---------| | 400 | Bad request — invalid parameters | | 401 | Unauthorized — missing or invalid API key | | 403 | Forbidden — insufficient permissions | | 404 | Not found | | 409 | Conflict | | 429 | Rate limited | | 500 | Server error | ## Support - Email: api-support@tagada.io - Docs: [docs.tagadapay.com](https://docs.tagadapay.com) version: 1.0.0 servers: - url: https://api.tagada.io/ description: Production - url: https://api.tagada.dev/ description: Sandbox / Development security: - bearerAuth: [] tags: - name: auth description: Test your API key and verify authentication. - name: stores description: Create and manage stores within your account. - name: products description: Create products with variants, prices, and currency options. - name: customers description: Manage customer records, addresses, and payment instruments. - name: orders description: List and retrieve orders with line items, payments, and metadata. - name: payments description: Process, list, refund, void, and dispute payments. - name: subscriptions description: >- Create and manage recurring subscriptions — billing, cancellation, rebilling, and processor changes. - name: payment-flows description: Configure payment routing strategies with cascading processor fallbacks. - name: payment-instruments description: >- Manage stored payment methods — cards, bank accounts, and tokenized instruments. - name: processors description: List connected payment processors (Stripe, NMI, Checkout.com, etc.). - name: promotions description: Create and manage discount promotions with rules and conditions. - name: promotion-codes description: Generate and manage reusable promotion/coupon codes. - name: block-rules description: >- Configure fraud prevention rules to block transactions by IP, email, card BIN, country, etc. - name: webhooks description: Register webhook endpoints to receive real-time event notifications. - name: events description: Query application events, statistics, and audit logs. - name: domains description: Add, verify, and manage custom domains for your checkout and funnels. - name: funnels description: >- Create and manage checkout funnels with routing, A/B testing, and CDN deployment. - name: funnel-sessions description: Retrieve funnel session data for analytics and debugging. - name: funnel-tracking description: Track funnel step events for conversion analytics. - name: plugins description: Deploy, manage, and configure checkout plugins. - name: plugins-v2 description: >- V2 plugin system — deploy, mount, split-test, fork, promote, and manage plugin instances. - name: checkout description: >- Initialize checkout sessions and process payments through the hosted checkout. - name: 3ds description: >- 3D Secure authentication — create sessions, authenticate, and handle challenges. - name: builder description: Generate and validate builder session tokens for the visual page editor. - name: health description: API health check endpoint. - name: test description: Test and debugging utilities for the event system (sandbox only). paths: /api/public/v1/payment-flows/create: post: tags: - payment-flows summary: Create payment flow description: >- Create a new payment flow (processor orchestration configuration). Requires org:admin role. A payment flow defines: - **strategy**: `simple` (single processor) or `cascade` (fallback chain) - **processorConfigs**: weighted list of processors to route payments through - **fallbackProcessorConfigs**: ordered fallback processors when primary fails - **pickProcessorStrategy**: `weighted`, `lowestCapacity`, or `automatic` - **threeDsEnabled**: whether 3D Secure is enforced - **stickyProcessorEnabled**: reuse last successful processor for returning customers - **abuseDetectionConfig**: optional fraud/velocity rules operationId: post-api-public-v1-payment-flows-create parameters: [] requestBody: required: true content: application/json: schema: type: object properties: data: type: object properties: name: type: string minLength: 1 strategy: type: string enum: - simple - cascade fallbackMode: type: boolean maxFallbackRetries: type: number threeDsEnabled: type: boolean stickyProcessorEnabled: type: boolean pickProcessorStrategy: type: string enum: - weighted - lowestCapacity - automatic fallbackProcessorConfigs: type: array items: type: object properties: processorId: type: string orderIndex: type: number required: - processorId - orderIndex additionalProperties: false processorConfigs: type: array items: type: object properties: processorId: type: string weight: type: number disabled: type: boolean nonStickable: type: boolean disabledCardBrands: type: array items: type: string required: - processorId - weight - disabled - nonStickable additionalProperties: false abuseDetectionConfig: type: object properties: enabled: type: boolean timeWindowMinutes: type: number minimum: 1 maximum: 120 detectIpAddress: type: boolean detectBin: type: boolean detectEmail: type: boolean ipAddressThreshold: type: number minimum: 1 maximum: 50 binThreshold: type: number minimum: 1 maximum: 100 emailThreshold: type: number minimum: 1 maximum: 50 onlyFailedPayments: type: boolean includeDraftPayments: type: boolean autoBlockTtlHours: type: number minimum: 1 maximum: 8760 autoBlockPermanent: type: boolean required: - enabled - timeWindowMinutes - ipAddressThreshold - binThreshold - emailThreshold - onlyFailedPayments - includeDraftPayments additionalProperties: false nullable: true required: - name - strategy - fallbackMode - maxFallbackRetries - threeDsEnabled - stickyProcessorEnabled - pickProcessorStrategy - fallbackProcessorConfigs - processorConfigs additionalProperties: false required: - data additionalProperties: false examples: simple: summary: Simple single-processor flow value: data: name: Simple Stripe strategy: simple fallbackMode: false maxFallbackRetries: 0 threeDsEnabled: false stickyProcessorEnabled: false pickProcessorStrategy: weighted processorConfigs: - processorId: proc_stripe weight: 100 disabled: false nonStickable: false fallbackProcessorConfigs: [] abuseDetectionConfig: null cascade: summary: Cascade flow with fallback value: data: name: Cascade Stripe → Checkout strategy: cascade fallbackMode: true maxFallbackRetries: 2 threeDsEnabled: true stickyProcessorEnabled: true pickProcessorStrategy: weighted processorConfigs: - processorId: proc_stripe weight: 70 disabled: false nonStickable: false - processorId: proc_checkout weight: 30 disabled: false nonStickable: false fallbackProcessorConfigs: - processorId: proc_checkout orderIndex: 0 abuseDetectionConfig: null responses: '200': description: Successful response content: application/json: schema: {} default: $ref: '#/components/responses/error' security: - bearerAuth: [] components: responses: error: description: Error response content: application/json: schema: type: object properties: message: type: string code: type: string issues: type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'Enter your API key as: `Bearer your-api-key`' ````