# Payrails Docs > Developer and operator documentation for Payrails, the payment operating system for global enterprises: payment orchestration across providers, PCI-compliant tokenization, analytics and reporting, Chargebacks, and the Payrails REST API. ## Agent Instructions Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code. Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it. Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code. Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation. Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent. Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format. Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code. Append `.md` to any documentation URL to fetch its Markdown source. Every page is listed in https://docs.payrails.com/sitemap.xml, and the full text of the documentation is at https://docs.payrails.com/llms-full.txt ## Start here Entry points into the Payrails documentation. - [Start here: Guides and API reference](https://docs.payrails.com/index.md): Guides, SDKs, and API reference for Payrails: enable payment methods, connect PSPs, and launch checkout on web, iOS, Android, and React… ## Getting Started What Payrails is, and the account, workspace, credential and authentication setup that every integration starts with. - [Getting Started: Explore Payrails](https://docs.payrails.com/docs/explore-payrails.md): Browse the Payrails product suite, from payment orchestration and checkout SDKs to Token Vault, payouts, and analytics. - [Getting Started: Overview](https://docs.payrails.com/docs/overview/index.md): Learn about Payrails' payment operating system for high-growth businesses. - [Overview: Workflows](https://docs.payrails.com/docs/overview/workflows.md): Configure your first workflow - [Overview: Checkout](https://docs.payrails.com/docs/overview/checkout.md): With Payrails' checkout solutions, you can seamlessly accept payments through various methods, including credit cards, digital wallets, and… - [Overview: Dynamic Routing](https://docs.payrails.com/docs/overview/routing.md): Payrails offers a powerful and flexible feature called routing as part of its payment orchestration platform, enabling merchants to… - [Overview: Payment Options](https://docs.payrails.com/docs/overview/payment-options.md): Payment options are the ways in which your customers can choose to pay for your goods and services. - [Overview: Token Vault](https://docs.payrails.com/docs/overview/vault.md): Tokenize any sensitive data, store in a PCI-certified environment and used stored tokens, as a standalone module or within your… - [Getting Started: Set up your Payrails account and environment](https://docs.payrails.com/docs/account-setup/index.md): Set up the account foundations every Payrails module shares: API credentials and mTLS, users and roles, and workspaces. - [Set up your Payrails account and environment: API Credentials](https://docs.payrails.com/docs/account-setup/api-credentials.md): Create and manage the client ID and client secret that authenticate your Payrails API calls, scoped per environment and workspace. - [Set up your Payrails account and environment: mTLS Configuration](https://docs.payrails.com/docs/account-setup/mtls-configuration.md): Learn how to set up a secure connection with Payrails through mTLS. - [Set up your Payrails account and environment: User Management](https://docs.payrails.com/docs/account-setup/user-management/index.md): Learn about user authentication, roles and permissions, and how to manage lifecycle of users. - [User Management: Authentication](https://docs.payrails.com/docs/account-setup/user-management/authentication.md): Learn more about possible alternative authentication methods. - [User Management: Roles & Permissions](https://docs.payrails.com/docs/account-setup/user-management/roles-permissions.md): Find all assigned roles and permissions for each API service. - [User Management: Frequently Asked Questions](https://docs.payrails.com/docs/account-setup/user-management/frequently-asked-questions.md): Learn answers to frequently asked questions. - [User Management: Single Sign-On](https://docs.payrails.com/docs/account-setup/user-management/single-sign-on.md): How to configure and maintain SAML SSO in Payrails using your organization's identity provider. - [Set up your Payrails account and environment: Organization](https://docs.payrails.com/docs/account-setup/organization.md): Your organization with unified view across all your workspaces, ensuring streamlined access and management. - [Set up your Payrails account and environment: Workspaces](https://docs.payrails.com/docs/account-setup/workspaces.md): Learn about workspaces which helps to create segregated and separately managed spaces within your organization. - [Set up your Payrails account and environment: Idempotent Requests](https://docs.payrails.com/docs/account-setup/idempotent-requests.md): Use the X-Idempotency-Key header to retry a Payrails API request safely, without creating duplicate records or repeating an update. ## Payment Orchestration Accept payments across providers: checkout SDKs for web, iOS, Android and React Native, provider integrations, payment methods, workflow configuration, and the payment lifecycle (authorize, capture, cancel, refund, 3DS, notifications). - [Payment Orchestration: Getting Started](https://docs.payrails.com/docs/orchestration/getting-started.md): Compare the Drop-in, Elements, Secure Fields, and API-only integration paths, and pick the one that matches your PCI scope. - [Payment Orchestration: Payrails Checkout SDKs](https://docs.payrails.com/docs/orchestration/checkout-sdks/index.md): Compare the three Payrails SDK integration levels, Drop-in, Elements, and Secure Fields, across web, iOS, Android, and React Native. - [Payrails Checkout SDKs: Web SDK - Quick Start](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/index.md): Install the Payrails web SDK, initialize a client from your server's init payload, and mount a working checkout on your page. - [Guides: How to customize the checkout's appearance](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/guides/how-to-customize-the-checkouts-appearance.md): Style the card form, payment buttons, drop-in, and collect elements with the appearance option, and load custom fonts. - [Guides: How to accept card payments](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/guides/how-to-accept-card-payments.md): Mount a PCI-compliant card form with the Payrails web SDK, wire it to a payment button, and handle the authorization result. - [Guides: How to add Apple Pay and Google Pay](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/guides/how-to-add-apple-pay-and-google-pay.md): Check wallet availability, mount the Apple Pay and Google Pay buttons, and handle payment results and express-checkout address changes. - [Guides: How to collect card data with secure fields (collect container)](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/guides/how-to-collect-card-data-with-secure-fields-collect-container.md): Build your own card form field by field with a collect container, validate the secure inputs, and collect an encrypted payload. - [Guides: Using actionRequired event](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/guides/action-required-event.md): Intercept the actionRequired event to control how your app presents a 3D Secure challenge or a payment-method redirect. - [v6 Migration Guide for Humans](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/v6-migration/v6-migration-guide.md): Upgrade the Payrails web SDK from 5.x to 6.x, with every breaking change, before-and-after code for each one, and how to verify the result. - [v6 Migration Guide: Agent Runbook - v6 Migration](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/v6-migration/agent-runbook-v6-migration.md): A runbook for an AI coding agent migrating a codebase from Payrails web SDK 5.x to 6.x: detect, route, execute, and verify. - [References: Event API Reference](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/references/event-api-reference.md): Reference for the web SDK event API: every instance event and element event, the payload each one carries, and when it fires. - [References: Appearance API reference](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/references/appearance-api-reference.md): Reference for the web SDK appearance option: option types, rule semantics, and the CSS classes and state modifiers on the DOM. - [References: Payrails API Reference](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/references/payrails-api-reference.md): Reference for the Payrails class and package exports of the web SDK: initialization, element factories, and payment session data. - [Payrails Checkout SDKs: Payrails Web Fraud SDK](https://docs.payrails.com/docs/orchestration/checkout-sdks/payrails-web-fraud-sdk.md): Initialize the Payrails fraud SDK to collect device signals from several fraud providers behind one interface, for the web SDK. - [Payrails Checkout SDKs: Accept payments via API](https://docs.payrails.com/docs/orchestration/checkout-sdks/accept-payments-via-api.md): Build your own checkout on the Payrails API, using Secure Fields or client-side encryption to tokenize card data. - [Payrails Checkout SDKs: iOS SDK - Quick start](https://docs.payrails.com/docs/orchestration/checkout-sdks/ios/index.md): Install the Payrails iOS SDK with Swift Package Manager, create a session, and render a working card payment screen. - [iOS SDK - Quick start: SDK Concepts](https://docs.payrails.com/docs/orchestration/checkout-sdks/ios/sdk-concepts.md): This page explains the mental model behind the Payrails iOS SDK so you can reason about integration decisions confidently. - [iOS SDK - Quick start: SDK API Reference](https://docs.payrails.com/docs/orchestration/checkout-sdks/ios/sdk-api-reference.md): Reference for the Payrails iOS SDK: installation, the init payload, session creation, card form and button components, and delegates. - [iOS SDK - Quick start: Styling Guide](https://docs.payrails.com/docs/orchestration/checkout-sdks/ios/styling-guide.md): Style the iOS SDK card form, inputs, labels, error text, and payment buttons, including field variants and layout presets. - [iOS SDK - Quick start: Troubleshooting ](https://docs.payrails.com/docs/orchestration/checkout-sdks/ios/troubleshooting.md): Common issues and how to fix them. - [Payrails Checkout SDKs: React Native SDK](https://docs.payrails.com/docs/orchestration/checkout-sdks/react-native/index.md): The Payrails React Native SDK provides pre-built payment components for accepting payments in mobile apps. - [React Native SDK: How to Integrate](https://docs.payrails.com/docs/orchestration/checkout-sdks/react-native/how-to-integrate.md): How to integrate Drop-in and use different Elements. - [React Native SDK: SDK Concepts](https://docs.payrails.com/docs/orchestration/checkout-sdks/react-native/sdk-concepts.md): How the Payrails React Native Drop-in works, and which parts of an integration run on your server, in your app, and over webhooks. - [React Native SDK: API References](https://docs.payrails.com/docs/orchestration/checkout-sdks/react-native/api-references.md): Reference for the PayrailsDropin React Native component: every property, callback, and configuration object, with types and defaults. - [Payrails Checkout SDKs: Android SDK - Quick Start](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/index.md): This tutorial walks you through integrating the Payrails Android SDK from scratch. - [Android SDK - Quick Start: How to Accept PayPal Payments](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/how-to-accept-paypal-payments.md): Accept PayPal payments in your Android app using PayPalButton. - [Android SDK - Quick Start: How to Accept Redirect Payments](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/how-to-accept-redirect-payments.md): Accept payments through redirect-based payment methods (iDEAL, Bancontact, Sofort, etc.) using the Payrails SDK. - [Android SDK - Quick Start: How to Let Shoppers Choose a Card Network (Co-Branded Cards)](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/how-to-co-branded-cards.md): Let shoppers choose which network processes a co-branded card in the Android SDK, and submit that choice with the payment. - [Android SDK - Quick Start: How to Build a Custom Pay Button (Your Own UI)](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/how-to-custom-pay-button.md): Drive checkout from your own Android button while the SDK handles the Google Pay sheet, the 3D Secure and redirect tabs, and polling. - [Android SDK - Quick Start: How to Run a Payment Without an SDK Button (Headless)](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/how-to-execute-payment-headless.md): Run a payment from your own Android UI with PayrailsPaymentLauncher, without rendering a prebuilt SDK button component. - [Android SDK - Quick Start: Query Session Data](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/how-to-query-session-data-at-runtime.md): Read session information — such as the current amount, execution ID, or payment method configuration — from a Payrails Session at any point… - [Android SDK - Quick Start: How to Tokenize a Card Without Charging It](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/how-to-tokenize-card.md): Save a card to the Payrails vault for future use without initiating a payment. - [Android SDK - Quick Start: SDK API Reference](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/api-reference.md): Public API of the Payrails Android SDK — payment methods, configuration, styling, translations and event delegates. - [Android SDK - Quick Start: SDK Concepts](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/sdk-concepts.md): This page explains why the Payrails Android SDK is designed the way it is. - [Android SDK - Quick Start: Styling Guide](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/styling-guide.md): This guide shows how to customize the appearance of Payrails SDK components to match your brand. - [Android SDK - Quick Start: Troubleshooting](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/troubleshooting.md): Common issues and their solutions when integrating the Payrails Android SDK. - [Android SDK - Quick Start: Update Checkout Amount](https://docs.payrails.com/docs/orchestration/checkout-sdks/android/update-checkout-amount.md): Change the checkout amount and currency at runtime in the Android SDK, for a tip, a discount code, or shipping added after address entry. - [Payment Orchestration: Integrations](https://docs.payrails.com/docs/orchestration/integrations/index.md): Connect at least one payment service provider to Payrails before you accept payments, and find the setup guide for each supported provider. - [Integrations: Adyen](https://docs.payrails.com/docs/orchestration/integrations/adyen.md): Connect an Adyen account to Payrails: create the integration, configure API credentials and webhooks, and enable raw card data processing. - [Integrations: Braintree (Paypal)](https://docs.payrails.com/docs/orchestration/integrations/braintree.md): Connect a Braintree account to Payrails: create the integration, configure credentials and webhooks, and enable raw card data processing. - [Integrations: Checkout.com](https://docs.payrails.com/docs/orchestration/integrations/checkout-com.md): Connect a Checkout.com account to Payrails: create the integration, configure API keys and webhooks, and enable raw card data processing. - [Integrations: PayPal](https://docs.payrails.com/docs/orchestration/integrations/paypal.md): Connect a PayPal account to Payrails by authorizing Payrails as a third-party app in PayPal, then scope the integration to workspaces. - [Integrations: Stripe](https://docs.payrails.com/docs/orchestration/integrations/stripe.md): Connect a Stripe account to Payrails with one-click onboarding, then configure statement descriptors and embedded SEPA Direct Debit. - [Set up payment methods](https://docs.payrails.com/docs/orchestration/payment-methods/set-up-payment-methods.md): Payrails is designed to simplify and streamline the process of offering multiple payment methods in your online checkout. - [Payment Methods: Cards](https://docs.payrails.com/docs/orchestration/payment-methods/cards/index.md): What you need in place to accept card payments through Payrails, from provider configuration to the integration that collects card data. - [Co-branded cards](https://docs.payrails.com/docs/orchestration/payment-methods/cards/co-branded-cards.md): How Payrails detects a co-branded card from its BIN, shows both networks with equal weight, and routes over the one the cardholder picks. - [Payment Methods: Apple Pay](https://docs.payrails.com/docs/orchestration/payment-methods/apple-pay.md): Allow customers to securely make payments using Apple Pay - [Payment Methods: Google Pay](https://docs.payrails.com/docs/orchestration/payment-methods/google-pay.md): Google Pay is a mobile payment and digital wallet service. - [Payment Methods: PayPal](https://docs.payrails.com/docs/orchestration/payment-methods/paypal/index.md): PayPal is an alternative payment method around the globe. - [Payment Methods: Pix](https://docs.payrails.com/docs/orchestration/payment-methods/pix.md): Pix is an alternative payment method in Brazil. - [Payment Methods: iDEAL](https://docs.payrails.com/docs/orchestration/payment-methods/ideal.md): iDEAL is the Netherlands' leading online payment method, enabling direct bank transfers through a familiar and trusted interface. - [Payment Methods: Boleto](https://docs.payrails.com/docs/orchestration/payment-methods/boleto.md): Boleto is one of Brazil's most widely used payment methods, allowing customers to pay for online purchases either over the counter at any… - [Payment Methods: Klarna](https://docs.payrails.com/docs/orchestration/payment-methods/klarna.md): Klarna is a global buy now, pay later (BNPL) payment method available across a large number of countries in Europe, North America, and… - [Workflow Studio Overview](https://docs.payrails.com/docs/orchestration/workflow-studio/overview.md): How Workflow Studio models a payment process as a visual workflow, and what triggers, actions, outcomes, and conditions do on the canvas. - [Workflow Studio: Quick Start Guide](https://docs.payrails.com/docs/orchestration/workflow-studio/quick-start.md): Build your first authorization workflow in Workflow Studio, from trigger to notification, handling every outcome it produces. - [Workflow Studio: Triggers](https://docs.payrails.com/docs/orchestration/workflow-studio/triggers.md): Compare the API triggers and event triggers that start a workflow, and see what data each one makes available to later steps. - [Workflow Studio: Actions](https://docs.payrails.com/docs/orchestration/workflow-studio/actions.md): See which Workflow Studio action maps to each payment operation, and how the outcomes of an action branch the canvas. - [Workflow Studio: Conditions and Branching](https://docs.payrails.com/docs/orchestration/workflow-studio/conditions/index.md): Route a workflow down different paths with condition steps, define the rules on each branch, and handle the case where none match. - [Conditions and Branching: Condition Operators Reference](https://docs.payrails.com/docs/orchestration/workflow-studio/conditions/operators.md): Every operator available in a Workflow Studio condition rule, grouped by category, with the comparison it performs and a sample use case. - [Workflow Studio: Monitoring Workflow Executions](https://docs.payrails.com/docs/orchestration/workflow-studio/monitoring/index.md): Track workflow runs in the Workflow Studio execution monitor: find an execution, inspect its steps, and debug a failure. - [Monitoring Workflow Executions: Status Codes Reference](https://docs.payrails.com/docs/orchestration/workflow-studio/monitoring/status-codes.md): Reference for all 29 workflow execution status codes, grouped by severity, with the state each one represents. - [Workflow Studio: Workflow Examples](https://docs.payrails.com/docs/orchestration/workflow-studio/examples/index.md): Ready-to-use workflow configurations for common payment scenarios, each with build instructions and a trigger-to-notify diagram. - [Workflow Studio: Glossary](https://docs.payrails.com/docs/orchestration/workflow-studio/glossary.md): Definitions of the Workflow Studio terms used across these guides: workflow, trigger, action, outcome, condition, and execution. - [Payment Acceptance: Create a workflow execution](https://docs.payrails.com/docs/orchestration/payment-acceptance/create-a-workflow-execution.md): Create an execution of the payment-acceptance workflow through the Payrails API, the first call in every payment. - [Payment Acceptance: Lookup payment options](https://docs.payrails.com/docs/orchestration/payment-acceptance/lookup-payment-options.md): Call the lookup endpoint to resolve which payment methods and instruments to present, from the rules you set in the Payrails Portal. - [Payment Acceptance: Authorize a payment](https://docs.payrails.com/docs/orchestration/payment-acceptance/authorize-a-payment.md): Authorize a payment on an existing workflow execution, and receive the outcome through a notification or by polling the execution. - [Payment Acceptance: Capture a payment](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-a-payment.md): Capture an authorized payment through the Payrails API or Portal, in full or in part, or set a delay instead of automatic capture. - [Payment Acceptance: Cancel a payment](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md): Cancel a payment with one call: Payrails voids an uncaptured authorization, or refunds the amount after a capture. - [Payment Acceptance: Refund a payment](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md): Refund a captured payment in full or in part through the Payrails API or the Portal, including several partial refunds on the same payment. - [Payment Acceptance: Test payments](https://docs.payrails.com/docs/orchestration/payment-acceptance/test-payments.md): Simulate payments in the Payrails Portal to verify provider configurations, dynamic payment options, and notification handling. - [Payment Acceptance: Receive notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md): Set up webhook endpoints to receive the outcome of asynchronous Payrails actions such as authorize, capture, cancel, and refund. - [Payment Acceptance: 3D Secure](https://docs.payrails.com/docs/orchestration/payment-acceptance/3d-secure.md): Handle a 3D Secure challenge inside a Payrails authorization: the two redirect patterns, the threeDS response object, and the result. - [Payment Orchestration: In-person payments](https://docs.payrails.com/docs/orchestration/in-person.md): Turn an Android point-of-sale device into a contactless terminal for cards, Apple Pay, Google Pay, and AliPay QR through one integration. - [Payment Orchestration: How to Gate Payment Authorization](https://docs.payrails.com/docs/orchestration/how-to-gate-payment-authorization.md): Use onRequestStart to have your backend approve or refuse a payment before Payrails authorizes it. - [Payment Orchestration: Payment Links](https://docs.payrails.com/docs/orchestration/payment-links/index.md): Collect payments outside your checkout with a secure, Payrails-hosted payment page. - [Payment Links: Create a payment link](https://docs.payrails.com/docs/orchestration/payment-links/create-a-payment-link.md): Create a link from your backend, or from the Portal without writing code. - [Payment Links: How it works](https://docs.payrails.com/docs/orchestration/payment-links/how-it-works.md): The lifecycle of a Payment Link, the objects behind it, and who is responsible for what. - [Payment Links: Payment modes](https://docs.payrails.com/docs/orchestration/payment-links/payment-modes.md): Choose between a single payment and multiple partial payments against one link. - [Payment Links: Share the link](https://docs.payrails.com/docs/orchestration/payment-links/share-the-link.md): How to distribute a link, and what your customer sees when they open it. - [Payment Links: Track and reconcile](https://docs.payrails.com/docs/orchestration/payment-links/track-and-reconcile.md): Confirm payment outcomes, keep your systems in sync, and handle failures correctly. - Local and alternative payment methods (56 more): Guides for 56 further local payment methods — wallets, bank transfers, cash and voucher schemes, BNPL and QR payments across LATAM, APAC, EMEA and Africa. Each is published under /docs/orchestration/payment-methods/ and listed in sitemap.xml. - Further provider integrations (14 more): Configuration guides for 14 further payment providers, published under /docs/orchestration/integrations/. - Worked workflow examples (8 examples): 8 end-to-end workflow configurations covering authorization, fraud screening, 3DS, capture, refunds and provider routing. - [Web SDK v5 (5 pages, legacy)](https://docs.payrails.com/docs/orchestration/checkout-sdks/web-v5-legacy/secure-fields.md): (Legacy) Documentation for the previous generation of the web SDK. Do not use for new integrations — use Web SDK v6 and the v6 migration guide. ## Token Vault PCI-compliant tokenization as a standalone module or inside orchestration: proxies, card tokenization and display SDKs, network tokens, and migration from other vaults. - [Token Vault: Getting Started](https://docs.payrails.com/docs/token-vault/getting-started.md): In this section, you will learn how to use Vault as a standalone module, about our proxies, tokenization and detokenization methods. - [Token Vault: Vault Proxy](https://docs.payrails.com/docs/token-vault/vault-proxy/index.md): Learn about our proxy solutions to choose the best approach for your use cases. - [Vault Proxy: Instant Proxy](https://docs.payrails.com/docs/token-vault/vault-proxy/proxy-payment-instruments/index.md): No prior configuration, fast and simple proxy with payment providers. - [Instant Proxy: Cards via Proxy](https://docs.payrails.com/docs/token-vault/vault-proxy/proxy-payment-instruments/cards-via-proxy.md): Learn how to send instant proxy requests for payments with cards. - [Instant Proxy: Apple Pay via Proxy](https://docs.payrails.com/docs/token-vault/vault-proxy/proxy-payment-instruments/apple-pay-via-proxy.md): Learn your options to tokenize Apple Pay instruments and how to use them in proxy flow. - [Instant Proxy: Google Pay via Proxy](https://docs.payrails.com/docs/token-vault/vault-proxy/proxy-payment-instruments/google-pay-via-proxy.md): Learn your options to tokenize Google Pay instruments and how to use them in different flows. - [Vault Proxy: Configurable Proxy](https://docs.payrails.com/docs/token-vault/vault-proxy/proxy-connections/index.md): Highly configurable proxy to work with any inbound and outbound connection to any third party. - [Configurable Proxy: Managing Connections](https://docs.payrails.com/docs/token-vault/vault-proxy/proxy-connections/managing-connections.md): Learn how to configure and activate inbound and outbound connections. - [Configurable Proxy: Invoking Connections](https://docs.payrails.com/docs/token-vault/vault-proxy/proxy-connections/invoking-connections.md): Learn how to invoke inbound and outbound connections that are created in the previous step. - [Token Vault: Records, Aliases and Instruments](https://docs.payrails.com/docs/token-vault/tokenize-records.md): Learn about the concept of records, aliases and fields. - [Token Vault: Tokenize Cards via SDK](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/index.md): Compare the Payrails tokenization methods, Secure Fields, client-side encryption, and API-only, by PCI DSS scope and effort. - [Tokenize Cards via SDK: Tokenize cards with Secure Fields](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/tokenize-cards-with-secure-fields.md): Collect card data in Payrails-hosted iframe fields and exchange it for a token, keeping cardholder data out of your own front end. - [Tokenize Cards via SDK: Tokenize cards with Client-side Encryption](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/tokenize-cards-with-client-side-encryption.md): Encrypt card details in your own checkout form and send them to Payrails to create a payment instrument token. - [Tokenize Cards via SDK: Tokenize cards with API-only](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/tokenize-cards-with-api-only.md): Send raw card details to the Payrails vault over the API for full control of card collection, at the widest PCI DSS scope. - [Token Vault: Display Cards via SDK](https://docs.payrails.com/docs/token-vault/display-sdk/index.md): Display tokenized card data securely in your frontend—with a customizable, easy to integrate, and fully compliant SDK. - [Display Cards via SDK: Dynamic Styling Based on BIN](https://docs.payrails.com/docs/token-vault/display-sdk/dynamic-styling-based-on-bin.md): Use case where the styling of the elements and how card information is shown are based on the BIN (ie. - [Token Vault: Network Tokens](https://docs.payrails.com/docs/token-vault/network-tokens/index.md): Learn the benefits of using network tokenization with Payrails as well as how to implement for more secure, efficient, and seamless… - [Network Tokens: Onboarding to Networks](https://docs.payrails.com/docs/token-vault/network-tokens/onboarding-to-networks.md): Learn how to get onboarded to networks as a Token Requestor to start provisioning network tokens. - [Provision Network Tokens](https://docs.payrails.com/docs/token-vault/network-tokens/provision-network-tokens.md): Learn how to provision network tokens to leverage its benefits in the most optimized way. - [Transacting with Network Tokens](https://docs.payrails.com/docs/token-vault/network-tokens/transacting-with-network-tokens.md): Learn how to use network tokens and cryptograms in payment transactions. - [Network Tokens: Automatic Lifecycle Updates](https://docs.payrails.com/docs/token-vault/network-tokens/automatic-lifecycle-updates.md): Learn the details of lifecycle update events and how they are automatically managed in Payrails Vault. - [Token Vault: Token Migration](https://docs.payrails.com/docs/token-vault/token-migration/index.md): Import tokens from other vault providers into Payrails securely while maintaining PCI DSS compliance. - [Token Migration: Self-served migration of card data from PSPs](https://docs.payrails.com/docs/token-vault/token-migration/self-serve-migration.md): Migrate your card from PSPs to Payrails at any point in time using autonomous self-serve approach. - [Token Vault: Frequently Asked Questions](https://docs.payrails.com/docs/token-vault/frequently-asked-questions.md): Find answers to common questions about how Payrails Vault helps you securely store, manage, and use sensitive payment data. ## Analytics & Reporting Connect payment providers as data sources and export reports on payments, settlements, transactions and disputes, through the Portal or the API. - [Analytics & Reporting: Getting started](https://docs.payrails.com/docs/analytics-and-reporting/getting-started/index.md): Connect your payment providers and data sources to start reporting in Payrails. - [Getting Started: Connect your data sources](https://docs.payrails.com/docs/analytics-and-reporting/getting-started/connect-your-data-sources/index.md): Add your payment providers as data sources in the Payrails Portal to power analytics, reporting, and fee monitoring. - [Analytics & Reporting: Upload files](https://docs.payrails.com/docs/analytics-and-reporting/upload-files/index.md): Send your own files to Payrails through the file upload API or the Portal, to extend the analytics data set and feed reconciliation. - [Upload Files: Orders Report](https://docs.payrails.com/docs/analytics-and-reporting/upload-files/orders-report.md): The CSV format for an orders file upload, with the required and optional fields, their types, and an example value for each column. - [Analytics & Reporting: Reports](https://docs.payrails.com/docs/analytics-and-reporting/reports/index.md): Export financial and performance data from Payrails as CSV files, either through the Portal or via API. - [Reports: Payments report](https://docs.payrails.com/docs/analytics-and-reporting/reports/payments.md): A standardized view of authorization health across providers, covering success rates, failure reasons, 3D Secure status, and tokens. - [Reports: Settlements report](https://docs.payrails.com/docs/analytics-and-reporting/reports/settlements.md): A unified view of the transaction lifecycle and fees across providers, covering settlement amount, FX rate, and fee type. - [Reports: Transactions report](https://docs.payrails.com/docs/analytics-and-reporting/reports/transactions.md): A transaction-level report for reconciling individual payments, with a downloadable CSV sample and a definition of every column. - [Reports: Disputes report](https://docs.payrails.com/docs/analytics-and-reporting/reports/disputes.md): Details on all customer-disputed transactions, including chargeback status, reason codes, and the linked original transaction. - [Analytics & Reporting: Unified Analytics](https://docs.payrails.com/docs/analytics-and-reporting/unified-analytics.md): The Payrails analytics dashboards centralize payment data from every provider into one view of authorization rates and cost. - [Analytics & Reporting: Dashboards](https://docs.payrails.com/docs/analytics-and-reporting/dashboards.md): Filter a Payrails analytics dashboard, save the filter state as a custom view, and set a default view for each time you open it. - Provider-specific data source setup (15 providers): Instructions for connecting 15 individual payment providers as reporting data sources. ## Fraud Management Fraud screening inside the authorization flow. - [Fraud Management: Fraud Score](https://docs.payrails.com/docs/fraud-management/fraud-score.md): This document explains how you can request a Fraud Score/Check action to be performed within the authorization flow. ## Chargebacks Dispute and chargeback handling, and the provider integrations that feed it. - [Chargebacks: Getting started](https://docs.payrails.com/docs/chargebacks/getting-started.md): How Payrails abstracts provider-specific dispute logic into one chargeback lifecycle that works the same across every integration. - [Chargebacks: Integrations](https://docs.payrails.com/docs/chargebacks/integrations/index.md): Connect dispute service providers to Payrails to process chargebacks, and find the setup guide for each supported dispute integration. - Further provider integrations (5 providers): Dispute integration setup for 5 individual providers. ## Monitoring Alerting on payment performance. - [Monitoring: Alerts](https://docs.payrails.com/docs/monitoring/configure-alerts.md): Stop checking the dashboard every hour. Let Payrails tell you when something dips. ## Resources Reference data: payment statuses, operation types and results, executions, holders, instruments, notification payloads, error codes and currency codes. - [Resources: Payments](https://docs.payrails.com/docs/resources/payments/index.md): Reference payment statuses, operation types, operation results, and authorization flags. - [Payments: Payment Status](https://docs.payrails.com/docs/resources/payments/payment-status.md): Reference the payment lifecycle statuses used across Payrails flows. - [Payments: Operation Types](https://docs.payrails.com/docs/resources/payments/operation-types.md): Review Payrails operation types and how they map to payment actions. - [Payments: Operation Results](https://docs.payrails.com/docs/resources/payments/operation-results.md): Understand operation result values returned by Payrails payment operations. - [Payments: Authorization flags](https://docs.payrails.com/docs/resources/payments/authorization-flags.md): Optional optimization parameters for improving your authorization rates. - [Resources: Executions](https://docs.payrails.com/docs/resources/executions.md): View your workflow executions and related payments and events - [Resources: Holders](https://docs.payrails.com/docs/resources/holder.md): Learn what holders are in Payrails and how they relate to instruments, tokens, and accounts. - [Resources: Payment Instruments and Tokens](https://docs.payrails.com/docs/resources/manage-instruments.md): Manage payment instruments and token relationships for holders in Payrails. - [Resources: Notifications](https://docs.payrails.com/docs/resources/notifications/index.md): This page describes how our Notifications work and what they include. - [Dispute notifications](https://docs.payrails.com/docs/resources/notifications/dispute-notifications.md): Understand dispute notification payloads and when each event is sent. - [Resources: Error codes](https://docs.payrails.com/docs/resources/error-codes.md): The full list of Payrails error codes and how to resolve them. - [Resources: Currency codes](https://docs.payrails.com/docs/resources/currency-codes.md): Look up the ISO 4217 currency codes Payrails supports. ## Use Cases Reference architectures for common integration shapes. - [Use Cases: Billing](https://docs.payrails.com/docs/use-cases/billing-use-cases.md): Use Payrails to collect and charge payment methods while your billing engine owns subscriptions, invoices, and dunning. - [Use Cases: Server-to-server Integration](https://docs.payrails.com/docs/use-cases/server-to-server-integration-reference-architecture.md): Build a backend-driven Payrails integration that tokenizes on the frontend and your server controls the authorization steps, and… ## API reference The Payrails REST API. - [API reference: Getting started](https://docs.payrails.com/reference/index.md): Entry point for the Payrails API reference, covering authentication, request and response formats, error handling, and the endpoint list. ## OpenAPI specification - [Payrails OpenAPI spec](https://cdn.payrails.io/docs/api/openapi.min.json): Machine-readable definition of every Payrails REST endpoint, including schemas, parameters and examples. ## Optional - [Payrails website](https://www.payrails.com): Product, platform and company overview. - [Website llms.txt](https://www.payrails.com/llms.txt): Index of Payrails marketing and company pages. - [Blog](https://www.payrails.com/blog): Payment strategy, product updates and engineering deep dives. - [GitHub](https://github.com/payrails): Payrails SDKs and open-source repositories. - [Contact](https://www.payrails.com/contact): Request a demo or reach the Payrails team.