Документация API SafeCrow V3

версия документа 3.04

Версии документа

Версия	Дата	Предмет изменений
3.01	22-02-2018	Первый выпуск документа
3.02	19-03-2018	Добавлена возможность прикреплять файлы к сделке и просматривать их
3.03	27-03-2018	Изменен текст ошибок,метод оплаты комиссии,запрос для выплаты продавцу, метод отмены, метод открытия претензии. Добавлена возможность оплаты доставки через сервис (Эквайринг за доставку). Добавлен метод расчета стоимости комиссии SafeCrow, стоимости доставки и отмены.
3.04	11-04-2018	Добавлена функция преавторизации платежей в разделе "Дополнительные возможности".

Введение
Бизнес–процесс
Авторизация
Регистрация пользователя
Посмотреть список пользователей
Посмотреть данные пользователя
Редактировать данные пользователя
Расчет стоимости комиссии SafeCrow
Создание сделки
Просмотр сделок
Аннулирование сделки
Оплата сделки
Привязать банковскую карточку к пользователю
Посмотреть привязанные к пользователю карты
Привязать карту к сделке
Отменить сделку
Закрыть сделку
Эскалировать сделку/открыть претензию
Добавить вложение (Attaches)
Просмотреть вложения
Настройки
Другие ошибки

Введение

API SafeCrow V3 – это набор инструментов, которые позволяют использовать сервис и технологии SafeCrow в ваших проектах. Документ состоит из двух частей:

Основная часть
Дополнительные возможности

В основной части документа описан функционал SafeCrow.

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

Важная информация! При интеграции API SafeCrow ваши пользователи должны принять оферту SafeCrow, которая расположена по адресу: https://www.safecrow.ru/term . Оферта должна быть принята пользователями до момента оплаты.

Все суммы в коде указаны в копейках.

Бизнес–процесс

Последовательность шагов для создания и проведения сделки изображена на рис. 1.

Важно! Данный процесс изменился по сравнению с версий v1.

Рис.1

Авторизация

В API V3 авторизация сделана прозрачной, в основе нее http basic auth и hmac подписи.

В качестве логина надо использовать api-key, в качестве пароля hmac подпись тела запроса ключом api-secret.

Пример запроса на Python, PHP и Ruby содежатся в репозитории.

Регистрация (создание) пользователя

Для создания/регистрации пользователя следует использовать запрос POST /users и указать следующие переменные:

Переменные	Данные
Обязательные
phone	номер мобильного телефона
name	Имя Фамилия
email	e-mail пользователя

Пример запроса

POST /users

{
  "email": "ivan@example.com",
  "phone": "79251234567",
  "name": "Иван Иванов"
}

Пример ответа

{
  "id": 467,
  "email": "ivan@example.com",
  "phone": "79251234567",
  "name": "Иван Иванов",
  "registered_at": "2018-02-05T12:17:01+03:00"
}

Создан пользователь 467, 5 февраля 2018 в 12:17

Сообщения об ошибках:

Пример

{
  "errors": [
    {
      "name": "required field"
    },
    {
      "email": "user with email ivan@example.com already exists"
    }
  ]
}

“required field” - поле не было передано

Посмотреть список пользователей

Для просмотра зарегистрированных пользователей достаточно ввести следующий запрос:

Пример запроса

GET /users

Для поиска пользователя по email к запросу нужно добавть параметр email

Пример запроса

GET /users?email=test@email.com

Пример ответа

{
    "id": 467,
    "email": "test@email.com",
    "phone": null,
    "name": "Вася Васильев",
    "registered_at": "2018-02-05T12:17:01+03:00"

 }

Посмотреть данные пользователя

Для просмотра данных пользователя, используйте запрос: GET /users/:user_id

Пример запроса

GET /users/467

Пример ответа

{
  "id": 467,
  "email": "test@email.com",
  "phone": null,
  "name": "Вася Васильев",
  "registered_at": "2018-02-05T12:17:01+03:00"
}

Редактировать данные пользователя

Редактировать и добавить данные пользователю можно используя запрос POST /users/:user_id. Можно изменить следующие переменные:

Переменные	Данные
Обязательные
email	e-mail пользователя
name	Имя Фамилия
phone	номер мобильного телефона

Пример запроса

POST /users/467
{
  "phone": "79161540474",
  "name": "Иван Васильев"
}

Пример ответа

{
  "id": 467,
  "email": "test@email.com",
  "phone": "79161540474",
  "name": "Иван Васильев",
  "registered_at": "2018-02-05T12:17:01+03:00"
}

У пользователя 467 были изменены телефон и имя.

Расчет стоимости комиссии SafeCrow

Для расчета стоимости комиссии SafeCrow используйте POST /calculate.

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

Переменные	Данные
price	стоимость сделки, в копейках
service_cost_payer	“50/50” или “consumer” или “supplier”
consumer_cancellation_cost	штраф покупателя за отмену. сумма в копейках

Пример запроса

POST /calculate
{
   "price":100000,
   "service_cost_payer":"50/50",
   "consumer_cancellation_cost": 0
}

Пример ответа

{
   "price":100000,
   "supplier_service_cost":2000,
   "consumer_service_cost":2000,
   "consumer_cancellation_cost": 0
}

Создание сделки

Для создания сделки следует использовать POST /orders и указать следующие переменные:

Переменные	Данные
Обязательные
consumer_id	integer
supplier_id	integer
price	integer (в копейках, минимум 100 руб (10000))
description	string
service_cost_payer	“50/50” или “consumer” или “supplier”
Второстепенные
extra	ассоциативный массив - дополнительная информация

Пример запроса

POST /orders
{
  "consumer_id": 467,
  "supplier_id": 466,
  "price": 10000,
  "description":"something",
  "service_cost_payer":"50/50"
}

Пример ответа

{
  "id": 29,
  "consumer_id": 467,
  "supplier_id": 466,
  "price": 10000,
  "consumer_service_cost": 200,
  "supplier_service_cost": 200,
  "status": "pending",
  "description": "something",
  "supplier_payout_method_id": null,
  "supplier_payout_method_type": null,
  "created_at": "2018-02-07T18:32:17+03:00",
  "updated_at": "2018-02-07T18:32:17+03:00",
  "extra": {
  }
}

Была создана сделка 29, стоимость сделки 100 рублей, комиссия составляет 4 рубля и платится пользователями пополам. В этот момент статус сделки становится “pending”.

Сообщения об ошибках:

"extra": "Некорректный тип данных" - должен передаваться ассоциативный массив ключ-значение

Просмотр сделок

Посмотреть данные всех сделок - GET /orders

Посмотреть сделку по id - GET /orders/:order_id

Посмотреть данные сделок конкретного пользователя по его id - GET /users/:user_id/orders

Пример запроса

GET /users/467/orders

Пример ответа

{
  "id": 29,
  "consumer_id": 467,
  "supplier_id": 466,
  "price": 10000,
  "consumer_service_cost": 200,
  "supplier_service_cost": 200,
  "status": "pending",
  "description": "someting",
  "supplier_payout_method_id": null,
  "supplier_payout_method_type": null,
  "created_at": "2018-02-07T18:32:17+03:00",
  "updated_at": "2018-02-07T18:32:17+03:00",
  "extra": {
  }}

В ответ на запрос придет список всех сделок, в которых участвовал пользователь.
В данном примере к пользователю привязана одна сделка.

Аннулирование сделки

Аннулирование возможно только до проведения оплаты по сделке.

Для аннулирования активной сделки используется запрос POST /orders/:order_id/annul и данные:

Переменные	Данные
Обязательные
reason	string

Пример запроса

POST /orders/31/annul
 {
  "reason": "Some reason"
 }

Пример ответа

{
  "id": 31,
  "consumer_id": 467,
  "supplier_id": 466,
  "price": 10000,
  "consumer_service_cost": 200,
  "supplier_service_cost": 200,
  "status": "annulled",
  "description": "someting",
  "supplier_payout_method_id": null,
  "consumer_payout_method_id": null,
  "supplier_payout_method_type": null,
  "consumer_payout_method_type": null,
  "created_at": "2018-02-08T12:01:35+03:00",
  "updated_at": "2018-03-06T12:22:00+03:00",
  "extra": {
  }
}

Оплата сделки

Для оплаты сделки в запросе указывается номер (id) сделки, которая будет оплачена Покупателем (consumer) - POST /orders/:order_id/pay.
Также необходимым полем является переменная redirect_url - ссылка на страницу, куда будет направлен пользователь после оплаты.

Переменные	Данные
Обязательные
redirect_url	cсылка (String)

Для проведения тестовых оплат используйте тестовые карточки шлюза “MandarinPay”:

Параметры	Значение	Комментарий
Номер карты	4929509947106878	Для имитации успешных транзакций без 3DSecure
Номер карты	4692065455989192	Для имитации успешных транзакций с 3DSecure
Номер карты	4485913187374384	Для имитации неуспешных транзакций без 3DSecure
Номер карты	4556058936309366	Для имитации неуспешных транзакций с 3DSecure
Имя держателя карты	CARD HOLDER
Срок действия	Любой валидный	Минимально - выбрать месяц, следующий за текущим
CVV	123

Далее пример запроса на оплату ранее созданной сделки 29 и получения в ответ ссылки на оплату.

Пример запроса

POST /orders/29/pay
  {
    "redirect_url": "http://example.com/return/url"
  }

Пример ответа

{
  "payment_url":"https://staging.safecrow.ru/finances/29/pay?jsOperationId=3e1ba729e68445c4a37
    062c556385&return_to=",
  "consumer_pay": 102000
}

В ответе по ссылке осуществляется оплата, после чего происходит редирект на указанный в запросе url, к которому добавляются параметры:

Параметры	Данные
orderId	id сделки + _ + случайное число (11_a43234)
status	success или fail
type	pay

Пример ссылки

http://example.com/return/url?orderId=29_a44298&status=success&type=pay

Cтатус сделки изменится на paid.

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

Для привязки карты используйте запрос - POST /users/:user_id/cards

Переменные	Данные
redirect_url	ссылка (String)

Пример запроса

 POST /users/467/cards
  {
    "redirect_url": "http://example.com/return/url"
  }

Пример ответа

{
  "redirect_url": "https://safecrow.ru/finances/card_binding/467?jsOperationId             
  =binding_5ae972a2-e5bb-4913-83a1-ac7408e30f54&return_to="
}

В ответ приходит ссылка на заполнение данных банковской карты.

Сообщения об ошибках:
"phone": [ "Can not be empty!" ] - к пользователю должен быть привязан телефонный номер (привязать, изменив данные пользователя)

Посмотреть привязанные к пользователю карты

После заполнения данных карты, она привязывается к пользователю, список всех привязанных карт, включая неудачные попытки можно узнать, используя GET /users/:user_id/cards?all=true

Для просмотра всех банковских карт, подтвержденных мандарином GET /users/:user_id/cards

Пример запроса

GET /users/467/cards

Пример ответа

{
  "id": 179,
  "card_holder": "CARD HOLDER",
  "card_number": "492950XXXXXX6878",
  "expires": "10/20",
  "bound_at": "2018-02-06T16:46:22+03:00",
}

Если карта не была привязана - в ответ придет пустой список.

Привязать карту к сделке

Для выплаты продавцу (supplier) будет использована одна из ранее привязанных к нему карт, к запросу POST /users/:user_id/orders/:order_id требуется добавить переменную id карты – узнать id.

Пример запроса

POST /users/466/orders/29  
  {
    "supplier_payout_card_id": 467
  }

Пример ответа

"id": 29,
  "consumer_id": 467,
  "supplier_id": 466,
  "price": 10000,
  "consumer_service_cost": 200,
  "supplier_service_cost": 200,
  "status": "paid",
  "description": "something",
  "supplier_payout_method_id": 180,
  "consumer_payout_method_id": null,
  "supplier_payout_method_type": "CreditCard",
  "consumer_payout_method_type": null,
  "created_at": "2018-02-13T10:56:40+03:00",
  "updated_at": "2018-02-13T14:35:25+03:00",
  "extra": {
  }

Ответ - описание сделки, в полях supplier_payout_method_id и type указана информация соответственно об id карты и типе выплаты.

Отменить сделку

Отмена производится в том случае, если оплата по сделке уже прошла, в ином случае производится Аннулирование сделки. Обратите внимание, что при отмене сделки вся комиссия сервиса списывается с покупателя (consumer).

Сделку можно отменить, используя следующий запрос: POST /orders/:order_id/cancel

Переменные	Данные
reason	String

Пример запроса

POST /orders/51/cancel
{
 "reason": "Some important reason"
}

Пример ответа

id":51,
 "consumer_id":467,
 "supplier_id":466,
 "price":10000,
 "consumer_service_cost":400,
 "supplier_service_cost":0,
 "consumer_delivery_cost":0,
 "supplier_delivery_cost":0,
 "consumer_cancellation_cost":0,
 "discount":0,
 "description":null,
 "status":"cancelled",
 "supplier_payout_method_id":null,
 "supplier_payout_method_type":null,
 "created_at":"2018-07-05T15:53:41+03:00",
 "updated_at":"2018-07-05T15:53:41+03:00",
 "extra":{
 }

Сделка переходит в статус - отмена (cancelled). Покупателю возвращается сумма оплаты - 100 рубля.

Закрыть сделку

Успешное завершение сделки - POST /orders/:order_id/close

Переменные	Данные
reason	String, причина закрытия
discount	размер скидки (в копейках)

В случае, если пользователи договорились о скидке, то в поле Discount указывается размер скидки в копейках. Сумма из поля Discount будет вычтена из суммы выплаты Продавцу.

Пример запроса

POST /orders/30/close

Пример ответа

"id":4560,
 "consumer_id":467,
 "supplier_id":466,
 "price":10000,
 "consumer_service_cost":200,
 "supplier_service_cost":200,
 "consumer_delivery_cost":0,
 "supplier_delivery_cost":0,
 "consumer_cancellation_cost":0,
 "discount":20000,
 "description":null,
 "status":"closed",
 "supplier_payout_method_id":602,
 "supplier_payout_method_type":"CreditCard",
 "created_at":"2018-07-03T10:04:54+03:00",
 "updated_at":"2018-07-03T10:04:54+03:00",
 "extra":{
 }

Сделка завершена (status: closed). Затем на карту продавца (id 180) SafeCrow переведет сумму сделки.

Сообщения об ошибках: "errors":[ "discount is too big" ] - выплата Продавцу менее 100 рублей

Эскалировать сделку/открыть претензию

Если покупатель недоволен качеством товара, сделка передается специалистам SafeCrow - POST /orders/:order_id/escalate

Следует указать причину reason (String)

Переменные	Данные
reason	string

Пример запроса

POST /orders/32/escalate
{
 "reason": "Some important reason"
}

Пример ответа

"id": 32,
  "consumer_id": 467,
  "supplier_id": 466,
  "price": 10000,
  "consumer_service_cost": 200,
  "supplier_service_cost": 200,
  "status": "escalated",
  "description": "something",
  "supplier_payout_method_id": 180,
  "consumer_payout_method_id": 179,
  "supplier_payout_method_type": "CreditCard",
  "consumer_payout_method_type": "CreditCard",
  "created_at": "2018-02-13T10:56:40+03:00",
  "updated_at": "2018-02-14T14:46:02+03:00",
  "extra": {
  }

Сделка переходит в статус "escalated", специалисты сэйфкроу разрешают претензию, после чего сделка закрывается (status: closed) или отменяется (status: canceled)

Добавить вложение (Attaches)

Для добавления вложений используется POST /orders/:order_id/attachments, а также переменные:

Переменные	Данные
type	“text”, “image”
body	ассоциативный массив 1. `“text” (JSON)` - текст вложения 2.`“file”(формат base64)` - зашифрованная картинка `“file_name”` - имя файла c расширением (.ico .jpg .png)
user_id	id пользователя, от имени которого прикрепляется вложение

Пример запросов
Запрос на создание текстового вложения

POST /orders/44/attachments
{
  "type": "text",
  "body": {"text": "there is some text"},
  "user_id": 467
}

Запрос на создание .jpg .png вложения

POST /orders/44/attachments
{
  "type": "image",
  "body": {
            "file": "AAABAAEAE...A==",
            "file_name": "File.png"
          },
  "user_id": 467
}

Пример ответов

{
    "id": 2,
    "user_id": 467,
    "type": "text",
    "body": "{\"text\":\"there is some text\"}",
    "send_at": "2018-02-26T11:14:15+03:00"
  },
{
  "id": 3,
  "user_id": 467,
  "type": "image",
  "body": "{\"file_path\":\"/var/www/safecrow-ng/current/static/44/New Image\",\"file_name\":\"New Image\"}",
  "send_at": "2018-02-26T12:01:14+03:00"
}

Просмотреть вложения

Для просмотра всех вложений конкретной сделки GET /orders/:order_id/attachments

Пример запроса

 GET /orders/44/attachments

Пример ответа

{
    "id": 2,
    "user_id": 467,
    "type": "text",
    "body": "{\"text\":\"there is some text\"}",
    "send_at": "2018-02-26T11:14:15+03:00"
  },
{
    "id": 3,
    "user_id": 467,
    "type": "image",
    "body": "{\"file_path\":\"/var/www/safecrow-ng/current/static/44/New Image\",\"file_name\"      :\"New Image\"}",
    "send_at": "2018-02-26T12:01:14+03:00"
  }

Настройки

Настроить коллбек url POST /settings добавив переменную

Переменные	Данные
callback_url	ссылка (String)

Посмотреть настройки GET /settings

Пример запроса

POST /settings
  {
   "callback_url": "https://example.com/callback/url"
  }

По запросу коллбек приходит GET запросом, с параметрами status, orderId(id сделки + _ + случайное число (11_a43234) ) и price для аутентификации запроса используется хедер X-Auth

X-Auth содержит hmac, который считается следующим образом(callback_url - это полный request к серверу, его следует брать из переменных сервера):
hmac = OpenSSL::HMAC.hexdigest(‘SHA256’, api_secret, “#{api_key}-#{callback_url}“)

Пример на php:
$fullReqUrl = (isset($_SERVER['HTTPS']) ? "https" : "http") . "://$_SERVER[HTTP_HOST]$_SERVER[REQUEST_URI]"
$result = hash_hmac("SHA256", $apiKey . "-" . $fullReqUrl, $apiSecret);

Другие ошибки

“These aren't the droids you're looking for" - неправильный url

"Jim! She's gonna blow!\n id is a restricted primary key" - данные нельзя поменять

"Jim! She's gonna blow!\n Invalid filter expression: (message) - неправильный тип данных?

"Jim! She's gonna blow!\n undefined method '/' for \"11\":String" - тип данных

Дополнительные возможности

Эквайринг за доставку

При создании сделки нужно дополнительно передать параметры:

Переменные	Данные
delivery_cost	стоимость доставки
delivery_cost_payer	кто оплачивает доставку. consumer, supplier, 50/50.
user_id	id пользователя, от имени которого прикрепляется вложение

После создания, в информации по сделке будут дополнительные поля

Переменные	Данные
Обязательные
supplier_delivery_cost	стоимость доставки для продавца.Будет вычтена из суммы сделки при выплате продавцу
consumer_delivery_cost	стоимость доставки для покупателя.Будет добавлена к сумме при оплате покупателем
Второстепенные
consumer_cancellation_cost	штраф при отмене.Может вычитаться из суммы сделки, возвращаемой покупателю при отмене. Может использоваться как оплата обратной доставки при возврате товара,

Преавторизация платежей

Для пользователя процесс преавторизации полностью аналогичен процессу оплаты. При преавторизации у пользователя на карте блокируются денежные средства, необходимые для оплаты сделки, на срок - 3 дня. В течение этого срока SafeCrow должен получить подтверждение или отмену преавторизации. На 4-ый день SafeCrow отменяет блокировку денежных средств на карте пользователя. Для проведения преавторизации используйте запрос: POST /orders/:order_id/preauth

Пример запроса:

POST /orders/:order_id/preauth
{
   "redirect_url": "http://example.com/redirect/url"
}

Для проведения тестовых оплат используйте тестовые карточки шлюза “MandarinPay”.

При выполнении преавторизации сделка переходит в статус preauthorized

Переменные	Данные
Обязательные
order_id	Id сделки, которая будет оплачена Покупателем (consumer)
redirect_url	ссылка на страницу, куда будет направлен пользователь после оплаты.

Для оплаты сделки и списания денег с карты покупателя, преавторизованый платеж необходимо подтвердить.

При подтверждении преавторизации происходит списание денег с карты покупателя и сделка переходит в статус paid.

Пример запроса

POST /orders/:order_id/preauth/confirm
{
   "reason": "Some reason"
}

Пример ответа:

"id": 30,
 "consumer_id": 467,
 "supplier_id": 466,
 "price": 10000,
 "consumer_service_cost": 200,
 "supplier_service_cost": 200,
 "status": "preauthorized",
 "description": "something",
 "supplier_payout_method_id": 180,
 "consumer_payout_method_id": null,
 "supplier_payout_method_type": "CreditCard",
 "consumer_payout_method_type": null,
 "created_at": "2018-02-07T19:52:08+03:00",
 "updated_at": "2018-02-14T14:24:14+03:00",
 "extra": {
 }

Если сделка не была подтверждена - необходимо произвести отмену преавторизации. Статус сделки при этом меняется на pending.

Пример запроса

POST /orders/:order_id/preauth/release
{
   "reason": "Some reason"
}

Пример ответа

"id": 30,
 "consumer_id": 467,
 "supplier_id": 466,
 "price": 10000,
 "consumer_service_cost": 200,
 "supplier_service_cost": 200,
 "status": "pending",
 "description": "something",
 "supplier_payout_method_id": 180,
 "consumer_payout_method_id": null,
 "supplier_payout_method_type": "CreditCard",
 "consumer_payout_method_type": null,
 "created_at": "2018-02-07T19:52:08+03:00",
 "updated_at": "2018-02-14T14:24:14+03:00",
 "extra": {
 }

Name		Name	Last commit message	Last commit date
Latest commit History 26 Commits
README.md		README.md
example.php		example.php
example.py		example.py
example.rb		example.rb
safecrow.svg		safecrow.svg
step-deal.jpg		step-deal.jpg

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Документация API SafeCrow V3

версия документа 3.04

Версии документа

Оглавление

Дополнительные возможности

Введение

Бизнес–процесс

Авторизация

Регистрация (создание) пользователя

Сообщения об ошибках:

Посмотреть список пользователей

Посмотреть данные пользователя

Редактировать данные пользователя

Расчет стоимости комиссии SafeCrow

Создание сделки

Сообщения об ошибках:

Просмотр сделок

Аннулирование сделки

Оплата сделки

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

Посмотреть привязанные к пользователю карты

Привязать карту к сделке

Отменить сделку

Закрыть сделку

Эскалировать сделку/открыть претензию

Добавить вложение (Attaches)

Просмотреть вложения

Настройки

Другие ошибки

Дополнительные возможности

Эквайринг за доставку

Преавторизация платежей

About

Releases

Packages

Languages

t1maccapp/docs-apiv3

Folders and files

Latest commit

History

Repository files navigation

Документация API SafeCrow V3

версия документа 3.04

Версии документа

Оглавление

Дополнительные возможности

Сообщения об ошибках:

Сообщения об ошибках:

Дополнительные возможности

About

Resources

Stars

Watchers

Forks

Languages