Contracts

Summary

Contracts enable merchants to create digital agreements that customers must sign before a payment can proceed. A contract can be linked to a Payment Link (one-time payment), a Subscription (recurring payment), or an Installment plan. The customer receives the contract via email, signs it electronically (with optional document upload), and is then directed to complete payment.

Contract Lifecycle

1. Create — Merchant creates a contract with HTML content, customer, amount, and payment type. A Payment Link or Subscription is automatically created and linked.
2. Notify — Customer receives an email with a link to view and sign the contract. The email includes a “Pay Now” button directing them to the signing page.
3. View — Customer opens the contract and sees the agreement with signature fields and input fields. If a document upload is required, a file upload area is displayed.
4. Sign — Customer fills in all signature and input fields, optionally uploads a supporting document, and submits. The contract status changes to SIGNED.
5. Pay — After signing, the customer is directed to the linked Payment Link or Subscription page to complete payment. The payment page will not allow access until the contract is signed.

Contract Statuses

Processing Flow

Authentication

Merchant API (Private)

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

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

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

Customer API (Public)

Public endpoints for viewing and signing contracts do not require authentication:

GET  /api/contracts/{contract_id}/show
POST /api/contracts/{contract_id}/sign

Create Contract

POST /api/{business}/contracts

Request Body

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

{
  "contract": "<h1>Service Agreement</h1><p>I, {{ input::Full Name }}, agree to...</p><p>Signature: {{ signature }}</p>",
  "customerId": "customer-uuid",
  "amount": 500.00,
  "includeDocument": true,
  "paymentType": "1",
  "description": "Monthly service agreement"
}

{
  "ok": true,
  "contract": {
    "id": "contract-uuid",
    "contract_number": "CT-202602190001",
    "status": "UNSIGNED",
    "payment_link_id": "payment-link-uuid",
    "has_file": true,
    "created_at": "2026-02-19T12:00:00.000000Z"
  },
  "message": "Contract created successfully"
}

List Contracts

GET /api/{business}/contracts

Returns a paginated list of contracts. Includes permission flags for the current user.

{
  "ok": true,
  "contracts": { /* paginated collection */ },
  "business": { /* business object */ },
  "isRoleAdmin": true,
  "canUpdateContract": true,
  "canDeleteContract": true,
  "filters": { "fromDate": null, "toDate": null }
}

Edit Contract (Form Data)

GET /api/{business}/contracts/{contract}/edit

Returns the contract data in a format suitable for populating an edit form.

Update Contract

PUT /api/{business}/contracts/{contract}

Updates an existing contract. Only editable if the contract has not been signed and its linked payment has not been completed.

Delete Contract

DELETE /api/{business}/contracts/{contract}

Deletes a contract and its linked Payment Link or Subscription. Only deletable if the linked payment has not been completed.

{
  "ok": true,
  "message": "Contract deleted successfully"
}

Contract Details

GET /api/{business}/contracts/{contract}/details

Returns full details of a contract, including its signed content and linked payment information.

Export Contracts

GET /api/{business}/contracts/export

Returns all contracts matching the filter criteria in a JSON format suitable for CSV or spreadsheet export.

Contract Templates

List Templates

GET /api/{business}/contracts/templates

Returns all saved contract templates for the business.

Save Template

POST /api/{business}/contracts/storeTemplate

Saves the current contract content as a reusable template. The placeholder [Your business name] is automatically replaced with the business legal name when used.

View Contract (Public)

GET /api/contracts/{contract}/show

Loads the contract for the customer to view and sign. Returns the contract HTML, business branding (logo), customer email, and 3D Secure configuration.

{
  "ok": true,
  "contract": {
    "id": "contract-uuid",
    "content": "<h1>Service Agreement</h1>...",
    "status": "UNSIGNED",
    "has_file": true
  },
  "business": { "legal_name": "Acme Corp" },
  "logo": "https://s3.amazonaws.com/...",
  "dddSecure": true,
  "customerEmail": "[email protected]"
}

Sign Contract (Public)

POST /api/contracts/{contract}/sign

Submits the customer's signatures, input values, and optional document. Uses multipart/form-data when a file is included.

Request Body

{
  "ok": true,
  "signed_content": "<h1>Service Agreement</h1><p>I, John Doe, agree to...</p>...",
  "message": "Contract signed successfully"
}

Payment Types

Frequency Options (Sequence)

Template Placeholders

<h1>Service Agreement</h1>
<p>This agreement is entered into between
   <strong>[Your business name]</strong> and
   <strong>{{ input::Full Name }}</strong>.</p>

<p>The customer agrees to the terms outlined herein
   on <strong>{{ input::Date }}</strong>.</p>

<p>Customer Signature:</p>
<p>{{ signature }}</p>

File Upload

When includeDocument is set to true during contract creation, the customer is required to upload a supporting document at signing time.

All Endpoints

Merchant Endpoints (Authenticated)

Public Endpoints (No Authentication)

Error Handling

Notifications