Platform
DocsPlatformDeveloperTicket
  • Payrexx Platform
  • Explanation of the Platform
  • Use Cases
  • Setup and Configuration
    • First Steps
      • Domain Name and DNS Set Up
      • Access and Login
      • Service-API
      • Merchant API
    • Stripe Connect
  • Backoffice
    • Dashboard
    • Merchants
      • Overview and Editing
      • Merchant Detail View
      • Creating a Merchant Account
      • Deleting a Merchant Account
      • Know Your Customer (KYC)
    • Subscriptions
      • Subscription Overview
      • Creating a Subscription
    • Invoices
    • References
    • Payouts
    • Analytics
      • Metrics
      • Transactions
      • Statistics
    • Admin
      • Products
        • Product Overview
        • Creating and Managing Products
      • Settings
        • Emails
        • Email Templates
        • Dashboard Messages
        • Legal Templates
        • Contact Details
        • Default Fronted Template
        • Backend Template
        • User Administration
        • Invoicing
        • Plugins
  • Appendix
    • Payrexx Advisory Team
    • Platform API Reference
  • Release Notes
    • Release Notes 2025
      • Release 2025.02
    • Release Notes 2024
      • Release 2024.11
      • Release 2024.09
      • Release 2024.07
      • Release 2024.05
      • Release 2024.03
      • Release 2024.01
    • Release Notes 2023
      • Release 2023.12
Powered by GitBook
LogoLogo

Product

  • Payments
  • E-Commerce Tools
  • Pricing
  • Feedback

Company

  • About Us
  • Careers
  • Blog
  • Newsletter

Support

  • Contact
  • Status Page
  • Downloads

Developer

  • Documentation
  • API Reference
  • Integrations & Plugins

© Payrexx. All rigths reserved.

On this page
  • Usage of the Service API
  • General information
  • API documentation

Was this helpful?

  1. Setup and Configuration
  2. First Steps

Service-API

The following article discusses the Payrexx Service API, which allows various modifications to be made to merchant accounts.

Last updated 1 month ago

Was this helpful?

At Payrexx, there is a distinction between the (for merchant accounts and transactions) and the Service API (for platform partners). Only the Service API is relevant for setting up the platform solution.

Usage of the Service API

The Payrexx Service API has access to all merchant accounts connected to your platform. Through the API, the following modifications can be made:

  • new merchants

  • existing merchants

  • Modify merchant contact details

  • Configure payment service providers in merchant accounts

  • Add

General information

The Payrexx Service API is based on REST. It uses predictable, resource-oriented URLs and employs HTTP status codes to indicate API errors.

All API responses, including error messages, are returned in JSON format. Our Software Development Kits (SDK) convert the responses into appropriate language-specific objects.

API documentation

Further information about the Service API can be found in the following documentation:

Merchant API
Register
Deactivate
legal content
LogoIntroductionPayrexx Service API