Extrovert bonus version v1

https://127.0.0.1:3010/api/bonus/{version}

  • version: required(v1)

/check

post

post

Получить баланс бонуснусного счета и максимальное количество бонусов к списанию на чек. При передаче параметра try пытается распределить запрошенное количество бонусов по строкам чека.
Полное описание XML формата чека.
В случае передачи 44440000 в качестве номера карты сервис ответит предопределенным ответом (тестовый сценарий).

Получить баланс бонуснусного счета и максимальное количество бонусов к списанию на чек. При передаче параметра try пытается распределить запрошенное количество бонусов по строкам чека.
Полное описание XML формата чека.
В случае передачи 44440000 в качестве номера карты сервис ответит предопределенным ответом (тестовый сценарий).

Headers

  • Wallet-Api-Key: required(string)

    Ключ авторизации доступа к API

Query Parameters

  • try: (string)

    Получить распределение количество бонусов по чеку

    Example:

    2000

Body

Media type: text/xml

Type: any

Example:

<body>
    <Receipt>
        <DeletionMark>false</DeletionMark>
        <Date>2019-01-31T21:04:23</Date>
        <Number>00НФ-031199</Number>
        <Operation>Продажа</Operation>
        <CardID>А00012963</CardID>
        <CardNumber>10001</CardNumber>
        <CardClientCode>Цнт002477</CardClientCode>
        <Cachier>e58c88071049cd031a174eeea1fe37da3</Cachier>
        <ClientCode>Цнт002477</ClientCode>
        <PromoCode/>
        <Sum>33291</Sum>
        <Items>
            <Row>
                <ID>someGoodCode</ID>
                <Name>someGoodName</Name>
                <Code>someGoodArt</Code>
                <Qty>1</Qty>
                <Price>36990</Price>
                <FinalPrice>33291</FinalPrice>
            </Row>
            <Row>
                <ID>someGoodCode</ID>
                <Name>someGoodName</Name>
                <Code>someGoodArt</Code>
                <Qty>2</Qty>
                <Price>36990</Price>
                <FinalPrice>33291</FinalPrice>
            </Row>
        </Items>
    </Receipt>
</body>

HTTP status code 200

Баланс бонусного счета, максимальное количество бонусов к списанию, скидка по каждой из строк чека (если применимо). Полное описание формата.

Body

Media type: application/json

Type: any

Example:

<?xml version="1.0" encoding="utf-8" ?>
<xml>
    <BonusPre>
        <Balance>3329.1</Balance>
        <Rate>1</Rate>
        <Max>2000</Max>
        <MaxMoney>2000</MaxMoney>
        <Requested>2000</Requested>
        <Rows>
            <Row no="0" use="666.67" useMoney="666.67" ref="685ca30b-6922-477c-b241-8b476c58f652:0"></Row>
            <Row no="1" use="1333.33" useMoney="1333.33" ref="685ca30b-6922-477c-b241-8b476c58f652:1"></Row>
        </Rows>
    </BonusPre>
</xml>

HTTP status code 400

Другая ошибка

HTTP status code 401

Неверный wallet-api-key

/apply

post

post

Провести начисление/списание бонусов по чеку. Производится после фактической печати чека. Теги <BonusUse> и <BonusRef> заполняются из тегов <Row> для соответствующей строки чека (эндпоинт POST /check).
Полное описание XML формата чека.

Провести начисление/списание бонусов по чеку. Производится после фактической печати чека. Теги <BonusUse> и <BonusRef> заполняются из тегов <Row> для соответствующей строки чека (эндпоинт POST /check).
Полное описание XML формата чека.

Headers

  • Wallet-Api-Key: required(string)

    Ключ авторизации доступа к API

Body

Media type: text/xml

Type: any

Example:

<body>
    <Receipt type="Qboutique">
        <DeletionMark>false</DeletionMark>
        <Date>2019-01-31T21:04:23</Date>
        <Number>00НФ-031199</Number>
        <Operation>Продажа</Operation>
        <CardID>А00012963</CardID>
        <CardNumber>10001</CardNumber>
        <CardClientCode>Цнт002477</CardClientCode>
        <Cachier>e58c88071049cd031a174eeea1fe37da390d54f710b9ffb6041c6370e1b74dd9</Cachier>
        <ClientCode>Цнт002477</ClientCode>
        <PromoCode/>
        <Sum>33291</Sum>
        <Items>
            <Row>
                <ID>someGoodCode</ID>
                <Name>someGoodName</Name>
                <Code>someGoodArt</Code>
                <Qty>1</Qty>
                <Price>36990</Price>
                <FinalPrice>33291</FinalPrice>
                <BonusUse>10</BonusUse>
                <BonusRef>334122-12</BonusRef>
            </Row>
        </Items>
    </Receipt>
</body>

HTTP status code 204

Запрос выполнен успешно

HTTP status code 400

Другая ошибка

HTTP status code 401

Неверный wallet-api-key