> ## 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. # Process payment > Process a payment using the payment flow system with comprehensive options for different payment scenarios ## OpenAPI ````yaml /openapi.json post /api/public/v1/payments/process 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/payments/process: post: tags: - payments summary: Process payment description: >- Process a payment using the payment flow system with comprehensive options for different payment scenarios operationId: post-api-public-v1-payments-process parameters: [] requestBody: required: true content: application/json: schema: type: object properties: orderId: type: string paymentInstrumentId: type: string mode: type: string enum: - purchase - auth - capture default: purchase amount: type: number exclusiveMinimum: true minimum: 0 currency: type: string storeId: type: string customerId: type: string initiatedBy: type: string enum: - customer - merchant default: customer reasonType: type: string enum: - recurring - unscheduled - installment returnUrl: type: string format: uri draft: type: boolean default: false isRetry: type: boolean default: false threedsSessionId: type: string subscriptionId: type: string paymentFlowId: type: string paymentId: type: string useTagadaVault: type: boolean forceProcessorId: type: string paymentMethod: type: string processorId: type: string isExpress: type: boolean shippingAddress: type: object properties: firstName: type: string lastName: type: string address1: type: string address2: type: string city: type: string state: type: string postal: type: string zip: type: string country: type: string phone: type: string email: type: string additionalProperties: false description: >- Optional — only for physical goods; omit entirely for digital products. When provided, include a valid ISO 3166-1 alpha-2 `country`; an address without one is not forwarded to the acquirer. billingAddress: type: object properties: firstName: type: string lastName: type: string address1: type: string address2: type: string city: type: string state: type: string postal: type: string zip: type: string country: type: string phone: type: string email: type: string additionalProperties: false description: >- Optional but recommended — improves issuer approval rates (AVS) and 3DS frictionless outcomes. When provided, include a valid ISO 3166-1 alpha-2 `country`; an address without one is not forwarded to the acquirer. required: - amount - currency - storeId additionalProperties: false examples: basic: summary: Basic payment processing value: paymentInstrumentId: pi_123 amount: 2999 currency: USD storeId: store_123 customerId: cus_456 mode: purchase subscription: summary: Subscription payment value: paymentInstrumentId: pi_123 amount: 2999 currency: USD storeId: store_123 customerId: cus_456 mode: purchase initiatedBy: merchant reasonType: recurring subscriptionId: sub_123 isRetry: true order: summary: Order payment value: orderId: ord_123 paymentInstrumentId: pi_123 amount: 2999 currency: USD storeId: store_123 customerId: cus_456 mode: purchase returnUrl: https://example.com/return withCustomFlow: summary: Payment with custom flow (for A/B testing, retries, etc.) value: paymentInstrumentId: pi_123 amount: 2999 currency: USD storeId: store_123 customerId: cus_456 mode: purchase paymentFlowId: flow_custom_abc123 redirectApm: summary: >- Redirect APM (Klarna, iDEAL, Bancontact, ...) — no payment instrument needed value: customerId: cus_456 processorId: processor_abc paymentMethod: klarna amount: 2999 currency: EUR storeId: store_123 mode: purchase returnUrl: https://your-site.example/checkout/return responses: '200': description: Successful response content: application/json: schema: {} examples: success: summary: Successful payment processing value: payment: id: pay_123 amount: 2999 currency: USD status: succeeded subStatus: approved requireAction: none 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`' ````