Работа с заявками на оплату по e-com¶

Примечание: Параметры, отмеченные звездочкой (*), являются обязательными.

Создание заявки на оплату¶

Запрос¶

POST example.com/api/merchant/"merchant"/create_payment_ecom

Заголовки¶

Name	Value
Content-Type*	application/json

Параметры запроса¶

Name	Type	Format	Description
order_id*	string max: 255		id заявки в вашей системе
payment_type*	string	enum (russian, international)	Тип платежа (российский или международный)
fiat_amount*	string		Сумма заявки в фиатной валюте
fiat_currency*	string	enum (rub, eur, usd)	Валюта заказа
sign*	string		Подпись запроса
success_callback_url*	string max: 512		URL для оповещения об успешной оплате
error_callback_url	string max: 512		URL для оповещения об ошибке

Методика формирования подписи в запросе:¶

Подпись для создания заявки на оплату формируется путем нахождения SHA256 Хеша от строки:

order_id : fiat_amount : fiat_currency : payment_type : sign_key

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

{
  "order_id": "123456789",
  "payment_type": "russian",
  "fiat_amount": "1500.00",
  "fiat_currency": "rub",
  "sign": "d8d51ce43fe58b13be258a5b6ee2f261ae4d410fa8551105dcb0e16917b89045",
  "success_callback_url": "https://yourwebsite.com/success",
  "error_callback_url": "https://yourwebsite.com/error"
}

Параметры ответа¶

Name	Type	Format	Description
order_id*	string max: 255		Id заявки в вашей системе
payment_type*	string	enum (russian, international)	Тип платежа (российский или международный)
fiat_amount*	string		Сумма заявки
fiat_currency*	string	enum (rub, eur, usd)	Валюта заказа
payment_url*	string		URL для перехода на страницу оплаты
payment_id*	string		Уникальный идентификатор платежа в нашей системе
sign*	string		Подпись ответа

Методика формирования подписи в ответе:¶

Подпись для ответа формируется путем нахождения SHA256 Хеша от строки:

order_id : fiat_amount : payment_id : sign_key

Возможные ошибки в ответе¶

Text	Value
payment_type_not_available	Указанный тип платежа недоступен для вашего мерчанта
currency_not_supported	Указанная валюта не поддерживается для данного типа платежа
unexpected error	Непредвиденная ошибка

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

200Ошибка 400 и остальные 4xx

{
  "ok": true,
  "order_id": "123456789",
  "payment_type": "russian",
  "fiat_amount": "1500.00",
  "fiat_currency": "rub",
  "payment_url": "https://payment.gateway.com/pay/a1b2c3d4e5f6",
  "payment_id": "PG-123456789",
  "sign": "0df855e39b7910879cf2e91365ac06008a525f25e15f2f36575158342aa8f280"
}

{
  "ok": false,
  "error": "message"
}

Отмена/подтверждение заявки на оплату со стороны платформы¶

Описание: Данный запрос представляет собой callback со стороны платформы при отмене или подтверждении заявки. Запрос отправляется платформой на указанный URL мерчанта (success_callback_url или error_callback_url) для уведомления об изменении статуса заявки.

Запрос¶

POST error_callback_url

или

POST success_callback_url

Заголовки¶

Name	Value
Content-Type*	application/json

Параметры запроса¶

Name	Type	Format	Description
order_id*	string max: 255		ID заявки в вашей системе
standart_sign*	string		Стандартная подпись
status*	string	enum (successful, rejected_timeout, rejected_merchant, rejected_gate)	Статус заявки (successful - успешно, rejected_timeout - отклонено по таймауту, rejected_merchant - отклонено мерчантом, rejected_gate - отклонено системой)
fiat_amount*	string		Сумма заявки в фиатной валюте
merchant_spent_usdt*	string		Сумма USDT, зачисляемая мерчанту. Может быть равно none до момента сетла
fiat_currency*	string	enum (rub, eur, usd)	Код фиатной валюты
payment_type*	string	enum (russian, international)	Тип платежа
payment_id*	string		Уникальный идентификатор платежа в нашей системе
created_at*	string	ISO 8601	Дата и время создания заявки
updated_at*	string	ISO 8601	Дата и время обновления заявки

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

{
  "order_id": "123456789",
  "standart_sign": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "status": "successful",
  "fiat_amount": "1500.00",
  "merchant_spent_usdt": "15.2500",
  "fiat_currency": "rub",
  "payment_type": "russian",
  "payment_id": "PG-123456789",
  "created_at": "2024-02-15T09:30:45Z",
  "updated_at": "2024-02-15T09:45:12Z"
}

Запрос статуса заявки на оплату¶

Запрос¶

GET example.com/api/merchant/"merchant"/status_ecom/"order_id"/

Заголовки¶

Name	Value
Content-Type*	application/json
X-Api-Key*	X-Api-Key

Параметры ответа¶

Name	Type	Format	Description
order_id*	string max: 255		Id заявки в вашей системе
status*	string	enum (expectation, successful, rejected_timeout, rejected_merchant, rejected_gate)	Статус заявки (expectation - в ожидании оплаты, successful - успешно, rejected_timeout - отклонено по таймауту, rejected_merchant - отклонено мерчантом, rejected_gate - отклонено системой)
fiat_amount*	string		Сумма заявки в фиатной валюте
merchant_spent_usdt*	string		Сумма USDT, зачисляемая мерчанту. Может быть равно none до момента сетла
fiat_currency*	string	enum (rub, eur, usd)	Код фиатной валюты
payment_type*	string	enum (russian, international)	Тип платежа
payment_id*	string		Уникальный идентификатор платежа в нашей системе
payment_url*	string		URL для перехода на страницу оплаты
settle*	boolean		Флаг, указывающий была ли проведена финализация по заявке
created_at*	string	ISO 8601	Дата и время создания заявки
updated_at*	string	ISO 8601	Дата и время обновления заявки

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

200Ошибка 400 и остальные 4xx

{
  "ok": true,
  "order_id": "123456789",
  "status": "expectation",
  "fiat_amount": "1500.00",
  "merchant_spent_usdt": "none",
  "fiat_currency": "rub",
  "payment_type": "russian",
  "payment_id": "PG-123456789",
  "payment_url": "https://payment.gateway.com/pay/a1b2c3d4e5f6",
  "settle": false,
  "created_at": "2024-02-15T09:30:45Z",
  "updated_at": "2024-02-15T09:30:45Z"
}

{
  "ok": false,
  "error": "message"
}