Skip to main content

Быстрый старт

API Pear позволяет принимать платежи онлайн. Эта статья поможет вам принять первый платеж, при этом вашим покупателям будут доступны все способы оплаты, которые вы подключили.

Подготовка​

Чтобы начать работать с Pear, вам нужно зарегистрироваться и получить доступ к личному кабинету. Для аутентификации запросов в API вам потребуется секретный ключ и идентификатор магазина из личного кабинета. Подробнее об основах работы с API

Шаг 1. Создайте платёж​

Платеж — главная сущность API Pear. Чтобы его создать, вам понадобятся сумма платежа и URL, на который пользователь вернется после оплаты. Также необходимо передать метод оплаты.

Если хотите добавить описание платежа, которое вы увидите в личном кабинете, а пользователь — при оплате, передайте его в параметре description. Описание должно быть не более 128 символов.

Отправьте Pear запрос и передайте в нём данные для создания платежа, данные для аутентификации (идентификатор магазина и секретный ключ) и ключ идемпотентности (подойдет любое случайное значение).

Пример запроса на создание платежа​

curl https://api.paypear.ru/v1/payment/ \
  -X POST \
  -u <ID магазина>:<Секретный ключ> \
  -H 'Idempotence-Key: <Ключ идемпотентности>' \
  -H 'Content-Type: application/json' \
  -d '{
        "amount": {
          "value": "100.00",
          "currency": "RUB"
        },
        "confirmation": {
            "type": "redirect",
            "return_url": "https://www.example.com/return_url"
        },
        "payment_method_data": {
            "type": "sbp"
        },
        "description": "Заказ №1"
      }'

Шаг 2. Отправьте пользователя на страницу оплаты​

В теле ответа от API вы получите созданный объект платежа в статусе NEW. Для оплаты перенаправьте пользователя на confirmation_url.

Пример созданного объекта платежа​

JSON
{
    "success": true,
    "response": {
        "id": "450d5a05-e377-4946-9e58-2627cae999b4",
        "status": "NEW",
        "paid": false,
        "amount": {
            "value": "100.00",
            "currency": "RUB"
        },
        "confirmation": {
            "type": "redirect",
            "confirmation_url": "https://www.example.com/return_url"
        },
        "created_at": "2025-01-22T14:30:45.129Z",
        "description": "Заказ №1",
        "metadata": {},
    }
}

После успешной оплаты (и если что-то пойдет не так) Pear вернет пользователя на return_url, который вы передали при создании платежа.

Шаг 3. Дождитесь успешного выполнения платежа​

Платеж можно считать успешным, как только он перешел в статус CONFIRMED. Если что-то пойдёт не так, платеж перейдет в статус CANCELED, а если пользователь передумает платить — EXPIRED.

Чтобы узнать статус платежа, подпишитесь на уведомления от Pear.

Также вы можете следить за статусом, запрашивая информацию о платеже с удобной для вас периодичностью (например, после того, как пользователь вернулся на return_url). Для этого вам понадобится идентификатор платежа (значение параметра id в созданном объекте платежа) или номер заказа.

Ура, вы приняли первый платеж!​

Помните, что для приема реальных платежей нужно использовать идентификатор и секретный ключ настоящего магазина.