Business API Design Specification - Create Paymenttransaction

A Business API is a set of logical actions centered around a main data object. These actions can range from simple CRUD operations to complex workflows that implement intricate business logic.

While the term “API” traditionally refers to an interface that allows software systems to interact, in Mindbricks a Business API represents a broader concept. It encapsulates a business workflow around a data object, going beyond basic CRUD operations to include rich, internally coordinated actions that can be fully designed and customized.

This document provides an in-depth explanation of the architectural design of the createPaymentTransaction Business API. It is intended to guide backend architects and developers in maintaining the current design. Additionally, frontend developers and frontend AI agents can use this document to understand how to properly consume this API on the client side.

Main Data Object and CRUD Operation

The createPaymentTransaction Business API is designed to handle a create operation on the PaymentTransaction data object. This operation is performed under the specified conditions and may include additional, coordinated actions as part of the workflow.

API Description

Create a paymentTransaction to initiate a Stripe Checkout for premium upgrade on a listing. Checks listing and user, prevents duplicate active payments, creates transaction with status=‘pending’, triggers Stripe checkout, and returns checkout session URL/info.

API Frontend Description By The Backend Architect

Initiate Premium Payment

API Options

API Controllers

A Mindbricks Business API can be accessed through multiple interfaces, including REST, gRPC, WebSocket, Kafka, or Cron. The controllers listed below map the business workflow to a specific interface, enabling consistent interaction regardless of the communication channel.

REST Controller

The createPaymentTransaction Business API includes a REST controller that can be triggered via the following route:

/v1/payments/create

By sending a request to this route using the service API address, you can execute this Business API. Parameters can be provided in multiple HTTP locations, including the URL path, URL query, request body, and request headers. Detailed information about these parameters is provided in the Parameters section.

MCP Tool

REST controllers also expose the Business API as a tool in the MCP, making it accessible to AI agents. This createPaymentTransaction Business API will be registered as a tool on the MCP server within the service binding.

API Parameters

The createPaymentTransaction Business API has 3 parameters that must be sent from the controller. Note that all parameters, except session and Redis parameters, should be provided by the client.

Business API parameters can be:

Regular Parameters

Name Type Required Default Location Data Path
paymentTransactionId ID No - body paymentTransactionId
Description: This id paremeter is used to create the data object with a given specific id. Leave null for automatic id.
listingId ID Yes `` body listingId
Description: ID of the listing to upgrade to premium
premiumType String Yes `` body premiumType
Description: PremiumType to purchase (‘bronze’, ‘silver’, ‘gold’)

Parameter Transformations

Some parameters are post-processed using transform scripts after being read from the request but before validation or workflow execution. Only parameters with a transform script are listed below.

No parameters are transformed in this API.

AUTH Configuration

The authentication and authorization configuration defines the core access rules for the createPaymentTransaction Business API. These checks are applied after parameter validation and before executing the main business logic.

While these settings cover the most common scenarios, more fine-grained or conditional access control—such as permissions based on object context, nested memberships, or custom workflows—should be implemented using explicit actions like PermissionCheckAction, MembershipCheckAction, or ObjectPermissionCheckAction.

Login Requirement

This API requires login (loginRequired = true). Requests from non-logged-in users will return a 401 Unauthorized error. Login is necessary but not sufficient, as additional role, permission, or other authorization checks may still apply.

Ownership Checks

Role and Permission Settings

Data Clause

Defines custom field-value assignments used to modify or augment the default payload for create and update operations. These settings override values derived from the session or parameters if explicitly provided.", Note that a default data clause is always prepared by Mindbricks using data property settings, however any property in the data clause can be override by Data Clause Settings.

Custom Data Clause Override

{
    userId: this.session.userId,
    listingId: this.listingId,
    premiumType: this.premiumType,
    status: 'pending',
   
}

Actual Data Clause

The business api will use the following data clause. Note that any calculated value will be added to the data clause in the api manager. 

{
  id: this.paymentTransactionId,
  amount: this.amount,
  currency: this.currency,
  listingId: this.listingId,
  paymentConfirmedAt: this.paymentConfirmedAt,
  premiumType: this.premiumType,
  status: 'pending',
  stripeEventId: this.stripeEventId,
  stripeSessionId: this.stripeSessionId,
  userId: this.session.userId,
}

Business Logic Workflow

[1] Step : startBusinessApi

Manager initializes context, populates session and request objects, prepares internal structures for parameter handling and workflow execution.

You can use the following settings to change some behavior of this step. apiOptions, restSettings, grpcSettings, kafkaSettings, socketSettings, cronSettings

[2] Step : readParameters

Manager reads input parameters, normalizes missing values, applies default type casting, and stores them in the API context.

You can use the following settings to change some behavior of this step. customParameters, redisParameters

[3] Action : fetchListing

Action Type: FetchObjectAction

Fetch the target listing to confirm it exists and is valid for payment 

class Api {
  async fetchListing() {
    // Fetch Object on childObject listing

    const userQuery = {
      $and: [{ id: this.listingId }, { isActive: true }],
    };
    const { convertUserQueryToElasticQuery } = require("common");
    const scriptQuery = convertUserQueryToElasticQuery(userQuery);

    const elasticIndex = new ElasticIndexer("listing");
    const data = await elasticIndex.getOne(scriptQuery);

    if (!data) {
      throw new NotFoundError("errMsg_FethcedObjectNotFound:listing");
    }

    return data
      ? {
          id: data["id"],
          userId: data["userId"],
          status: data["status"],
          isPremium: data["isPremium"],
          premiumType: data["premiumType"],
          premiumExpiry: data["premiumExpiry"],
        }
      : null;
  }
}

[4] Step : transposeParameters

Manager transforms parameters, computes derived values, flattens or remaps arrays/objects, and adjusts formats for downstream processing.

[5] Step : checkParameters

Manager executes built-in validations: required field checks, type enforcement, and basic business rules. Prevents operation if validation fails.

[6] Action : validateListingOwnership

Action Type: ValidationAction

User must be owner of the listing to upgrade premium

class Api {
  async validateListingOwnership() {
    if (this.checkAbsolute()) return true;

    const isValid = this.listing.userId === this.session.userId;

    if (!isValid) {
      throw new ForbiddenError("You do not own this listing.");
    }
    return isValid;
  }
}

[7] Action : validateListingStatus

Action Type: ValidationAction

Listing must be active or pending_review for upgrade.

class Api {
  async validateListingStatus() {
    const isValid = ["active", "pending_review"].includes(this.listing.status);

    if (!isValid) {
      throw new BadRequestError("Listing not eligible for upgrade.");
    }
    return isValid;
  }
}

[8] Action : validateNoDuplicatePayment

Action Type: ValidationAction

No existing pending/awaiting/success payment for this listing/premiumType by this user. 

class Api {
  async validateNoDuplicatePayment() {
    const isValid = !(
      this.existingPayments && this.existingPayments.length > 0
    );

    if (!isValid) {
      throw new BadRequestError(
        "Duplicate or unconfirmed payment detected for this upgrade. Please wait or contact support.",
      );
    }
    return isValid;
  }
}

[9] Step : checkBasicAuth

Manager performs authentication and authorization checks: verifies session, user roles, permissions, and tenant restrictions.

You can use the following settings to change some behavior of this step. authOptions

[10] Step : buildDataClause

Manager constructs the final data object for creation, fills auto-generated fields (IDs, timestamps, owner fields), and ensures schema consistency.

You can use the following settings to change some behavior of this step. dataClause

[11] Action : calculateAmountForPremium

Action Type: FunctionCallAction

Determine the amount to be charged for the selected premiumType. (Replace with dynamic lookup as needed.) 

class Api {
  async calculateAmountForPremium() {
    try {
      return LIB.getPremiumPrice(this.premiumType);
    } catch (err) {
      console.error(
        "Error in FunctionCallAction calculateAmountForPremium:",
        err,
      );
      throw err;
    }
  }
}

[12] Action : setAmountContext

Action Type: AddToContextAction

Sets the calculated amount and currency for paymentTransaction creation. 

class Api {
  async setAmountContext() {
    try {
      this["amount"] = this.amountInfo.amount;

      this["currency"] = this.amountInfo.currency;

      return true;
    } catch (error) {
      console.error("AddToContextAction error:", error);
      throw error;
    }
  }
}

[13] Step : mainCreateOperation

Manager executes the database insert operation, updates indexes/caches, and triggers internal post-processing like linked default records.

[14] Action : stripeCheckoutAction

Action Type: PaymentAction

Initiates Stripe Checkout session after DB paymentTransaction created. Stores returned sessionId in DB. 

class Api {
  throwstripeCheckoutActionConfigError() {
    throw new HttpServerError(
      "errMsg_ActionConfigError:Stripe Configuration For The Object Is Not Activated",
    );
  }

  getOrderId() {
    this.throwstripeCheckoutActionConfigError();
  }

  paymentUpdated() {
    this.throwstripeCheckoutActionConfigError();
  }

  paymentStarted() {
    this.throwstripeCheckoutActionConfigError();
  }

  paymentCanceled() {
    this.throwstripeCheckoutActionConfigError();
  }
  paymentFailed() {
    this.throwstripeCheckoutActionConfigError();
  }
  paymentDone() {
    this.throwstripeCheckoutActionConfigError();
  }

  getPaymentParameters(userParams) {
    this.throwstripeCheckoutActionConfigError();
  }
  async stripeCheckoutAction() {
    this.throwstripeCheckoutActionConfigError();
  }
}

[15] Step : buildOutput

Manager shapes the response: masks sensitive fields, resolves linked references, and formats output according to API contract.

[16] Action : addCheckoutSessionUrl

Action Type: AddToResponseAction

Returns the Stripe checkout session URL to frontend after DB insert and Stripe call. 

class Api {
  async addCheckoutSessionUrl() {
    try {
      this.output["checkoutSessionUrl"] = this.checkoutSession.url;

      this.output["transactionId"] = this.paymentTransaction.id;

      return true;
    } catch (error) {
      console.error("AddToResponseAction error:", error);
      throw error;
    }
  }
}

[17] Step : sendResponse

Manager sends the response to the client and finalizes internal tasks like flushing logs or updating session state.

[18] Step : raiseApiEvent

Manager triggers API-level events (Kafka, WebSocket, async workflows) as the final internal step.

Rest Usage

Rest Client Parameters

Client parameters are the api parameters that are visible to client and will be populated by the client. Note that some api parameters are not visible to client because they are populated by internal system, session, calculation or joint sources.

The createPaymentTransaction api has got 2 regular client parameters

Parameter Type Required Population
listingId ID true request.body?.[“listingId”]
premiumType String true request.body?.[“premiumType”]

REST Request

To access the api you can use the REST controller with the path POST /v1/payments/create 

  axios({
    method: 'POST',
    url: '/v1/payments/create',
    data: {
            listingId:"ID",  
            premiumType:"String",  
    
    },
    params: {
    
        }
  });

REST Response

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the “Error Response” section.

Following JSON represents the most comprehensive form of the paymentTransaction object in the respones. However, some properties may be omitted based on the object’s internal logic. 

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "paymentTransaction",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"paymentTransaction": {
		"id": "ID",
		"amount": "Double",
		"currency": "String",
		"listingId": "ID",
		"paymentConfirmedAt": "Date",
		"premiumType": "Enum",
		"premiumType_idx": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"stripeEventId": "String",
		"stripeSessionId": "String",
		"userId": "ID",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}