Ultra Pay API Documentation

Welcome to the Ultra Pay API documentation. Get started with our payment processing API in minutes.

Quick Start

Follow these steps to get started with the Ultra Pay API:

Create your Ultra Pay account
Get your API keys from the dashboard
Make your first API request
Handle the response

Authentication

Ultra Pay uses API keys to authenticate requests. You can get your API keys from your dashboard.

curl -X POST https://api.ultrapay.com/v1/payments \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 2000,
    "currency": "usd",
    "source": "tok_visa"
  }'

Important

Keep your API keys secure and never expose them in client-side code.

Making Requests

All API requests should be made to https://api.ultrapay.com/v1/

Base URL

https://api.ultrapay.com/v1/

Request Format

All requests should be made using HTTPS. Request and response bodies should be encoded as JSON.

Payments API

Create Payment

Creates a new payment charge.

POST/v1/payments

Parameters

{
  "amount": 2000,        // Amount in cents
  "currency": "usd",     // Three-letter ISO code
  "source": "tok_visa",  // Payment source token
  "description": "Order #1234"
}

Retrieve Payment

Retrieves a payment by ID.

GET/v1/payments/{ id }

Error Handling

Ultra Pay uses conventional HTTP response codes to indicate the success or failure of an API request.

200OK

Everything worked as expected.

400Bad Request

The request was unacceptable, often due to missing a required parameter.

401Unauthorized

No valid API key provided.