[lightMode]

Activate Currencies

POST/currencies

[updatedIn] 2 months ago

This endpoint allows activating either a single currency or a group of currencies.

`metadata.read`- Metadata Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

currencies

array [object {2}]

optional

code

string

optional

Currency Code Value. For all enum values for the Currency Code, use this Endpoint.

Example:

SAR

status

boolean

optional

Status of the Currency on the Store

Default:

true

{
  "currencies": [
    {
      "code": "SAR",
      "status": true
    },
    {
      "code": "USD",
      "status": false
    }
  ]
}

Request samples

[api.label.responses]

Success(200)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (Currencies) {4}]

optional

name

string

required

Name of the currency

Example:

ريال سعودي

code

string

required

Code of the currency

Example:

SAR

symbol

string

required

Symbol of the currency

Example:

ر.س

status

enum<string>

required

Status of the currency. The value is either Enabled or Disabled

Allowed values:

enableddisabled

Example:

disabled

{
  "status": 200,
  "success": true,
  "data": [
    {
      "name": "ريال سعودي",
      "code": "SAR",
      "symbol": "ر.س",
      "status": "disabled"
    },
    {
      "name": "درهم اماراتي",
      "code": "AED",
      "symbol": " د.إ",
      "status": "enabled"
    },
    {
      "name": "جنيه مصري",
      "code": "EGP",
      "symbol": "ج.م",
      "status": "enabled"
    },
    {
      "name": "دولار أمريكي",
      "code": "USD",
      "symbol": "$",
      "status": "enabled"
    }
  ]
}

[updatedIn] 2 months ago