Transactions API

v1.0 • REST • JSON

Full CRUD management for transaction accounts. Create, retrieve, update, and delete transaction records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/transactions

Quick Reference

GET
/api/transactions List all transactions (paginated)
200 GET
/api/transactions/{id} Get one transaction by ID
200 POST
/api/transactions Create a new transaction
201 PUT
/api/transactions/{id} Replace transaction data
204 DEL
/api/transactions/{id} Remove a transaction
204 GET
/api/transactions/{id} Transaction not found example
404
GET /api/transactions 200 OK

Get All Transactions

Retrieves a paginated list of all transactions in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/transactions/{id} 200 OK

Get Single Transaction

Fetch the full profile for a specific transaction using their numeric ID. Returns all transaction fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique transaction identifier
Response: 200 OK
GET /api/transactions/{id} 404 Not Found

Transaction Not Found

Returned when the requested transaction ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing transaction resources.

Response: 404 Not Found
POST /api/transactions 201 Created

Create Transaction

Registers a new transaction with the provided details. On success, returns the newly created transaction object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
paymentId integer Required Payment id
Body
Response: 201 Created
PUT /api/transactions/{id} 200 OK

Update Transaction

Fully replaces an existing transaction's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
paymentId integer Required Payment id
Body
Response: 200 OK
DELETE /api/transactions/{id} 204 No Content

Delete Transaction

Permanently removes a transaction from the system by their ID. This action is irreversible once deleted, the transaction record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the transaction to delete
Response: 204 No Content