Jump to Content
Payrails Merchant Documentation
HomeGuidesAPI Reference
Go to payrails.comPayrails Merchant Documentation
Guides
Go to payrails.com
HomeGuidesAPI Reference
All
Pages
Start typing to search…

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
  • Integrations
    • Adyen
    • Amazon
    • Braintree (Paypal)
    • Checkout.com
    • 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
  • Configure Your Workflow
    • Start your workflow
    • Payment Options
    • Routing
    • Retries
    • Cancel and Capture Modes
    • Meta Fields
      • Order costs
  • 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
    • Alerts
  • 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
  • Unified Analytics
  • Dashboards

Fraud Management

  • Fraud Score

PAYOUTS

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

Resources

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

Use Cases

  • Billing

Records, Aliases and Instruments

Learn about the concept of records, aliases and fields.

Updated about 2 months ago


Invoking Connections
Tokenize Cards via SDK