Payments API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Payments

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

Get Single Payment

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

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

Payment Not Found

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

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

Create Payment

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

Request Body
Field Type Required Description
orderId integer Required Order id
amount decimal Required Amount
provider string Required Provider
Body
Response: 201 Created
PUT /api/payments/{id} 200 OK

Update Payment

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

Request Body
Field Type Required Description
orderId integer Required Order id
amount decimal Required Amount
provider string Required Provider
Body
Response: 200 OK
DELETE /api/payments/{id} 204 No Content

Delete Payment

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

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