For AI agents: visit https://docs.fatzebra.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Fat Zebra Documentation
HomeDocumentationAPI ReferenceChangelog
v1.0

DocumentationAPI ReferenceLog InFat Zebra Documentation
Documentation
DocumentationAPI ReferenceLog In
v1.0
Objects

Documentation

  • Getting Started
    • Authentication
    • Errors & Timeouts
    • Endpoint Base URLs
  • Pagination
  • Glossary

Testing

  • Test Card Numbers

Purchases

  • Overview
  • Response Codes
  • Metadata
  • Addendum Data
  • Extra and Extended Fields
    • Card On File
    • 3D Secure Card Payments
    • Mail Order / Telephone Order Payments
    • Dynamic Descriptors
    • Payment Aggregators
    • Remittance Merchants
  • Chargebacks and Fraud
  • Supported Currencies
    • ISO Currency Codes
  • AVS
  • Merchant Advice Codes (Retries)

Card On File

  • Settlement Summary Report (COPY)
  • Tokenized Credit Cards
  • Recurring / Installment Payments
  • Merchant Initiated Transaction
  • Incremental Authorization

Direct Entries

  • Overview
  • Direct Debits
  • Direct Credits

Batches

  • Batches Overview
  • Purchase Batch File Columns
  • Refund Batch File Columns
  • Direct Debit Batch File Columns
  • Result Files

Persisted Invoices

  • Upload Specification

Wallets

  • Apple Pay
    • Apple Pay Onboarding via Merchant Dashboard
    • Apple Pay (app) Certificate Renewal
    • Get Apple Pay Session
    • Recurring & Installment Transactions
  • Google Pay™
    • Android App Integration
    • Web Integration
    • Hosted Payments Page Integration
    • Google Pay Merchant ID

Webhooks

  • Overview
  • Handling Webhooks
  • Events
    • Example Webhooks
    • Card Account events

NETWORK TOKEN PASSTHROUGH

  • Third Party Network Tokens

Security

  • Overview
  • PCI Certification
  • What is PCI Compliance
  • PGP Key

React SDK

  • React SDK - Overview
    • Types

Javascript SDK

  • Obtain an OAuth token
  • Javascript SDK Features
  • Methods
    • constructor
    • purchase
    • verifyCard
    • renderPaymentsPage
  • Objects
    • Customer
    • PaymentIntent
    • PaymentMethod
    • HppSetupParams
    • VerifyCardParams
  • Events
    • Form Validation (V2)
    • Validation
    • SCA
    • Tokenization
    • Payment
  • Event Listeners

3DS2 Integration

  • Overview
  • Using Hosted Payments Page
  • Using Custom Payments Form
  • 3DS Cards for Testing
  • Branding Requirements
  • Go-Live
  • 3DS2 Outcomes

Merchant Dashboard User Guide

  • Overview
  • Transactions
    • Create Payment Link
    • Individual Transaction Search
    • Refund A Transaction
    • Repeat A Transaction
    • Email or Download Receipt
    • Virtual Terminal
    • Disputes
  • Reports
    • Subscribe to reports via email
    • Transactions Report
    • Settlement Summary Report
    • Payout Report
    • All Merchant Report
  • Customers
    • Add a Customer
    • Charge a Customer’s Credit Card
    • Add a Payment Plan
    • Debit a Customer's Bank Account
    • Retry Failed Payment for Payment Plan
  • Direct Entries
    • Upload Batch Files
  • Account
    • Users
      • Multi-factor authentication
      • User Permissions
      • Invite Users
      • Editing User Permissions
      • Revoking User Access
      • Changing Current User's Access Level
Powered by 

Objects

fatzebra.js Objects

  • Customer
  • PaymentIntent
  • PaymentMethod
  • HppSetupParams
  • VerifyCardParams

Updated 11 months ago


What’s Next
  • Events