Paywall Payment Orchestration
  • Welcome
  • 🔎Overview
    • Introduction
    • Providers
      • Virtual Pos Usage
      • PayOut Usage
      • APM (Alternative Payment Method) Usage
      • Card Generation Usage
  • 🔑Authentication
  • 👩‍💻Environment
    • Test Environment
    • Prod Environment
  • 💻Client-Side Services
    • 🔐Authorization
    • 1. TempCard
  • 📠Physical POS
    • 1. Provider
      • 1. List
      • 2. List (ByRegion)
    • 2. Connection
      • 1. List
      • 2. Detail
      • 3. Establish Connection
      • 4. Update
      • 5. Delete
      • 6. Disconnect the connection.
      • 7. Reconnect
    • 3. Terminal
      • 1. List
      • 2. List (ByConnection)
      • 3. Synchronize
    • 4. Terminal Label
      • 1. List
      • 2. Add
      • 3. Update
      • 4. Delete
    • 5. Pair
      • Async
        • 1. Pair/Request
        • 2. Pair/Request/Approve
        • 3. Pair/Disconnect
        • 4. Pair/Request/Cancel
      • Sync
        • 1. Pair/Request
        • 2. Pair/Disconnect
        • 3. Request/Cancel
    • 6. Payment
      • Async
        • 1. Sale
        • 2. Cancel
      • Sync
        • 1. Sale
        • 2. Sale/Rollback
        • 3. Cancel
        • 4. Cancel/Rollback
      • 1. Payments
      • 2. Payments/Activities
      • 3. Payments/Products
      • 4. Query
    • System Data
      • Device Provider
      • Card Brands
      • Card Origin
      • Card Type
      • Currency
      • Payment Channel
      • Payment Status
      • Valor Day
      • Payment Methods
      • Provider
      • Region/Country
      • Tax Groups
      • Transaction Statuses (Trx)
      • Transaction Types (Trx)
      • Unit Codes
      • Payment Methods
  • 🧥Marketplace
  • 🧑‍🤝‍🧑Member Service
    • Member Management
      • 1. Create Member
      • 2. Update Member
      • 3. Delete Member
      • 4. Members
      • 5. Search for Member
    • Member Bank Management
      • 1.Add Bank Method
      • 2.Edit Bank Method
      • 3.Delete Bank Method
      • 4.Bank Methods
    • Member Value/Commission
      • 1. Bring Value/Commission
      • 2. Add Value/Commission
  • 💳Payment Service
    • 1. Version Control
    • 2. Non-Secure
    • 3. Non-Secure (Insurance)
    • 4. 3D Payment
    • 5. Provision Close
    • 6. Provision Cancel
    • 7. Installment Inquiry
    • 8. Check BIN
    • 9. Refund
    • 10. Partial Refund
    • 11. Cancellation
    • 12. Payment Inquiry
    • 13. Payment Confirmation
      • 1. Paywall-Calculator
        • 1. Product Based
        • 2. Payment Based
      • 2. Platform-Calculator
        • 1. Product Based
        • 2. Payment Based
    • 14. Cancel Confirm
      • 1. Product Based
      • 2. Payment Based
    • 15. Manage Products
      • 1. Product List
      • 2. Shipping Cost
        • 1. Retrieve Shipping Cost
        • 2. Define Shipping Cost
      • 3. Discount
        • 1. Retrieve Discount Information
        • 2. Define Discount
      • 4. Member Profit
        • 1. Increase Earnings
        • 2. Decrease Earnings
    • 16. Marketplace
      • 1. Approval Statuses
      • 2. Earnings
        • 1. Product-Based
          • 1. Bring Profit
          • 2. Postpone Earnings
          • 3. Increase Earnings
          • 4. Decrease Earnings
          • 5. Update Date
          • 6. Retry
        • 2. Payment-Based
          • 1. Earn Revenue
          • 2.Retry
        • 3. Profit-Based
          • 1. Fetch Earnings
          • 2. Deferred Earnings
          • 3. Increase Earnings
          • 4. Decrease Earnings
          • 5. Update Date
          • 6. Try Again
        • 4. Member-Based
          • 1. Income Yield
      • 3. Debt
        • 1. Product-Based
          • 1. Fetch Debt
        • 2. Payment-Based
          • 1. Fetch Debt
        • 3. Debt-Based
          • 1. Increase Debt
          • 2. Reduce Debt
          • 3. Delete Debt
    • 17. Batch Processing Method
      • 1. Payment
        • 1. Storm 🍃
        • 2. Tsunami 🌊
      • 2. Cancel
        • 1. Cancel (Bulk)
        • 2. Cancellation (List)
      • 3. Refund
        • 1. Refund (Bulk)
        • 2. Refund (List)
      • 4. Query
      • 5. Try Again
  • 💸Payout Service
    • 1. Balance
    • 2. Balance/Main Account
    • 3. Iban
    • 4. Registered Member's IBAN
    • 5. To the account
    • 6. Transaction Inquiry
    • 7. Account Inquiry
  • 🧾Reconciliation Service
    • Virtual POS
      • 1. Perform Reconciliation
      • 2. Fetch Reconciliation
      • 3. End of Day Data
      • 4. Reconciliation List
  • ⏰Recurring Payment
    • 1. Generate Repeatedly
    • 2. Edit Repeatedly
    • 3. Recurring Inquiry
    • 4. Stop Recurring
    • 5. Delete Recurring
    • 6. Restart Recurring
    • 7. Query Recurring Payment
    • 8. Recurring Payment Card
      • 1. Cards
      • 2. Add Card
      • 3. Delete Card
    • 9. Customer Pool
      • 1. List
      • 2. Search
    • 10. Product/Content Pool
      • 1. List
      • 2. Search
  • 🔗LinkQr Service
    • 1. Generate
  • 📰Common Page Service
    • 1. Generate
    • 2. Payment Inquiry
  • 🔐Card Storage Service
    • Card Saving
      • 1. New Card
      • 2. List Cards
      • 3. Delete Card
      • 4. Update Card
    • Card Saving (Insurance)
      • 1. New Card
      • 2. Saved Cards
      • 3. Delete Card
      • 4. Update Card
  • 📇Card Production Service
    • 1. Account/Balance Check
    • 2. Deactivate
    • 3. Activate
    • 4. Delete
    • 5. Increase Balance
    • 6. Decrease Balance
    • 7. Details
    • 8. Card List
    • 9. Update Phone Number
    • 10. Update Description
    • 11. Card Operations
    • 12. Update Password
    • Virtual Card
      • 1. Create
    • Physical Card
      • 1. Add
  • 🌏Alternative Payment Methods (APM)
    • DirectPay
      • 1. Initiate Payment
    • OTP Based
      • 1. Confirm Payment
    • QR Based
      • 1. Create Payment
    • CheckoutPage
      • 1. Initiate Payment (By ID)
      • 2. Initiate Payment (By Key)
    • 1. List of Connected Providers
    • 2. Query Payment
    • 3. Refund
    • 4. Partial Refund
  • 📖System Data
    • Recurring Payment
    • Callback Types
    • Payment Channels
    • Payment Statuses
    • Payment Methods
    • Currency
    • IP List
    • Shipping Types
    • Marketplace Value Date Types
    • Card Transaction Types
    • APM
    • APM Dynamic
    • Discount Owner Types
    • Value Dates (Virtual POS)
    • Language Options
    • Regions
    • Card Families
    • Paywatch Constant Values
    • Paywatch Fixed Values
    • QR code format types
    • PayOut Statuses
    • Card Production
    • Bulk Payment
  • 📚Libraries
  • #️⃣Hash Generation
    • Formats
    • Key Types
  • 📶Callback Examples
    • 3D Notification
    • Paywatch
    • General Communication
    • APM
    • PayOut
    • Recurring Payment
  • Test Cards
  • Paywall Test Cards
  • Error Codes and Descriptions
  • Frequently Asked Questions
  • Türkçe
Powered by GitBook
On this page

Welcome

🎉 Welcome to the Paywall API documentation!

Here, you will discover how to use our Paywall service, its features, and functions.

With Paywall, you can perform payment operations quickly and successfully. Instead of integrating with each payment provider from scratch, you can easily access all their features through Paywall in one place and accelerate the integration process.

💳 Payment Services:

  • Payment Initialization (3D)

    • Pre-Auth

    • Auth

  • Payment (Direct - NonSecure)

    • Pre-Auth

    • Auth

  • Provision Close

  • Provision Cancel

  • Payment Inquiry

  • Cancellation

  • Refund

  • Partial Refund

  • BIN Inquiry

  • Installment Inquiry

  • Recurring Payments

  • Marketplace

  • Bulk Payment Services

Integration and SDK Support:

You can easily integrate the Paywall service into your products using any programming language. Paywall provides a Restful-based integration capability and also offers SDK support for integrations. If the SDKs provided by Paywall do not meet your needs, feel free to contact us.

Security and Authorization:

Paywall API uses a security key for authorization. To integrate, merchants need to use a Public API Key and Private API Key, which are unique to their account. These credentials are provided to the merchant by Paywall once the membership process is completed.

With compliance to PCI DSS standards, Paywall provides the trust your business requires.

API Documentation:

The API documentation includes detailed information about all API requests and responses, sample codes, and usage instructions. By using the API of our Paywall payment service, you can perform payment transactions quickly, securely, and effortlessly.

🤝 For any questions or support, don't hesitate to contact us.

NextOverview

Last updated 2 months ago