XentriPay API Documentation

Version 1.0.0 • Last updated: January 2024

API Status: Online

Introduction and Purpose

This module provides technical users with access to fully structured and interactive API documentation via Redoc. It is designed to guide developers integrating with XentriPay through live specifications, detailed parameter definitions, request/response samples, authentication flows, and usage notes. It forms the core of the developer onboarding experience and is publicly accessible or gated behind a partner login if needed.

Customer Expectations

1
Access API documentation at a consistent, reliable URL
2
Navigate endpoints via sidebar with clear grouping
3
View real-time request/response models with JSON examples
4
Understand required parameters, headers, and response formats
5
See authentication methods, rate limits, error codes, and webhook structure
6
Optionally test calls using curl or Postman from sandbox credentials

Key Features

Interactive Documentation

Fully interactive API documentation hosted at a known URL

Searchable Endpoints

Search bar with endpoint filtering capabilities

Request/Response Viewer

Expanded view of parameters, schemas, and status codes

API Versioning

Clear version information and changelog dates

Authentication & Getting Started

Quick Start Steps

1

Get API Keys

Generate your API keys from the dashboard

2

Set Base URL

Use https://api.xentripay.com/v1 for production

3

Add Authorization

Include Bearer token in Authorization header

4

Make Test Call

Start with a simple GET request to verify setup

Example Authentication
curl -X GET "https://api.xentripay.com/v1/payments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"