Refunds API

v1.0 • REST • JSON

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

GET POST PUT DELETE 5 Endpoints Auth Required
Base URL https://bogusapi.com/api/refunds

Quick Reference

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

Get All Refunds

Retrieves a paginated list of all refunds 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/refunds/{id} 200 OK

Get Single Refund

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

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

Refund Not Found

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

Response: 404 Not Found 
{}
POST /api/refunds 201 Created

Create Refund

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

Request Body
FieldTypeRequiredDescription
firstName string Required Refund's given name
lastName string Required Refund's family name
email string Required Unique email address
password string Required Plaintext password for the account
roleIds integer[] Optional IDs of roles to assign on creation
Body
Response: 201 Created
PUT /api/refunds/{id} 200 OK

Update Refund

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

Request Body
FieldTypeRequiredDescription
firstName string Required Updated first name
lastName string Required Updated last name
email string Required Updated email address
roleIds integer[] Optional New role assignment (replaces existing)
Body
Response: 200 OK
DELETE /api/refunds/{id} 204 No Content

Delete Refund

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

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