Getting Started

Get up and running with the tPay365 API. This guide walks you through your first API call, authentication setup, and understanding the response format.

Base URL

All API requests are made to the following base URL. In sandbox mode, use the sandbox URL.

Production

bash

https://api.tpay365.com/v1

Sandbox

bash

https://sandbox.api.tpay365.com/v1

Your First Request

Once you have an API key, make a test request to verify your credentials.

Verify credentials

http

GET /api/v1/auth/me HTTP/1.1
Host: api.tpay365.com
Authorization: Bearer sk_live_your_api_key_here

Response Format

All responses are JSON. Successful responses include the data directly. Errors follow a consistent format with error codes and human-readable messages.

Successful response

json

{
  "id": "usr_8821-9920",
  "email_masked": "al****@example.com",
  "role": "employee",
  "created_at": "2026-01-15T10:30:00Z"
}

Error response

json

{
  "error": "unauthorized",
  "message": "Invalid or expired API key.",
  "request_id": "req_abc123"
}

Authentication

tPay365 uses Bearer token authentication. Include your API key in the Authorization header of every request.

Keep your keys safe

Never expose API keys in client-side code, public repositories, or browser requests. Use server-side calls only.

Next Steps

Read the full Authentication guide for OAuth 2.0 and scoped API keys
Explore the API Reference for all 14 endpoint groups
Set up your Sandbox environment for testing