This document provides a comprehensive guide to the Lattice API, detailing its structure, functionality, and implementation for developers. The API enables seamless interaction with the Lattice protocol for decentralized payments.

The Lattice API facilitates secure and efficient communication between client applications and the Lattice payment protocol. It offers capabilities such as:

• Payment Initialization: Automate peer-to-peer and merchant payments.
• Transaction Status Monitoring: Retrieve real-time updates on transactions.
• Cross-Chain Functionality: Support for multiple blockchain networks.
• Identity Integration: Use Decentralized Identifiers (DIDs) for authentication.

This API is RESTful and supports both synchronous and asynchronous operations.

All requests to the Lattice API require an API key for authentication. To obtain an API key:

1. Sign up on the Lattice Dashboard.
2. Generate an API key under the "API Access" section.

Include the key in the request header:

Authorization: Bearer YOUR_API_KEY

Endpoint: /payments/initiate
Method: POST

Description: Creates a new payment request.

Headers:

{
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
}

Body Parameters:

Sample Request:

POST /payments/initiate
{
  "recipient": "0x1234567890abcdef",
  "amount": 10.5,
  "currency": "ETH",
  "metadata": {
    "orderId": "ORD12345",
    "note": "Payment for services"
  }
}

Response:

{
  "status": "success",
  "transactionId": "tx_abcdef1234567890",
  "message": "Payment initiated successfully"
}

Endpoint: /payments/{transactionId}/status
Method: GET

Description: Fetches the current status of a payment.

Path Parameters:

Headers:

{
  "Authorization": "Bearer YOUR_API_KEY"
}

Sample Request:

GET /payments/tx_abcdef1234567890/status
Authorization: Bearer YOUR_API_KEY

Response:

{
  "transactionId": "tx_abcdef1234567890",
  "status": "completed",
  "blockchain": "Ethereum",
  "details": {
    "timestamp": "2024-12-31T12:34:56Z",
    "amount": 10.5,
    "currency": "ETH"
  }
}

Endpoint: /payments/{transactionId}/cancel
Method: POST

Description: Cancels a pending payment.

Path Parameters:

Headers:

{
  "Authorization": "Bearer YOUR_API_KEY"
}

Sample Request:

POST /payments/tx_abcdef1234567890/cancel
Authorization: Bearer YOUR_API_KEY

Response:

{
  "status": "success",
  "message": "Payment successfully canceled"
}

API responses may include error codes and messages. Below is a list of common errors:

The Lattice API enforces rate limits to ensure fair usage:

• 100 requests per minute per API key.
• Exceeding this limit results in a 429 Too Many Requests response.

For ease of integration, consider using the Lattice SDK. Visit the SDK Documentation for details.

For assistance:

• Visit our FAQ.
• Join our Discord community.
• Contact support at [email protected].

Would you like additional sections or further refinements to this documentation?