[GET] Получение данных платежа
Описание запроса
GET /v1/order/[order id]
Запрос позволяет получить информацию о платеже
Этот запрос может быть использован также для получения данных заказа, созданного через Softline Checkout.
Если данные отправляются по заказу в рамках сценария покупки через корзину с последующими автоплатежами, то в запросе будут заполнены соответствующие данные о продукте/корзине. См. описание формата в документации Checkout.
Данные для отправки запроса
- Endpoints URL:
- Боевая среда: https://api.ecommerce.softline.com/v1/order
- Тестовая среда: https://api.ecommerce.softline.com.demoslweb.com/v1/order
- Метод: GET
- Авторизация: с помощью токена
- Формат значения:
Bearer [token]
- Вместо [token] подставьте значение token, полученное в ответ на запрос к Authentication API
Пример запроса
GET https://api.ecommerce.softline.com/v1/order/123456
Ответ запрос
В ответ на запрос вы получите код ответа сервера, соответствующий результату обработки.
В зависимости от кода в теле ответа могут присутствовать дополнительные параметры.
Положительный ответ
При успешной обработке запроса вы получите код ответа сервера HTTP/1.1 200 OK. В теле ответа будут переданы данные платежа в формате JSON.
В ответе передаются:
- Данные платежа
- Данные об оплате
- Данные покупателя
- (Опционально) Данные по возврату
- (Опционально) Дополнительные параметры
Формат идентификатора, в котором к нему может быть добавлен префикс.
Для заказа Softline Checkout: Дополненный идентификатор заказа
Узнайте подробнее о статусах.
Варианты значений:
- not paid - оплата не завершена
- paid - оплата успешно завершена
- deleted - удален
Этот идентификатор вы передаете при создании платежа (payment_id) или проведении автоплатежа (payment_id).
Для заказа Softline Checkout: идентификатор корзины, через которую был оформлен заказ на продукт с динамическими характеристиками
Формат: YYYY-MM-DDThh:mm:ss±hh:mm.
Для заказа Softline Checkout: дата и время создания заказа
- Формат: YYYY-MM-DDThh:mm:ss±hh:mm
- Если оплата не завершена, то параметр будет передан с пустым значением ("")
- Формат: ISO 4217 alpha-3, 3 символа
- Варианты значений см. в справочнике
Варианты значений см. в справочнике.
При получении данных по платежу в тестовой среде - ссылка будет предназначена для тестовой среды (ссылка будет иметь суффикс .demoslweb.com).
Для заказа Softline Checkout: ссылка на страницу заказа
Для заказа Softline Checkout: итоговая сумма скидки по всем позициям заказа
- Передается в валюте платежа
- Формат: Число с 2 десятичными знаками, разделитель - точка, передается как строка
- Если процент VAT равен нулю, то параметр будет передан с значением "0.00"
- Передается в валюте платежа
- Учитывает VAT
- Формат: Число с 2 десятичными знаками, разделитель - точка, передается как строка
Варианты значений см. в справочнике.
Может быть заполнено, если покупатель успешно завершил оплату банковской картой. В ином случае, параметр будет передан с пустым значением (null).
Может быть заполнено, если покупатель успешно завершил оплату банковской картой. В ином случае, параметр будет передан с пустым значением ("").
Формат значения: MM/YYYY, например, 12/2026.
Для заказа Softline Checkout: наличие оплаты в рассрочку Softline Checkout
- Формат: ISO 3166-1 alpha-2
- Варианты значений см. в справочнике
Варианты значения:
- physical - физическое лицо
- juridical - юридическое лицо
Если не заполнен, то параметр будет передан с пустым значением ("").
Также, используется для передачи:
- ИНН компании при оплате в рублях
- DNI/CUIL или CUIT при оплате в аргентинских песо
Если не заполнено, то параметр будет передан с пустым значением ("").
Если не заполнен, то параметр будет передан с пустым значением ("").
Если не заполнен, то параметр будет передан с пустым значением ("").
Для заказа Softline Checkout: информация о продукте в заказе
Для заказа Softline Checkout: идентификатор продукта
Для заказа Softline Checkout: ваш идентификатор продукта
Для заказа Softline Checkout: ваш SKU продукта
Для заказа Softline Checkout: бизнес сегмент продажи
Это описание вы передаете при создании платежа (payment_description) или проведении автоплатежа (payment_description).
Для заказа Softline Checkout: полное наименование продукта
Формат: Число с 2 десятичными знаками, разделитель - точка. Передается как строка.
Для заказа Softline Checkout: цена за одну единицу продукта в валюте заказа
Для заказа Softline Checkout: количество единиц продукта в заказе
Для заказа Softline Checkout: процент скидки на продукт в заказе
Для заказа Softline Checkout: сумма скидки на продукт в заказе
- Передается в валюте платежа
- Формат: Число с 2 десятичными знаками, разделитель - точка, передается как строка
- Если процент VAT равен нулю, то параметр будет передан с значением "0.00"
- Передается в валюте платежа
- Учитывает VAT
- Формат: число с 2 десятичными знаками, разделитель - точка, передается как строка
- Передается в валюте платежа
- Формат: число с 2 десятичными знаками, разделитель - точка, передается как строка
Передается, если был сделан возврат. В ином случае не передается.
* - Обязательный параметр, если был передан параметр products.return.
Варианты значений:
- returned - возврат/chargeback
- removed - не используется в Softline Payments
- * - Обязательный параметр, если был передан параметр products.return
- Формат: YYYY-MM-DDThh:mm:ss±hh:mm
* - Обязательный параметр, если был передан параметр products.return.
Примеры значений:
- Географически ограничения
- Повторная оплата
- ChargeBack
- Дубли заказа
- Тестовый заказ
Эти параметры могут быть заполнены при создании платежа (additional_data) или в процессе обработки. Обратите внимание, срок хранения дополнительных параметров платежа ограничен.
* - Обязательный параметр, если был передан параметр additional_data.
* - Обязательный параметр, если был передан параметр additional_data.
Пример положительного ответа
{
"order_id": 6666666,
"order_name": "A0006666666",
"status": "delete",
"external_id": "TEST12025",
"create_date": "2021-08-13T09:16:35+03:00",
"pay_date": "2021-08-13T09:20:05+03:00",
"currency": "EUR",
"locale": "en_EN",
"order_detail_url": "https://shop.com/order/status/6666666/1a97507",
"total_discount_amount": "0.00",
"total_vat_amount": "0.00",
"total_amount": "200.00",
"payment": {
"payment_method": "CreditCard",
"payment_system_name": "Bank Card",
"card_last_4": "1234",
"card_expiration_date": "12/26",
"is_installment_payment": false
},
"customer": {
"country": "FR",
"type": "physical",
"email": "customer@gmail.com",
"first_name": "Marcel",
"last_name": "Laporte",
"phone": "",
"vat_number": "",
"company_name": "",
"company_billing_address": "",
"company_delivery_address": ""
},
"products": [
{
"id": 111111,
"vendor_code": "",
"sku": "",
"business_segment": "b2c",
"name": "Demo payment",
"price": "100.00",
"quantity": 1,
"discount_percent": "",
"discount_amount": "",
"vat_percent": "0.000",
"vat_amount": "0.00",
"amount": "100.00",
"margin": "95.00",
"return": {
"type": "returned",
"reason": "test purchase",
"date": "2022-08-14T09:16:35+03:00"
}
}
],
"additional_data": [
{
"name": "referer2",
"value": "test"
},
{
"name": "referer3",
"value": "TEST12025"
}
]
}
Ответ об ошибке
В случае ошибки при обработке запроса вы получите код ответа сервера, соответствующий результату обработки.
В зависимости от кода в теле ответа могут присутствовать дополнительные параметры.
Справочник HTTP-кодов ответа сервера при ошибке
Код ответа сервера | Описание |
HTTP/1.1 400 Bad Request | Запрос не валиден (ошибка в параметрах; не переданы необходимые данные и т.п.). В теле ответа будет передан дополнительный код ошибки (один или несколько). |
HTTP/1.1 401 Unauthorized | Неуспешная аутентификация. В теле ответа будет передан дополнительный код ошибки (один или несколько). |
HTTP/1.1 404 Not found | Неверный URL запроса или платеж не найден. Проверьте адрес запроса. В теле ответа может быть передан дополнительный код ошибки. |
HTTP/1.1 500 Request Error | Ошибка на стороне сервера. Повторите запрос позднее или обратитесь в службу поддержки. |
Справочник дополнительных кодов ошибок для HTTP 400
Error | Message | Описание |
15000 | Unable to identify your configuration for accessing this API. Please contact technical support. | При обработке не смогли однозначно определить настройки вашего аккаунта. Обратитесь в службу поддержки. |
Справочник дополнительных кодов ошибок для HTTP 401
Справочник этих ошибок одинаковый для всех API, которые используют авторизацию по токену.
Справочник дополнительных кодов ошибок для HTTP 404
Error | Message | Описание |
15020 | Order not found. | Запрос не может быть выполнен. Платеж с переданным id не найден или у вас нет доступа к нему. |
Пример ответа об ошибке
{
"errors": [{
"error": 15020,
"message": "Order not found."
}
]
}