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
    • Headless Integration using SDK
    • SDK Events Glossary
    • Drop-in
    • Elements
    • Secure Fields
    • Payrails Web Fraud SDK
    • Accept payments via API
    • IOS SDK - Quick start
      • SDK Concepts
      • SDK API Reference
      • Styling Guide
      • Troubleshooting
    • Android SDK - Quick Start
      • SDK Concepts
      • SDK API Reference
      • Styling Guide
      • Troubleshooting
      • Query Session Data
      • Update Checkout Amount
    • React Native SDK
      • How to Integrate
      • SDK Concepts
      • API References
    • Iframe Integration Guide
  • Integrations
    • Adyen
    • Amazon
    • Braintree (Paypal)
    • Checkout.com
    • dLocal
    • Klarna
    • Stripe
  • Payment Methods
    • Set up payment methods
    • Cards
    • 1Voucher
    • Alfa (Bank Alfalah)
    • Apple Pay
    • 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
  • 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
  • Upload files
    • Transactions report
  • Reports
    • Payments report
    • Settlements report
  • Unified Analytics
  • Dashboards

Fraud Management

  • Fraud Score

PAYOUTS

  • Getting Started
  • Set Up Your Payout Workflow
    • Payout Workflow Events
  • SDK Documentation

MONITORING

  • Alerts

Resources

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

Use Cases

  • Billing

Configure Your Workflow

Updated about 1 month ago


Explore Payrails