For AI agents: visit https://docs.payrails.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Payrails Merchant Documentation
HomeGuidesAPI Reference
Go to payrails.comPayrails Merchant Documentation
Guides
Go to payrails.com
HomeGuidesAPI Reference

Getting Started

  • Explore Payrails
  • Overview
    • Workflows
    • Checkout
    • Dynamic Routing
    • Payment Options
    • Token Vault
  • Set up your Payrails account and environment
    • API Credentials
    • mTLS Configuration
    • User Management
      • Authentication
      • Roles & Permissions
      • Frequently Asked Questions
      • Single Sign-On
    • Organization
    • Workspaces
    • Idempotent Requests

Payment Orchestration

  • Getting Started
  • Payrails Checkout SDKs
    • Web SDK - Quick Start
      • Guides
        • How to customize the checkout's appearance
        • How to accept card payments
        • How to add Apple Pay and Google Pay
        • How to collect card data with secure fields (collect container)
        • Using actionRequired event
      • v6 Migration Guide
        • v6 Migration Guide for Humans
        • Agent Runbook - v6 Migration
      • References
        • Event API Reference
        • Appearance API reference
        • Payrails API Reference
    • Payrails Web Fraud SDK
    • Accept payments via API
    • IOS SDK - Quick start
      • SDK Concepts
      • SDK API Reference
      • Styling Guide
      • Troubleshooting
    • React Native SDK
      • How to Integrate
      • SDK Concepts
      • API References
    • Android SDK - Quick Start
      • How to Accept PayPal Payments
      • How to Accept Redirect Payments
      • How to Let Shoppers Choose a Card Network (Co-Branded Cards)
      • How to Build a Custom Pay Button (Your Own UI)
      • How to Run a Payment Without an SDK Button (Headless)
      • Query Session Data
      • How to Tokenize a Card Without Charging It
      • SDK API Reference
      • SDK Concepts
      • Styling Guide
      • Troubleshooting
      • Update Checkout Amount
    • Web SDK - V5 (legacy)
      • Secure Fields
      • Elements
      • Drop-in
      • SDK Events Glossary
      • Headless Integration using SDK
  • Integrations
    • Adyen
    • Amazon
    • Braintree (Paypal)
    • Checkout.com
    • dLocal
    • Klarna
    • Stripe
    • Tabby
    • Unzer
  • Payment Methods
    • Set up payment methods
    • Cards
      • Co Branded Cards
    • 1Voucher
    • Alfa (Bank Alfalah)
    • Apple Pay
    • Alipay
    • Amazon Pay
    • Bank Transfers
    • CashFree Wallets
    • EasyPaisa
    • EFT Pro
    • FawryPay
    • Google Pay
    • JazzCash
    • Konnect
    • Mercado Pago
    • Mobile Wallets
    • Direct Carrier Billing
    • Mono
    • NetBanking
    • Nigeria Inter-Bank Settlement System (NIBSS)
    • Opay
    • Paga Wallet
    • Payflex
    • PayJustNow
    • PayPal
      • PayPal Express Flow
    • PayTM
    • Pix
    • UPI
    • WafaCash
    • KakaoPay
    • iDEAL
    • Boleto
    • PicPay
    • Maya
    • Ovo
    • TrueMoney
    • Napas
    • PSE
    • PagoEfectivo
    • Nequi
    • GrabPay
    • DuitNow QR
    • ShopeePay
    • GCash
    • Touch 'n Go
    • Konbini
    • VietQR
    • MoMo
    • QRIS
    • PromptPay
    • SPEI
    • OXXO
    • MB Way
    • PAYCO
    • Korean Local Cards
    • MobilePay
    • Multibanco
    • BLIK
    • Bancontact
    • Klarna
  • Workflow Studio
    • Workflow Studio Overview
    • Quick Start Guide
    • Triggers
    • Actions
    • Conditions and Branching
      • Condition Operators Reference
    • Monitoring Workflow Executions
      • Status Codes Reference
    • Workflow Examples
      • Simple Authorization
      • Authorization with Fraud Screening
      • Authorization with 3D Secure
      • Full Authorization with Fraud and 3DS
      • Capture with Fraud Update
      • Conditional Refund
      • Event-Driven Auto-Capture
      • Provider Routing with Conditions
    • Glossary
  • Payment Acceptance
    • Create a workflow execution
    • Lookup payment options
    • Authorize a payment
    • Capture a payment
    • Cancel a payment
    • Refund a payment
    • Test payments
    • Receive notifications
    • 3D Secure
  • In-person Payments

Token Vault

  • Getting Started
  • Vault Proxy
    • Instant Proxy
      • Apple Pay via Proxy
      • Google Pay via Proxy
    • Configurable Proxy
      • Managing Connections
      • Invoking Connections
  • Records, Aliases and Instruments
  • Tokenize Cards via SDK
    • Tokenize cards with Secure Fields
    • Tokenize cards with Client-side Encryption
    • Tokenize cards with API-only
  • Display Cards via SDK
    • Dynamic Styling Based on BIN
  • Network Tokens
    • Onboarding to Networks
    • Provision Network Tokens
    • Transacting with Network Tokens
    • Automatic Lifecycle Updates
  • Token Migration
    • Self-served migration of card data from PSPs
  • Frequently Asked Questions

Analytics & Reporting

  • Getting Started
    • Connect your data sources
      • Adyen
      • Amex
      • Braintree
      • Checkout
      • J.P. Morgan
      • Klarna
      • MangoPay
      • PayPal
      • Stripe
      • Tap
  • Upload files
  • Reports
    • Payments report
    • Settlements report
    • Transactions report
  • Unified Analytics
  • Dashboards

Fraud Management

  • Fraud Score

Chargeback

  • Getting started
  • Integrations
    • Adyen
    • Checkout
    • Stripe
    • Klarna
    • Nuvei

MONITORING

  • Alerts

Resources

  • Payments
    • Payment Status
    • Operation Types
    • Operation Results
    • Authorization flags
  • Executions
  • Holders
  • Payment Instruments and Tokens
  • Notifications
    • Dispute notifications
  • Error codes
  • Currency codes

Use Cases

  • Billing
  • Server-to-server Integration

How to accept card payments

    • 1. Add containers to your page
    • 2. Mount the card form
    • 3. Mount the payment button
    • 4. Handle the payment result
    • 5. React to form and button state (optional)