SmartPayments:

Collectors API

1. Уеб услуга

Поддъжа следните методи:

Оторизация
Намиране на ваучер
Плащане

Винаги първо се вика метода “Оторизация“ и след това един от останалите методи. Може да не се пази ##token## от предишни заявки.

Полето ADDRESS трябва да се замени с една от следните две стойности.

Продукционен сървър:

https://app.smart-payments.eu

Тестов сървър:

https://dev.app.smart-payments.eu

1.1. Оторизация

заявка

POST ADDRESS /auth

    Content-Type: application/json; charset=utf-8
    {"api_key":"потребителско име", "api_secret":"парола" }

отговор

    { "success" : true, "message" : "Успешен вход в системата.", "serviceToken" : "##token##" }

или

    { "success" : false, "message" : "Грешно потребителско име адрес или парола." }

При success==true, входът е успешен. При неуспех, отговорът е със статус код 401 Unauthorized и message съдържа описание на грешката.

1.2. Намиране на ваучер

заявка

GET ADDRESS/voucher/{VoucherCode}

    Authorization: Bearer ##token##

oтговор

    { "success" : true, "message" : "Описание на грешката на български език",
        "data" : [
            { "code" : "1234567890", "amount" : 50, "description" : "Product Name", "status_id" : 1, "status" : "New", "valid_until" : "2023-01-10T00:00:00+00:00", "currency" : "BGN"}
        ]
    }

code - кодът на ваучера
amount - стойност на ваучера
description - описание, например име на клиента или продукта
status_id:
1 - Нов, все още не платен
2 - Изтекъл, валидността му е изтекла
3 - Платен, вече има регистрирано плащане
status - текстова стойност на статуса
valid_until - дата и час, до които е валиден ваучера
currency - валута на ваучера

При търсене на несъществуващ ваучер, полето data е празен масив.

1.3. Плащане

заявка

GET ADDRESS/pay/{VoucherCode}/{PaymentReference}

VoucherCode - кодът на ваучера
PaymentReference - незадължителен идентификатор на плащането в системата на колектора

    Authorization: Bearer ##token##

oтговор

    { "status" : true, "message" : "Плащането за ваучера е успешно регистрирано.",
        "data" : {
            "code" : "1234567890", "amount" : 50, "description" : "Product Name", "status_id" : 3, "status" : "Paid", "valid_until" : "2023-01-10T00:00:00+00:00", "reference": "Collector PaymentReference", "currency" : "BGN"
        }
    }

или

    { "status" : false, "message" : "Описание на грешката на български."}