RexPayments API Documentation

Overview

Secure Payment Processing Made Simple

RexPayments provides three powerful APIs to handle all your payment needs. Choose the right endpoint for your use case and start accepting payments in minutes.

Generate Payments API

Create one-time payment links for individual transactions with automatic customer redirects.

Best for: Checkout flows, one-off purchases, and direct customer payments

Customers are redirected to complete payment and then back to your Success/Failure URL.

Payment Links API

Create shareable, reusable payment links with complete control over product details and payment limits.

Best for: Limited-time offers, stock-limited sales, service slots, and shareable invoices

Set expiration dates, payment limits, and manage link status programmatically.

Transaction Details API

Retrieve complete payment information using a payment ID for verification and reconciliation.

Best for: Payment verification, status checks, and order reconciliation

Access full transaction details including payment method, amount, currency, and status.

All API requests require authentication using your API key as a Bearer token.

Step 1: Registration & API Key

To get started with RexPayments:

Register at https://portal.rexpayments.com/
Provide your Callback URL for post-payment redirects
Log in to your Profile Page to obtain your API Key
Include the API key in every request as a Bearer token

Authentication

All API requests require authentication using your API token. The token can be found in your merchant profile page.

Authentication Header (Recommended)

HTTP

Authorization: Bearer rx_your_api_token_here

Query Parameter Alternative

URL

?api_token=rx_your_api_token_here

Example Request

BASH

curl -X GET "https://portal.rexpayments.com/api/payment-links" \
  -H "Authorization: Bearer rx_your_api_token_here" \
  -H "Content-Type: application/json"

Generate Payment API

What this API does:

Instantly create a unique payment link for a specific transaction. Use this when you need to generate payment links programmatically during checkout. Customers are redirected to complete payment and then returned to your specified Success or Failure URL.

Endpoint

POST https://portal.rexpayments.com/api/generate-payment-link

Headers

Key	Value
Authorization	Bearer YOUR_API_KEY
Content-Type	application/json
Origin	https://yourdomain.com

Request Parameters

Field	Type	Status	Description
order_id	String	Required	Unique identifier for the order
amount	Decimal	Required	Payment amount to be charged (in currency units)

Example Request

BASH

curl --location 'https://portal.rexpayments.com/api/generate-payment-link' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "order_id": "123456",
  "amount": "500.00"
}'

Response

Success Response

JSON

{
  "paymentLink": "https://portal.rexpayments.com/pay-now?o=hbvt&a=g73u&us=hA%3D%3D"
}

Payment Links API

What this API does:

Create and manage reusable payment links with full control over product details, expiration dates, and payment limits. Perfect for shareable invoices, limited-time offers, and inventory-controlled sales. These links remain active until explicitly deactivated or expire.

List Payment Links

Retrieves all payment links you've createdReturns paginated results of all active and inactive payment links in your account

GET /api/payment-links

Create Payment Link

Create a new shareable payment linkOnce created, share the URL with customers. You can set expiration dates and payment limits to control when and how many times it can be used

POST /api/payment-links

Field	Type	Status	Description
product_name	String	Required	Name of the product (max 255 chars)
amount	Decimal	Required	Payment amount (min 0.01)
description	String	Optional	Product description (max 1000 chars)
expires_days	Integer	Optional	Expiration period in days (1-365)
payment_limit	Integer	Optional	Max successful payments allowed (1-1000)

BASH

curl -X POST "https://portal.rexpayments.com/api/payment-links" \
  -H "Authorization: Bearer rx_your_api_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "product_name": "Premium Plan",
    "amount": 99.99,
    "description": "Monthly subscription",
    "expires_days": 30,
    "payment_limit": 10
  }'

View Payment Link Details

Get information about a specific payment linkUse this to check the status, payment count, expiration date, and other details of a payment link

GET /api/payment-links/{order_id}

Update Payment Link

Modify a payment link's detailsYou can update the product name, description, and active status. Note: Amount, expires_days, and payment_limit cannot be changed after creation

PUT /api/payment-links/{order_id}

BASH

curl -X PUT "https://portal.rexpayments.com/api/payment-links/1" \
  -H "Authorization: Bearer rx_your_api_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "product_name": "Updated Product Name",
    "description": "Updated description",
    "active": false
  }'

Delete Payment Link

Remove a payment link permanentlyOnce deleted, customers will not be able to access the link

DELETE /api/payment-links/{order_id}

Toggle Payment Link Status

Activate or deactivate a payment linkDeactivate a link to temporarily disable it without deleting it. Reactivate it anytime

POST /api/payment-links/{order_id}/toggle

Public Checkout

Customer-facing payment pageNo authentication required. Share this link with customers directly or embed in your application

GET /pay/{slug}

Public checkout page. No authentication required.

Process Payment

Complete the payment transactionCalled by the checkout page after customer confirms payment. No authentication required

POST /pay/{slug}/process

Payment Transaction Details

What this API does:

Retrieve complete details about a specific payment transaction using its Payment ID. Use this after customers complete payments to verify transaction status, amount, currency, payment method, and other details for reconciliation and order fulfillment.

Endpoint

GET https://portal.rexpayments.com/api/transactions/{payment_id}

Response Fields

Field	Type	Description
id	String	Unique payment identifier
amount	Integer	Amount charged (in minor units)
currency	String	Currency code (e.g., usd)
status	String	Payment status (succeeded, failed, pending)
created	Integer	Timestamp in UNIX format
payment_method	String	ID of payment method used
livemode	Boolean	Indicates live or test mode

Complete Workflow

1

Register & Get API Key

Register at RexPayments portal and obtain your API key from the profile page.

2

Choose Your API

Select the appropriate endpoint for your use case. Use Generate Payment API for one-time transactions or Payment Links API for shareable, reusable links.

3

Redirect Customer

Redirect your customer to the generated payment link to complete the transaction.

4

Capture Payment Result

Customer is redirected to your callback URL with Order ID, Transaction ID, and Status.

5

Verify Transaction

Use the Transaction Details API to retrieve full details and update your order status accordingly.

Code Examples

JavaScript/Node.js

JAVASCRIPT

const axios = require("axios");

const apiToken = "rx_your_api_token_here";
const baseUrl = "https://portal.rexpayments.com/api";

// Create payment link
const createPaymentLink = async () => {
    try {
        const response = await axios.post(
            `${baseUrl}/payment-links`,
            {
                product_name: "Premium Plan",
                amount: 99.99,
                description: "Monthly subscription",
                expires_days: 30,
                payment_limit: 10
            },
            {
                headers: {
                    Authorization: `Bearer ${apiToken}`,
                    "Content-Type": "application/json"
                }
            }
        );
        console.log("Payment Link URL:", response.data.data.url);
        return response.data;
    } catch (error) {
        console.error("Error:", error.response.data);
    }
};

createPaymentLink();

Python

PYTHON

import requests

api_token = "rx_your_api_token_here"
base_url = "https://portal.rexpayments.com/api"

headers = {
    "Authorization": f"Bearer {api_token}",
    "Content-Type": "application/json"
}

payload = {
    "product_name": "Premium Plan",
    "amount": 99.99,
    "description": "Monthly subscription",
    "expires_days": 30,
    "payment_limit": 10
}

response = requests.post(
    f"{base_url}/payment-links",
    json=payload,
    headers=headers
)

if response.status_code == 201:
    payment_link = response.json()
    print(f"Payment Link: {payment_link['data']['url']}")
else:
    print(f"Error: {response.text}")

API Documentation

Overview

Secure Payment Processing Made Simple

Generate Payments API

Payment Links API

Transaction Details API

Step 1: Registration & API Key

Authentication

Authentication Header (Recommended)

Query Parameter Alternative

Example Request

Generate Payment API

Endpoint

Headers

Request Parameters

Example Request

Response

Payment Links API

List Payment Links

Create Payment Link

View Payment Link Details

Update Payment Link

Delete Payment Link

Toggle Payment Link Status

Public Checkout

Process Payment

Payment Transaction Details

Endpoint

Response Fields

Complete Workflow

Code Examples

JavaScript/Node.js

Python

Title

Title