Skip to Content
API ReferenceCurrency API

Currency API

Endpoints for managing currencies in the system.

Get Currencies List

Get the complete list of currencies.

Request

GET /api/currencies

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Query Parameters

NameTypeDescription
pageintegerOptional. Page number
limitintegerOptional. 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

FieldTypeDescription
currenciesarrayArray of currencies
idintegerCurrency ID
codestringCurrency code
minimum_valuenumberMinimum value for payment
exchange_ratenumberExchange rate relative to base currency
paginationobjectPagination information

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request

Get Currency Data

Get detailed information about a specific currency.

Request

GET /api/currencies/{id}

Path Parameters

NameTypeDescription
idintegerCurrency ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "currency": { "id": 1, "code": "USD", "minimum_value": 1.0, "exchange_rate": 1.0 } }

Response Fields

FieldTypeDescription
currencyobjectCurrency object
idintegerCurrency ID
codestringCurrency code
minimum_valuenumberMinimum value for payment
exchange_ratenumberExchange rate relative to base currency

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request
404Currency not found

Create Currency

Create a new currency in the system.

Request

POST /api/currencies

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "code": "GBP", "minimum_value": 1.0, "exchange_rate": 0.75 }

Request Body Parameters

NameTypeDescription
codestringRequired. Currency code (3 characters)
minimum_valuenumberRequired. Minimum value for payment
exchange_ratenumberRequired. Exchange rate

Response

{ "message": "Currency created successfully", "currency": { "id": 4, "code": "GBP", "minimum_value": 1.0, "exchange_rate": 0.75 } }

Response Codes

CodeDescription
201Currency successfully created
401Invalid or missing API key
403Insufficient permissions to perform request
422Invalid request parameters

Update Currency

Update an existing currency.

Request

PUT /api/currencies/{id}

Path Parameters

NameTypeDescription
idintegerCurrency ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "code": "GBP", "minimum_value": 2.0, "exchange_rate": 0.78 }

Request Body Parameters

NameTypeDescription
codestringOptional. Currency code (3 characters)
minimum_valuenumberOptional. Minimum value for payment
exchange_ratenumberOptional. Exchange rate

Response

{ "message": "Currency updated successfully", "currency": { "id": 4, "code": "GBP", "minimum_value": 2.0, "exchange_rate": 0.78 } }

Response Codes

CodeDescription
200Currency successfully updated
401Invalid or missing API key
403Insufficient permissions to perform request
404Currency not found
422Invalid request parameters

Delete Currency

Delete a currency from the system.

Request

DELETE /api/currencies/{id}

Path Parameters

NameTypeDescription
idintegerCurrency ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "message": "Currency deleted successfully" }

Response Codes

CodeDescription
200Currency successfully deleted
401Invalid or missing API key
403Insufficient permissions to perform request
404Currency not found
409Currency 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

NameTypeDescription
idintegerCurrency ID

Headers

NameTypeDescription
X-API-KeystringRequired. 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

CodeDescription
200Currency successfully set as default
401Invalid or missing API key
403Insufficient permissions to perform request
404Currency not found