piaxis

Getting Started:

  • Getting Access
    • Credentials
    • Base URLs
    • Interactive Docs
    • Security Notes
    • Next Steps
  • Quickstart
    • 1) Get your API key
    • 2) Create a payment
    • Next Steps

Piaxis API Documentationīƒ:

  • Piaxis API Documentationīƒ
    • Overview
    • API Documentation
      • Core Services
        • External API Endpoints
        • Authentication & Security
        • SDKs
        • Payment Processing API
        • Escrow API
        • Direct Disbursements API
        • Escrow Disbursements API
        • Webhook Events & Integration
    • API Fundamentals
      • Base URLs
      • Authentication Methods
      • Required Headers
      • Supported Payment Methods
      • Supported Currencies
    • Rate Limiting
      • Standard Limits
      • Rate Limit Headers
    • Response Format
      • Standard Response Structure
      • Error Response Structure
      • Common Error Codes
    • Idempotency
    • Pagination
    • Testing & Development
      • Sandbox Environment
      • Test Data
    • Development Resources
      • API Integration
      • Development Tools
    • Example Integration
      • Quick Start Example
    • Support Resources
      • Documentation & Guides
      • Developer Support
      • Community & Learning
      • Emergency Support
  • Authentication & Security
    • Overview
    • Public Contract Notes
    • API Key Authentication
      • Merchant account id and collection defaults
    • OAuth2 Flow
      • Authorization Request
      • Authorization Callback
      • Token Exchange
      • Using The Bearer Token
    • OTP Flow
      • Request OTP
      • Use OTP In Money-Moving Calls
    • Implementation Examples
      • Python
      • Node.js
    • Security Best Practices
    • Related References
  • Escrow API
    • Overview
    • Public Contract Notes
    • Authentication
    • Marketplace Allocations
    • Create Escrow
      • Canonical MTN escrow example
      • Allocation-aware marketplace create example
      • Receiver semantics
      • Marketplace sequence
      • Choose the right flow
      • Canonical piaxis_external escrow example
      • Guaranteed create response shape
      • Allocation-aware marketplace create example
    • Read Escrow
    • Fulfill Terms
      • Role model on this public collection route
      • Inspect required actions first
      • Term-specific payloads
        • Delivery confirmation
        • Meeting delivery
        • Other supported term types
    • Release Escrow
      • Example
      • Allocation-aware partial release example
      • Allocation-aware partial release response
      • Short-lived approval session for nearby partial releases
      • Example follow-up partial release without a fresh OTP
    • Reverse Escrow
      • Allocation-aware partial reverse example
      • Allocation-aware partial reverse response
    • Disputes
    • Implementation Notes
    • Related References
  • Payment Processing API
    • Overview
    • Public Contract Notes
    • Merchant Collection Semantics
    • Authentication
    • Creating Payments
      • Canonical mobile-money example
      • Legacy recipient_id compatibility
      • Canonical piaxis_external example
      • Guaranteed create response
      • Fee Handling
    • Payment Details
      • Guaranteed response fields
      • Example
    • Merchant Payment Listing
      • Example
      • Representative response shape
    • Canonical Flows
      • Server-to-server mobile money
      • piaxis_external payment
      • Marketplace mapping example
    • Refunds
    • Implementation Examples
      • Python
      • Node.js
    • Related References
  • Direct Disbursements API
    • Overview
    • Public Contract Notes
    • How recipient resolution works
    • When recipient_id is needed
    • Payment-method scope
    • Authentication
    • Create Disbursement
    • Quote Disbursement
      • Guaranteed quote response fields
      • Representative response shape
      • Canonical example
      • External mobile-money rules
      • Guaranteed create response
    • Get Disbursement
    • List Disbursements
      • Representative response shape
    • Cancel Disbursement
      • Example
    • Marketplace Mapping
    • Marketplace collect -> release -> payout example
    • Fee Behaviour
    • Related References
  • Webhook Events & Integration
    • Overview
    • Public Contract Notes
    • Private Management Contract
    • Delivery Pattern
      • Headers
    • Signature Verification
      • Python example
    • Consumer Requirements
    • Public Event Types
    • Minimal Handler Example
    • Operational Guidance
    • Related References
  • SDKs
    • Python SDK
    • TypeScript SDK
    • Coverage Notes
    • Marketplace Mapping
    • Quick Reference
    • Related References
piaxis
AI-friendly integration guide

Download one Markdown file covering the same public /api/docs payment surface for REST and SDK integrations.

Download Markdown Open llms.txt
  • Search

© Copyright 2024, JC.

Built with Sphinx using a theme provided by Read the Docs.