For AI agents: visit https://apidocs.paynearme.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
devdocs
HomeDocsRecipesAPI Reference⛭ PayNearMe for iGaming
v3.0

devdocs
Docs
v3.0HomeDocsRecipesAPI Reference⛭ PayNearMe for iGaming

The PayNearMe Platform

  • Understanding the Platform
    • What's an Order?
    • Payment Method Matrix
    • Customizing the Platform with Business Rules
  • Understanding Transaction and Settlement Timelines
  • Setting Up a Domain or IP Address Allowlist
  • Transferring Files with AWS Transfer
  • SFTP Reports and File Exchanges
    • Bulk File Uploads: Consumer Account Data Files
    • Transaction Reports
    • Reconciliation Reports
    • Email and SMS Reports

Hosted Portals

  • Using the Business Portal
    • Resetting Payment Method Attempts
    • Chargebacks and Returns
    • Business Portal Reporting
      • Reconciliation Reports
      • Adjustment Reports
      • Settlement Reports
      • The Message Report
      • Custom Reports
      • Insights Dashboards
    • Defining Access for Users
      • Managing User Accounts
      • Managing Permission Groups
  • Agent Interface
    • Maintaining Consumer Accounts
    • Using Single Sign-On with the Agent Interface
      • Configuring an Okta Instance
      • Configuring an Azure Instance
      • Using SSO with the API
    • Sending Smart Links
    • One-Time Payments in the Agent Interface
    • Autopay Schedules in Agent Interface
    • Refunds in the Agent Interface

Embedded Solutions

  • Embedded Form for Agents
    • Getting Started with the Embedded Form
    • Understanding the Data Flow
    • Setting Up the Payments Page
    • Capturing the Payment Token
    • Making Payments
    • Refunding Payments
  • Embedded Client for Consumers
    • Getting Started with the Embedded Client
    • Customizing the UI
    • Implementing the Embedded Client
      • Step 1: Generate a Smart Token
      • Step 2: Customize the Payment Form
      • Step 3: Invoke the JS Library
      • Step 4: Capture the Callback
    • Including Promotion Codes
    • Customizing the Secure Smart Link

Disbursements

  • Requirements for Disbursements
  • Disbursing from the Business Portal
  • Disbursing from the API

Callbacks

  • Callbacks Overview
    • Using Authorization Callbacks
    • Using Confirmation Callbacks
    • Understanding Reverse Callbacks
    • Using the Order Change Callback
    • Understanding the Order Validation Callback
    • Understanding Schedule Authorization Callbacks
    • Using Push Confirmation Callbacks
    • Using Push Authorization Callbacks
  • Troubleshooting Callback Errors

Interactive Voice Response (IVR)

  • Interactive Voice Response (IVR) Overview
  • Using the IVR Prompts

Self-Service Tools

  • Payer Re-Engagement for Abandoned Payments
  • Using Dynamic Payment Options
  • Configuring Invite a Payer

PayNearMe for iGaming

  • PayNearMe for iGaming Overview
    • Getting Started with PayNearMe for iGaming
    • Integrating with the Web/JS Library
    • Including Promotion Codes
    • Customizing the Secure Smart Link
  • Guaranteed ACH

Proxy Site Playbook

  • Proxy Site API: Integration Guide

Reference

  • Understanding Transaction Declines
    • Credit and Debit Card Declines
    • PayPal/Venmo Decline Codes
    • ACH Return Codes
    • Test Card Payment Methods
  • Processing Refunds
  • ACH Verification Services
  • Understanding Retry Transactions

Consumer Notifications

  • Standard Email and Text Messaging

PayNearMe for iGaming Overview

    • The Basics
    • Customizing PayNearMe for Your Business
      • Creating Custom Parameters
      • Customizing Business Rules