Introduction to the API Reference

Welcome to the technical heart of Mipise Payment Services. This section is designed to bridge the gap between the business concepts you've explored in our Business Guides and the actual code required to power your platform.

⚠️
Note for Non-Technical Profiles: This section is specifically tailored for software engineers and developers. It contains technical specifications, authentication protocols, and endpoint definitions. If you are looking for high-level business logic, compliance rules, or operational workflows, please refer back to our Business Guides where all those resources are already documented.

1. Getting Started Checklist

Ready to build? Follow these steps to initiate your first interaction with our gateway:

Secure your Credentials: Obtain your Platform UUID and API keys from your Mipise representative.
Configure Request Headers: Ensure your system follows our Request Headers Guidelines (Content-Type, User-Agent, etc.).
Authentication: Generate your first Access Token. Remember that tokens have a specific expiration time and must be refreshed.
Sandbox Testing: All URLs provided in this documentation and our Swagger UI point to our Sandbox environment. This allows you to perform end-to-end tests without moving real funds.
Listen for Events: Set up your Webhook endpoints early to receive real-time updates on transaction statuses.

2. Map of the Land

The API is structured around four main pillars to make navigation intuitive:

Core Architecture: Foundations like Authentication, Token management, and Global Headers.
Users & Compliance: Managing the lifecycle of User profiles, KYC documents, and Person entities.
Accounts & Instruments: Handling internal Payment Accounts, External Accounts (IBANs), and Mandate (SEPA Direct Debit Mandate) signatures.
Financial Movements: The engine for Pay Ins (Cards, Wires, SDD), P2P transfers, and Pay Outs (withdrawals).

3. Versioning & Lifecycle (v1.1)

We are currently operating on version 1.1.

Evolution Policy: While we introduce new endpoints and features to enhance the API, we prioritize stability.
Grace Period: When a new major release is deployed, your platform typically has a 6-month window to update your integration. During this period, legacy endpoints remain functional to ensure no service disruption.
Error Handling: We use standard HTTP status codes. Always refer to our Errors Handling section to correctly interpret and display error messages to your users.

💡
Pro-Tip: Check if your team has already downloaded the Postman Collection or the OpenAPI (Swagger) JSON file. These tools are highly recommended for debugging and accelerating your development cycle.

Jump into the technical details:

🔐 Authentication

Learn how to generate and manage your secure Access Tokens.

⚙️ Request Headers

Essential formatting rules for every API request.

🚨 Error Codes

A directory of error responses and how to solve them.