Api DocumentationClientTransaction

Transaction Operations

POST /transaction

Description: Initiates a new transaction between users.

Request Body:

{
  "from_user_id": "46c7dc1e-c229-4f9f-83d6-d64851bedde7",
  "to_user_id": "e6ee0af8-c1e2-471f-9a51-fb26bd7621c8",
  "benif_bank_id": "178621e1-ac93-48dc-9f07-b55b2d5b7746",
  "amount": 100
}

Success Response (200 OK):

{
  "status": true,
  "code": 200,
  "message": "Transaction created successfully!",
  "data": [
    {
      "transaction_id": "186b2f70-c317-41f3-affb-c2f38fe92d7f",
      "reference_id": null,
      "client_id": "bcf61fbb-2219-4999-b8d8-ca3a9815e163",
      "from_user_id": "46c7dc1e-c229-4f9f-83d6-d64851bedde7",
      "to_user_id": "e6ee0af8-c1e2-471f-9a51-fb26bd7621c8",
      "benif_bank_id": "178621e1-ac93-48dc-9f07-b55b2d5b7746",
      "currency_code": "INR",
      "transaction_type": "credit",
      "amount": "100.00",
      "utr": "UTR12345****",
      "transaction_status": "success",
      "created_at": "2025-05-28T09:35:27.249Z",
      "updated_at": "2025-06-04T08:58:51.934Z",
      "benif_bank": {
        "bank_id": "178621e1-ac93-48dc-9f07-b55b2d5b7746",
        "user_id": "e6ee0af8-c1e2-471f-9a51-fb26bd7621c8",
        "bank_name": null,
        "account_number": "664835****",
        "ifsc_code": "KKBK000***",
        "bank_status": "success"
      }
    }
  ]
}

GET /transaction?page=“page_number”

Description: Retrieves a paginated list of all transactions.

Query Parameters:

  • page: The page number to retrieve (e.g., 1).

Success Response (200 OK):

{
    "status": true,
    "code": 200,
    "message": "Transaction fetched successfully",
    "data": {
        "total_transation": 1,
        "page": 1,
        "limit": 10,
        "total_pages": 1,
        "transactions": [
            {
                "transaction_id": "df655b87-eeff-490c-8dd8-4f3ab7dbbf97",
                "reference_id": null,
                "client_id": "73e225cf-aefb-409d-ba2c-16bf5fb5aed4",
                "from_user_id": "51562ac1-6855-484f-b2cd-a1f319d51e34",
                "to_user_id": "f08360bd-d5b6-462b-9b44-eb457dea2655",
                "benif_bank_id": "8facd560-4233-47db-ace6-b68b50a0b07c",
                "currency_code": "INR",
                "transaction_type": "debit",
                "amount": "1000.00",
                "utr": null,
                "transaction_status": "pending",
                "created_at": "2025-06-04T09:53:47.741Z",
                "updated_at": "2025-06-04T09:53:47.741Z",
                "benif_bank": {
                    "bank_id": "8facd560-4233-47db-ace6-b68b50a0b07c",
                    "user_id": "f08360bd-d5b6-462b-9b44-eb457dea2655",
                    "bank_name": null,
                    "account_number": "664835***",
                    "ifsc_code": "KKBK000***",
                    "bank_status": "success"
                }
	}
    ]
}

GET /transaction/:transaction_id

Description: Retrieves a specific transaction’s information by its ID.

Success Response (200 OK):

{
  "status": true,
  "code": 200,
  "message": "Transaction fetched successfully",
  "data": [
    {
      "transaction_id": "df655b87-eeff-490c-8dd8-4f3ab7dbbf97",
      "reference_id": null,
      "client_id": "73e225cf-aefb-409d-ba2c-16bf5fb5aed4",
      "from_user_id": "51562ac1-6855-484f-b2cd-a1f319d51e34",
      "to_user_id": "f08360bd-d5b6-462b-9b44-eb457dea2655",
      "benif_bank_id": "8facd560-4233-47db-ace6-b68b50a0b07c",
      "currency_code": "INR",
      "transaction_type": "debit",
      "amount": "1000.00",
      "utr": null,
      "transaction_status": "pending",
      "created_at": "2025-06-04T09:53:47.741Z",
      "updated_at": "2025-06-04T09:53:47.741Z",
      "benif_bank": {
        "bank_id": "8facd560-4233-47db-ace6-b68b50a0b07c",
        "user_id": "f08360bd-d5b6-462b-9b44-eb457dea2655",
        "bank_name": null,
        "account_number": "664835****",
        "ifsc_code": "KKBK000***",
        "bank_status": "success"
      }
    }
  ]
}
BankWebhooks