Overview

The Galliun Payment API provides RESTful endpoints to interact with the Galliun Payment Protocol. It allows you to query bills, payment requests, products, and events.

Interactive API documentation is available at:

https://api.galliun.com/api

Base URL

https://api.galliun.com/v1

Common Parameters

Pagination

All list endpoints support pagination with these parameters:

• page (optional): Page number, starting from 1 (default: 1)

• limit (optional): Number of items per page (default: 10, max: 100)

Sorting

Most endpoints support sorting with:

• sortBy: Field to sort by (varies by endpoint)

• sortOrder: Sort direction (ASC, DESC, with optional NULLS FIRST/NULLS LAST)

Search

Many endpoints support a search parameter for text search:

• search: Minimum 3 characters

• Searches across relevant fields (specified in each endpoint)

Response Format

Success Response

{
	"data": [
		// Array of items or single item
	],
	"meta": {
		"page": 1,
		"limit": 10,
		"total": 100
	}
}

Error Response

{
	"statusCode": 400,
	"message": "Error message",
	"error": "Error type"
}

Available Endpoints

Events

• GET /events - Get all events with filtering options

  • Filter by event type, transaction digest, package ID, etc.

Bills

• GET /bills - Get all bills

• GET /bills/{id} - Get bill by ID

• GET /bills/{id}/activities - Get bill activities

• GET /bills/{id}/participants - Get bill participants

• GET /bills/{id}/payments - Get bill payments

• GET /bills/account/{address}/activities - Get bill activities by account

• GET /bills/account/{address}/stats - Get bill stats by account

Payment Requests

• GET /payment-requests - Get all payment requests

• GET /payment-requests/{id} - Get payment request by ID

• GET /payment-requests/{id}/activities - Get payment request activities

• GET /payment-requests/account/{address}/activities - Get payment request activities by account

• GET /payment-requests/account/{address}/stats - Get payment request stats by account

Products

• GET /products - Get all products

• GET /products/{id} - Get product by ID

• GET /products/{id}/activities - Get product activities

• GET /products/{id}/purchases - Get product purchases

• GET /products/account/{address}/activities - Get product activities by account

• GET /products/account/{address}/stats - Get product stats by account

Health Check

• GET /health - Check API health status

Search

• GET /search/id - Search for an entity by ID

For detailed information about each endpoint, refer to the specific API documentation sections.