Quick Start

Follow these steps to integrate PayTree into your application and start accepting crypto payments.

# npm
npm install @paytree/sdk

# yarn  
yarn add @paytree/sdk

# pnpm
pnpm add @paytree/sdk

import PayTree from '@paytree/sdk';

const paytree = new PayTree('pt_live_your_api_key');

const payment = await paytree.payments.create({
  amount: 100.00,
  currency: 'USD',
  description: 'Order #1234',
  customer_email: 'customer@example.com',
  success_url: 'https://yoursite.com/success',
  cancel_url: 'https://yoursite.com/cancel'
});

// Redirect customer to checkout
window.location.href = payment.checkout_url;

PayTree uses API keys to authenticate requests. You can view and manage your API keys in the merchant dashboard.

Using the Authorization Header

Include your API key in the Authorization header:

Authorization: Bearer pt_live_your_api_key

Using the X-API-Key Header

Alternatively, use the X-API-Key header:

X-API-Key: pt_live_your_api_key

PayTree provides a safe testing environment. Your test API key (pt_test_) allows you to simulate payments without processing real transactions.

The Payments API allows you to create, retrieve, and manage payments. Each payment represents a single transaction from a customer.

Create a Payment

POST/v1/payments

Request Parameters

Response

{
  "id": "pay_abc123def456",
  "object": "payment",
  "amount": 100.00,
  "currency": "USD",
  "status": "pending",
  "checkout_url": "https://checkout.paytree.cc/pay_abc123def456",
  "description": "Order #1234",
  "customer_email": "customer@example.com",
  "metadata": {},
  "created_at": "2024-01-25T10:30:00Z",
  "expires_at": "2024-01-25T11:30:00Z"
}

Webhooks allow you to receive real-time notifications about payment events. When an event occurs, PayTree sends an HTTP POST request to your configured endpoint.

Webhook Events

Verifying Webhook Signatures

Always verify webhook signatures to ensure the request came from PayTree. Each webhook includes these headers:

• X-PayTree-Signature - HMAC-SHA256 signature
• X-PayTree-Timestamp - Unix timestamp

import crypto from 'crypto';

function verifyWebhook(payload, signature, timestamp) {
  const secret = process.env.PAYTREE_WEBHOOK_SECRET;
  const signedPayload = `${timestamp}.${JSON.stringify(payload)}`;
  
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(signedPayload)
    .digest('hex');
  
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expectedSignature)
  );
}

// Express webhook handler
app.post('/webhook', (req, res) => {
  const signature = req.headers['x-paytree-signature'];
  const timestamp = req.headers['x-paytree-timestamp'];
  
  if (!verifyWebhook(req.body, signature, timestamp)) {
    return res.status(401).send('Invalid signature');
  }
  
  const { event, data } = req.body;
  
  switch (event) {
    case 'payment.completed':
      // Handle successful payment
      break;
    case 'payment.failed':
      // Handle failed payment
      break;
  }
  
  res.status(200).send('OK');
});

PayTree settles all payments in cryptocurrency directly to your wallet. No bank account required.

Settlement Timeline

Supported Cryptocurrencies

Base URL: https://api.paytree.cc

PayTree uses standard HTTP status codes to indicate the success or failure of API requests.

Error Response Format

{
  "error": {
    "code": "invalid_request",
    "message": "The amount field is required.",
    "param": "amount",
    "doc_url": "https://paytree.cc/docs#payments"
  }
}

PayTree applies rate limits to ensure fair usage and maintain API performance.

Rate limit headers are included in every response:

• X-RateLimit-Limit - Maximum requests allowed
• X-RateLimit-Remaining - Requests remaining
• X-RateLimit-Reset - Unix timestamp when limit resets

Add a PayTree payment button to your website with just a few lines of code.

import { PayTreeButton } from '@paytree/react';

function CheckoutButton() {
  return (
    <PayTreeButton
      apiKey="pt_live_your_api_key"
      amount={99.99}
      currency="USD"
      description="Premium Plan"
      customerEmail="customer@example.com"
      onSuccess={(payment) => {
        console.log('Payment successful:', payment.id);
        // Redirect or update UI
      }}
      onError={(error) => {
        console.error('Payment failed:', error.message);
      }}
      theme="light"
      buttonText="Pay with Crypto"
    />
  );
}

Button Props

Accept crypto payments on your WooCommerce store with our official WordPress plugin.

Installation

1. Download the PayTree WooCommerce plugin
2. Go to WordPress Admin → Plugins → Add New → Upload Plugin
3. Upload the plugin ZIP file and click "Install Now"
4. Activate the plugin
5. Go to WooCommerce → Settings → Payments → PayTree
6. Enter your API key and configure settings

Use our official SDKs to integrate PayTree in your favorite programming language.