> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mycargoextra.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mycargoextra.com/_mcp/server. # Get Currency By ID GET http://localhost:9000/api/v1/currency_admin/{currencyId} Returns one currency. Requires role `4`. Path parameter: `currencyId`. Response fields: normalized currency document. Possible errors: - 401: Unauthorized - authenticated admin is not role `4`. - 400: Only one currency can be base - another base currency exists. - 400: Invalid Update - unsupported field or invalid currency id. - 404: Not Found - currency id does not exist. - 400: Can't disable base - base currency cannot be disabled. - 400: Currency requires an active payment method - active currency has no active payment method. - 400: Payment method is disabled - configured method is not allowed for currency. - 400: Missing One or More Required Parameters - required body/query fields were not supplied. - 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found. - 403: Access denied - gateway traffic guard/rate policy blocked the request. - 429: Too many requests - gateway rate limit exceeded. - 500: Unexpected Error - unhandled gateway or downstream service failure. Reference: https://docs.mycargoextra.com/cargo-extra-gateway-api-copy/currency-admin/currency-id/get-currency-by-id ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/v1/currency_admin/{currencyId}: get: operationId: get-currency-by-id summary: Get Currency By ID description: >- Returns one currency. Requires role `4`. Path parameter: `currencyId`. Response fields: normalized currency document. Possible errors: - 401: Unauthorized - authenticated admin is not role `4`. - 400: Only one currency can be base - another base currency exists. - 400: Invalid Update - unsupported field or invalid currency id. - 404: Not Found - currency id does not exist. - 400: Can't disable base - base currency cannot be disabled. - 400: Currency requires an active payment method - active currency has no active payment method. - 400: Payment method is disabled - configured method is not allowed for currency. - 400: Missing One or More Required Parameters - required body/query fields were not supplied. - 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found. - 403: Access denied - gateway traffic guard/rate policy blocked the request. - 429: Too many requests - gateway rate limit exceeded. - 500: Unexpected Error - unhandled gateway or downstream service failure. tags: - subpackage_currencyAdmin.subpackage_currencyAdmin/currencyId parameters: - name: currencyId in: path description: CurrencyId path parameter. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/currency_admin_{currencyId}_Get Currency By ID_Response_200 '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Currency_adminCurrencyidRequestBadRequestError '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Currency_adminCurrencyidRequestUnauthorizedError '403': description: Forbidden content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Currency_adminCurrencyidRequestForbiddenError '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Currency_adminCurrencyidRequestNotFoundError '429': description: Too Many Requests content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Currency_adminCurrencyidRequestTooManyRequestsError '500': description: Internal Server Error content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Currency_adminCurrencyidRequestInternalServerError servers: - url: http://localhost:9000 description: http://localhost:9000 components: schemas: currency_admin_{currencyId}_Get Currency By ID_Response_200: type: object properties: key_0: type: integer key_1: type: string key_2: type: number format: double key_3: type: string key_4: type: boolean required: - key_0 - key_1 - key_2 - key_3 - key_4 title: currency_admin_{currencyId}_Get Currency By ID_Response_200 GetApiV1Currency_adminCurrencyidRequestBadRequestError: type: object properties: message: type: string required: - message title: GetApiV1Currency_adminCurrencyidRequestBadRequestError GetApiV1Currency_adminCurrencyidRequestUnauthorizedError: type: object properties: message: type: string required: - message title: GetApiV1Currency_adminCurrencyidRequestUnauthorizedError GetApiV1Currency_adminCurrencyidRequestForbiddenError: type: object properties: message: type: string required: - message title: GetApiV1Currency_adminCurrencyidRequestForbiddenError GetApiV1Currency_adminCurrencyidRequestNotFoundError: type: object properties: message: type: string required: - message title: GetApiV1Currency_adminCurrencyidRequestNotFoundError GetApiV1Currency_adminCurrencyidRequestTooManyRequestsError: type: object properties: message: type: string required: - message title: GetApiV1Currency_adminCurrencyidRequestTooManyRequestsError GetApiV1Currency_adminCurrencyidRequestInternalServerError: type: object properties: message: type: string required: - message title: GetApiV1Currency_adminCurrencyidRequestInternalServerError ``` ## Examples **Request** ```json {} ``` **Response** ```json { "key_0": 840, "key_1": "United States Dollar", "key_2": 1, "key_3": "USD", "key_4": true } ``` **SDK Code** ```python currency_admin_{currencyId}_Get Currency By ID_example import requests url = "http://localhost:9000/api/v1/currency_admin/USD" payload = {} headers = {"Content-Type": "application/json"} response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript currency_admin_{currencyId}_Get Currency By ID_example const url = 'http://localhost:9000/api/v1/currency_admin/USD'; const options = {method: 'GET', headers: {'Content-Type': 'application/json'}, body: '{}'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go currency_admin_{currencyId}_Get Currency By ID_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://localhost:9000/api/v1/currency_admin/USD" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby currency_admin_{currencyId}_Get Currency By ID_example require 'uri' require 'net/http' url = URI("http://localhost:9000/api/v1/currency_admin/USD") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java currency_admin_{currencyId}_Get Currency By ID_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("http://localhost:9000/api/v1/currency_admin/USD") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php currency_admin_{currencyId}_Get Currency By ID_example request('GET', 'http://localhost:9000/api/v1/currency_admin/USD', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp currency_admin_{currencyId}_Get Currency By ID_example using RestSharp; var client = new RestClient("http://localhost:9000/api/v1/currency_admin/USD"); var request = new RestRequest(Method.GET); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift currency_admin_{currencyId}_Get Currency By ID_example import Foundation let headers = ["Content-Type": "application/json"] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:9000/api/v1/currency_admin/USD")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```