This page provides access to API documentation for developers working with the Payrix Pro API. The following content includes downloadable PDF guides that cover key aspects of the API:
API Quick Start Guide: Get started using the Payrix Pro API.
API Documentation and Models: Details about syntax, error, idempotency, and authentication.
API Use Cases: See various lightweight tutorials on specific Payrix Pro API uses.
API Quick Start Guide
This guide is designed to help you begin working with the Payrix Pro API quickly and effectively. It introduces key concepts such as the sandbox environment, API authentication, onboarding merchants, and submitting payments. Each section includes example requests and links to additional resources for deeper exploration.
Key topics covered in this guide include:
Sandbox Testing: An overview and how to access it.
Request Authentication: Instructions for generating and using API keys.
Merchant Boarding: Step-by-step guide to onboarding merchants with the API.
Payment Processing: Sample requests for processing payment transactions.
Additional Resources: Links to additional onboarding and payment resources
API Documentation and Models
This guide provides a comprehensive reference for working with the Payrix Pro API, including syntax structure, authentication, error handling, and advanced query techniques. It also explains how to ensure idempotency using request tokens and outlines the differences between public and private API keys.
This guide includes detailed information on:
API Request Structure: A breakdown of the Payrix Pro API request structure, headers, and endpoints.
Common Search Queries: Examples of advanced search, pagination, sorting, and total queries.
Error Handling Guide: Codes, messages, and troubleshooting Payrix Pro API errors.
Request Idempotency Guidance: Explanation and setup steps for idempotent requests using request tokens.
API Key Management: Instructions for generating and managing API keys securely
API Use Case Guide
This guide offers practical, real-world examples of how to use the Payrix Pro API to accomplish common business and operational tasks. Each use case includes step-by-step instructions, endpoint references, and sample payloads to help developers implement solutions efficiently and accurately.
Explore practical examples for common API tasks:
Reporting and Reconciliation: Build reports and access disbursement data using the API.
Payments and Payouts: Submit direct payments, card-on-file transactions, and one-time payouts.
Merchant Management: Onboard new merchants, update existing records, and manage multiple merchants under a single login.
User and Group Management: Create, update, and manage users and groups programmatically.
Disputes and Refunds: Monitor chargebacks, respond to disputes, and process refunds or reversals for credit card and eCheck payments.
Advanced Operations: Use transaction hold filters and other advanced API features to fine-tune your integration.