Currency API
Endpoints for managing currencies in the system.
Get Currencies List
Get the complete list of currencies.
Request
GET /api/currencies
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Query Parameters
Name | Type | Description |
---|---|---|
page | integer | Optional. Page number |
limit | integer | Optional. Records per page |
Response
{
"currencies": [
{
"id": 1,
"code": "USD",
"minimum_value": 1.0,
"exchange_rate": 1.0
},
{
"id": 2,
"code": "EUR",
"minimum_value": 1.0,
"exchange_rate": 0.85
},
{
"id": 3,
"code": "RUB",
"minimum_value": 100.0,
"exchange_rate": 75.5
}
],
"pagination": {
"total": 5,
"per_page": 10,
"current_page": 1,
"last_page": 1
}
}
Response Fields
Field | Type | Description |
---|---|---|
currencies | array | Array of currencies |
id | integer | Currency ID |
code | string | Currency code |
minimum_value | number | Minimum value for payment |
exchange_rate | number | Exchange rate relative to base currency |
pagination | object | Pagination information |
Response Codes
Code | Description |
---|---|
200 | Successful request |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
Get Currency Data
Get detailed information about a specific currency.
Request
GET /api/currencies/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Currency ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Response
{
"currency": {
"id": 1,
"code": "USD",
"minimum_value": 1.0,
"exchange_rate": 1.0
}
}
Response Fields
Field | Type | Description |
---|---|---|
currency | object | Currency object |
id | integer | Currency ID |
code | string | Currency code |
minimum_value | number | Minimum value for payment |
exchange_rate | number | Exchange rate relative to base currency |
Response Codes
Code | Description |
---|---|
200 | Successful request |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Currency not found |
Create Currency
Create a new currency in the system.
Request
POST /api/currencies
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Content-Type | string | Required. application/json |
Request Body
{
"code": "GBP",
"minimum_value": 1.0,
"exchange_rate": 0.75
}
Request Body Parameters
Name | Type | Description |
---|---|---|
code | string | Required. Currency code (3 characters) |
minimum_value | number | Required. Minimum value for payment |
exchange_rate | number | Required. Exchange rate |
Response
{
"message": "Currency created successfully",
"currency": {
"id": 4,
"code": "GBP",
"minimum_value": 1.0,
"exchange_rate": 0.75
}
}
Response Codes
Code | Description |
---|---|
201 | Currency successfully created |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
422 | Invalid request parameters |
Update Currency
Update an existing currency.
Request
PUT /api/currencies/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Currency ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Content-Type | string | Required. application/json |
Request Body
{
"code": "GBP",
"minimum_value": 2.0,
"exchange_rate": 0.78
}
Request Body Parameters
Name | Type | Description |
---|---|---|
code | string | Optional. Currency code (3 characters) |
minimum_value | number | Optional. Minimum value for payment |
exchange_rate | number | Optional. Exchange rate |
Response
{
"message": "Currency updated successfully",
"currency": {
"id": 4,
"code": "GBP",
"minimum_value": 2.0,
"exchange_rate": 0.78
}
}
Response Codes
Code | Description |
---|---|
200 | Currency successfully updated |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Currency not found |
422 | Invalid request parameters |
Delete Currency
Delete a currency from the system.
Request
DELETE /api/currencies/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Currency ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Response
{
"message": "Currency deleted successfully"
}
Response Codes
Code | Description |
---|---|
200 | Currency successfully deleted |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Currency not found |
409 | Currency is in use and cannot be deleted |
Set Default Currency
Set a currency as the default one.
Request
POST /api/currencies/{id}/default
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Currency ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Response
{
"message": "Currency set as default successfully",
"currency": {
"id": 1,
"code": "USD",
"minimum_value": 1.0,
"exchange_rate": 1.0,
"is_default": true
}
}
Response Codes
Code | Description |
---|---|
200 | Currency successfully set as default |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Currency not found |