---
title: "GetList | Currency | Bot | مستندات وب سرویس سپهر"
---

# SingleSignOn VerifyToken



این وب‌سرویس برای دریافت لیست ارزهای تعریف‌شده در سیستم سپهر و اطلاعات مربوط به نرخ تبدیل هر ارز استفاده می‌شود.

در پاسخ این وب‌سرویس، علاوه بر لیست ارزها، اطلاعات ارز پایه سیستم نیز در فیلد `BaseCurrency` برگردانده می‌شود.

---

## API Endpoint

```http
POST https://{SupplierWebsiteUrl}/api/B2M/Bot/Finance/Currency/GetList/V1
```

---

## Request Parameters

- `UserName`

  string

  [conditional-required]

  نام کاربری

  در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.

- `Password`

  string

  [conditional-required]

  رمز عبور به صورت MD5 شده

  در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.

- `AccessToken`

  string

  [conditional-required]

  توکن احراز هویت دریافت‌شده از طریق Single Sign-On (SSO).

  در صورت استفاده از روش Token-based Authentication این فیلد را ارسال کنید. در این حالت نیازی به ارسال UserName و Password نیست.

  :::info
  برای آشنایی با روش‌های احراز هویت و نحوه انتخاب و استفاده از هر روش، به مستندات [Authentication](/fa/b2m/bot/authentication.md) مراجعه کنید.
  :::

---

## Sample Request

```curl
curl -X POST https://SepehrApiTest.ir/api/B2M/Bot/Finance/Currency/GetList/V1 \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
    "UserName": "testdev1",
    "Password": "25f9e794323b453885f5181f1b624d0b"
}'
```

---

## Response Data

- `BaseCurrency`

  complex type

  اطلاعات مربوط به ارز پایه سیستم.

  - `Id`

    integer
    
    شناسه منحصر به فرد مربوط به ارز پایه

  - `Name`

    string
    
    نام ارز پایه

  - `Code`

    string
    
    کد ارز پایه    

  - `ExchangeRate`

    decimal
    
    مقدار این فیلد برای ارز پایه همیشه برابر با `1` است.

  - `RoundingRule`

    string enum
    
    نحوه گرد کردن مقدار نهایی پس از تبدیل مبلغ به این ارز.

    مقادیر قابل قبول:

    - RemoveFraction
      
      تمام بخش اعشاری عدد حذف می‌شود.
      
      به عنوان مثال 2500.261 تبدیل به 2500.00 می شود

    - KeepTwoDecimalPlaces

      عدد تا دو رقم اعشار نگه داشته می‌شود.

      به عنوان مثال 2500.261 تبدیل به 2500.26 می شود

    - RoundToTens

      عدد به نزدیک‌ترین دهگان گرد می‌شود.

      به عنوان مثال 250,008 تبدیل به 250,010 می شود

    - RoundToHundreds

      عدد به نزدیک‌ترین صدگان گرد می‌شود.

      به عنوان مثال 250,078 تبدیل به 250,100 می شود

    - RoundToThousands

      عدد به نزدیک‌ترین هزارگان گرد می‌شود.

      به عنوان مثال 250,621 تبدیل به 251,000 می شود

- `CurrencyList`

  list of Currency

  لیست ارزرهای موجود در سیستم

  - `Id`

    integer
    
    شناسه منحصر به فرد مربوط به این ارز

  - `Name`

    string
    
    نام ارز

  - `Code`

    string
    
    کد ارز    

  - `ExchangeRate`

    decimal
    
    نرخ تبدیل این ارز به ارز پایه

  - `RoundingRule`

    string enum
    
    نحوه گرد کردن مقدار نهایی پس از تبدیل مبلغ به این ارز.

    مقادیر قابل قبول:

    - RemoveFraction
      
      تمام بخش اعشاری عدد حذف می‌شود.
      
      به عنوان مثال 2500.261 تبدیل به 2500.00 می شود

    - KeepTwoDecimalPlaces

      عدد تا دو رقم اعشار نگه داشته می‌شود.

      به عنوان مثال 2500.261 تبدیل به 2500.26 می شود

    - RoundToTens

      عدد به نزدیک‌ترین دهگان گرد می‌شود.

      به عنوان مثال 250,008 تبدیل به 250,010 می شود

    - RoundToHundreds

      عدد به نزدیک‌ترین صدگان گرد می‌شود.

      به عنوان مثال 250,078 تبدیل به 250,100 می شود

    - RoundToThousands

      عدد به نزدیک‌ترین هزارگان گرد می‌شود.
      
      به عنوان مثال 250,621 تبدیل به 251,000 می شود


## Sample Response

```json
{
  "CurrencyList": [
    {
      "Id": 2,
      "Name": "دلار",
      "Code": "USD",
      "ExchangeRate": 1930000.00000000,
      "RoundingRule": "KeepTwoDecimalPlaces"
    },
    {
      "Id": 3,
      "Name": "درهم",
      "Code": "AED",
      "ExchangeRate": 80000.00000000,
      "RoundingRule": "RemoveFraction"
    },
    {
      "Id": 4,
      "Name": "يورو",
      "Code": "EUR",
      "ExchangeRate": 290000.00000000,
      "RoundingRule": "KeepTwoDecimalPlaces"
    },
    {
      "Id": 5,
      "Name": "دلار کانادا",
      "Code": "CAD",
      "ExchangeRate": 10000.00000000,
      "RoundingRule": "RemoveFraction"
    }
  ],
  "BaseCurrency": {
    "Id": 1,
    "Name": "ريال",
    "Code": "IRR",
    "ExchangeRate": 1.00000000,
    "RoundingRule": "RemoveFraction"
  }
}
```

---