Payment Pages

Summary

Payment Pages are reusable, shareable hosted checkout pages that allow merchants to accept payments without building a custom payment form. Unlike Payment Links (which are single-use with a fixed amount), Payment Pages can be used multiple times and the customer enters the payment amount at checkout.

Payment Page Lifecycle

1. Create — Merchant creates a payment page with a name, optional description, surcharge, tax, and 3D Secure settings.
2. Share — The page is accessible via a public URL using the business slug and page slug: /payment_pages/{business_slug}/{page_slug}/pay
3. Customer Registration — Before paying, the customer provides their name, email, and phone number to create or retrieve a customer record.
4. Pay — Customer enters the desired amount, fills in card details, and submits. 3D Secure step-up is triggered if enabled.
5. Result — On approval, a transaction is recorded. Both merchant and customer receive payment confirmation emails. The page remains active for future payments.

Payment Pages vs Payment Links

Processing Flow

Authentication

Merchant API (Private)

All merchant-facing endpoints require a valid Bearer token via the Authorization header and are scoped to a business:

Authorization: Bearer {access_token}
Content-Type: application/json

Base URL pattern: /api/{business_id}/payment_pages

Customer API (Public)

Public endpoints do not require authentication. They are accessed by slug-based URLs:

GET  /api/payment_pages/{business_slug}/{page_slug}/pay
POST /api/payment_pages/{business_slug}/{page_slug}/pay

Create Payment Page

POST /api/{business}/payment_pages

Request Body

POST /api/{business}/payment_pages
Content-Type: application/json
Authorization: Bearer {token}

{
  "name": "Donation Page",
  "description": "Support our community initiative",
  "surcharge": false,
  "threeDSecure": true,
  "tax": 0
}

{
  "ok": true,
  "payment_page": {
    "id": "uuid",
    "name": "Donation Page",
    "slug": "donation-page",
    "description": "Support our community initiative",
    "surcharge": false,
    "three_d_secure": true,
    "tax": 0,
    "created_at": "2026-02-19T12:00:00.000000Z"
  }
}

List Payment Pages

GET /api/{business}/payment_pages

Returns a paginated list of all payment pages belonging to the business.

Query Parameters

{
  "ok": true,
  "payment_pages": {
    "data": [ /* array of payment page objects */ ],
    "current_page": 1,
    "per_page": 10,
    "total": 5
  },
  "business": { /* business object with configurations */ },
  "filters": { "fromDate": null, "toDate": null }
}

Get Page Details

GET /api/{business}/payment_pages/{payment_page}

Returns full details for a single payment page by its UUID.

Update Payment Page

PUT /api/{business}/payment_pages/{payment_page}

Request Body

{
  "ok": true,
  "payment_page": { /* updated payment page object */ }
}

Delete Payment Page

DELETE /api/{business}/payment_pages/{payment_page}

Permanently deletes a payment page. This action cannot be undone. The public URL will no longer be accessible.

{
  "ok": true,
  "message": "Payment page deleted successfully"
}

Payment Attempts

GET /api/{business}/payment_pages/{payment_page}/attempts

Returns a list of all payment attempts (successful and failed) made through this payment page. Requires ownership verification.

{
  "ok": true,
  "attempts": [
    {
      "id": "uuid",
      "amount": 50.00,
      "status": "approved",
      "customer": { "name": "John Doe", "email": "[email protected]" },
      "created_at": "2026-02-19T14:30:00.000000Z"
    }
  ]
}

Create / Find Customer (Public)

POST /api/{business}/public/customers

Before paying through a payment page, the customer must be identified. If a customer with the given email already exists, their existing ID is returned.

Request Body

{
  "ok": true,
  "customerId": "customer-uuid"
}

View Payment Page (Public)

GET /api/payment_pages/{business_slug}/{page_slug}/pay

Loads the payment page details for customer display. No authentication required.

{
  "ok": true,
  "paymentPage": {
    "name": "Donation Page",
    "description": "Support our community initiative",
    "surcharge": false,
    "tax": 0
  },
  "logo": "https://s3.amazonaws.com/...",
  "dddSecure": true,
  "three_d_secure": true
}

Pay via Payment Page (Public)

POST /api/payment_pages/{business_slug}/{page_slug}/pay

Request Body

POST /api/payment_pages/my-business/donation-page/pay
Content-Type: application/json

{
  "amount": 50.00,
  "customerId": "customer-uuid",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "John Doe",
    "month": "12",
    "year": 2028,
    "cvv": "123",
    "saveCard": false
  }
}

{
  "ok": true,
  "result": {
    "code": "000",
    "recordID": "txn-uuid",
    "message": "Approved"
  }
}

3D Secure Flow

When 3D Secure is enabled on the payment page (and the business has 3DS configured), the payment process includes an additional authentication step.

Step 1 — Initialize 3DS Session

POST /api/ddd/init

{
  "amount": 50.00,
  "cardNumber": "4111111111111111",
  "businessId": "business-uuid"
}

{
  "ok": true,
  "threeDSecureId": "session-uuid",
  "acsURL": "https://acs.issuer-bank.com/...",
  "creq": "base64-encoded-challenge-request",
  "transStatus": "C"
}

Step 2 — Authenticate

POST /api/ddd/authenticate

{
  "threeDSecureId": "session-uuid"
}

{
  "ok": true,
  "transStatus": "Y",
  "eci": "05",
  "authenticationValue": "base64-cavv-value"
}

Transaction Status Codes

All Endpoints

Merchant Endpoints (Authenticated)

Public Endpoints (No Authentication)

Card Data Fields

Error Handling

Notifications

After a successful payment, RapidCents sends email notifications to both the customer and the merchant.