As the name suggests, the banks’ plugin allows you to add, remove, edit, and view banks. It is mostly meant for use by other plugins.
End Points
Bank (/bank)
| Title | /bank |
| Method | GET |
| URL | GET /bank |
| Description | Attempts to read first 100 banks and returns them. |
| Query Parameters | |
| Response | Status Code: 200 { name: String (Bank name) address: String? (Bank address, nullable) id: int (The unique ID of bank) } |
| Requires Auth | YES |
| Title | /bank |
| Method | POST |
| URL | POST /bank |
| Description | Create a new bank |
| Body Parameters | { data: { name: String address1: String address2: String? address3: String? } } |
| Response | Status Code: 200 { name: String (Bank name) address1: String address2: String? address3: String? id: int (The unique ID of the bank) } |
| Requires Auth | YES |
| Title | /bank/:id |
| Method | PATCH |
| URL | PATCH /bank/:id |
| Description | Update a bank by its ID |
| Body Parameters | { data: { name: String address1: String address2: String? address3: String? } } |
| Response | Status Code: 200 { name: String (Bank name) address1: String address2: String? address3: String? id: int (The unique ID of the bank) } |
| Requires Auth | YES |
| Title | /bank/:id |
| Method | DELETE |
| URL | DELETE /bank |
| Description | Delete a bank by its ID |
| Query Parameters | |
| Response | Status Code: 200 { success: boolean } |
| Requires Auth | YES |
| Title | /bank/:id |
| Method | GET |
| URL | GET /bank/:id |
| Description | Fetch bank details by its ID. |
| Query Parameters | |
| Response | Status Code: 200 { id: number name: String address1: String address2: String? address3: String? } |
| Requires Auth | YES |
For Developers:
I probably don’t have to mention, the data is fetched from the bank table. You can add any related routes or frontend to this plugin.
