Skip to main content

Documentation Index

Fetch the complete documentation index at: https://paywithz.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
API Overview

PayWithZ provides a clean REST API for all platform operations. All endpoints return JSON responses with clear error handling.
Base URL: All API examples use http://api.paywithz.com as the base URL. This is the production API endpoint.
API Key Required: To use the PayWithZ API, you need an API key. Request your API key by joining our pilot program.

​
Get Your API Key

Join Pilot Program

Join our pilot program to get API access. Perfect for banks, fintechs, payment processors, and financial institutions.

​
Quick Examples

​
Health Check

Verify the API is running: 
curl http://api.paywithz.com/api/health

​
Platform Information

Get program IDs and mint addresses: 
curl http://api.paywithz.com/api/platform/info

​
Complete Flow Examples

​
1. Wallet Creation

Create a new wallet for a user: 
curl -X POST http://api.paywithz.com/api/wallet/create \
  -H "Content-Type: application/json"

​
2. KYC Submission

Submit KYC data and receive SBT: 
curl -X POST http://api.paywithz.com/api/kyc/submit \
  -H "Content-Type: application/json" \
  -d '{
    "wallet": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
    "kycData": {
      "fullName": "John Doe",
      "country": "US",
      "dateOfBirth": "1990-01-15",
      "email": "john.doe@example.com",
      "phoneNumber": "+1234567890"
    }
  }'

​
3. Stablecoin Transfer

Transfer tokens between verified wallets: 
curl -X POST http://api.paywithz.com/api/stablecoin/transfer \
  -H "Content-Type: application/json" \
  -d '{
    "from": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
    "to": "9zLYuh3DX98e98UYJTSEcqE6kCifUqB94UaSvKptLhBvV",
    "amount": 100
  }'

​
Available Endpoints

Wallet Creation

Create and manage wallets

KYC Submission

Submit KYC and get SBT

Stablecoin Operations

Mint, transfer, and redeem

​
Response Format

All endpoints return consistent JSON responses: Success: 
{
  "success": true,
  "data": { ... },
  "message": "Operation completed successfully"
}
Error: 
{
  "success": false,
  "error": "Error message",
  "code": "ERROR_CODE"
}

​
Get Started

Request API Key

Join our pilot program to get API access. Banks, fintechs, payment processors, and financial institutions welcome.

​
Next Steps