Uprails API Reference

What is Uprails?

Uprails is a full-stack payment processor that allows you to accept, process, and manage payments globally through a single unified API. Leverage our robust infrastructure to handle payments, refunds, disputes, and complete financial reporting with a single integration.

Unified Dashboard

Monitor all your payments in one place

Developer First

Clean APIs with comprehensive documentation

Base URL

All API requests should be made to the following base URL:

https://api.uprails.com

Quick Start

Here's a quick example of how to create a payment:

Create a Paymentbash

curl -X POST https://api.uprails.com/payments \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{
    "amount": 1000,
    "currency": "USD",
    "confirm": true,
    "capture_method": "automatic",
    "payment_method": "card",
    "payment_method_data": {
      "card": {
        "card_number": "4242424242424242",
        "card_exp_month": "12",
        "card_exp_year": "2025",
        "card_cvc": "123"
      }
    }
  }'

Authentication

All API endpoints require authentication using an API key. Include your API key in the request headers:

api-key: YOUR_API_KEY

Keep your API key secure

Never expose your API key in client-side code or public repositories. Always make API calls from your server.

Response Format

All responses are returned in JSON format. Successful responses will include the requested data, while errors will include an error code and message.

Success Responsejson

{
  "payment_id": "pay_1234567890",
  "status": "succeeded",
  "amount": 1000,
  "currency": "USD",
  "created": "2024-01-15T10:30:00Z"
}

Next Steps

Authentication

Learn how to authenticate your API requests

Create Payment

Process your first payment

Webhooks

Set up real-time event notifications

Error Handling

Handle errors gracefully