[GET] Получение данных платежа

Softline PaymentsИнтеграцияPayments Info

Описание запроса

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
Авторизация: с помощью токена

Параметры в URL запроса

[order id]

required

Идентификатор платежа

Вы можете получить его:

В ответ на запрос создания платежа (order_id) или проведение автоплатежа (order_id)
В webhook-оповещении (order_id)
В ответ на запрос получения списка платежей (ids)

Пример передачи параметра в URL: /v1/order/123456

Параметры заголовка

AuthorizationJWT

required

Авторизационный токен

Формат значения: Bearer [token]
Вместо [token] подставьте значение token, полученное в ответ на запрос к Authentication API

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

GET https://api.ecommerce.softline.com/v1/order/123456

Ответ запрос

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

Положительный ответ

При успешной обработке запроса вы получите код ответа сервера HTTP/1.1 200 OK. В теле ответа будут переданы данные платежа в формате JSON.

В ответе передаются:

Данные платежа
Данные об оплате
Данные покупателя
(Опционально) Данные по возврату
(Опционально) Дополнительные параметры

Параметры в теле запроса

order_id

number

required

Идентификатор платежа

Для заказа Softline Checkout: Идентификатор заказа

order_name

string

required

Дополненный идентификатор платежа
Формат идентификатора, в котором к нему может быть добавлен префикс.

Для заказа Softline Checkout: Дополненный идентификатор заказа

status

string

required

Статус платежа
Узнайте подробнее о статусах.

Варианты значений:

not paid - оплата не завершена
paid - оплата успешно завершена
deleted - удален

Для заказа Softline Checkout: Статус заказа

external_id

string

Идентификатор платежа на вашей стороне
Этот идентификатор вы передаете при создании платежа (payment_id) или проведении автоплатежа (payment_id).

Для заказа Softline Checkout: идентификатор корзины, через которую был оформлен заказ на продукт с динамическими характеристиками

create_date

string

required

Дата и время создания платежа

Формат: YYYY-MM-DDThh:mm:ss±hh:mm.

Для заказа Softline Checkout: дата и время создания заказа

pay_date

string

Дата и время успешного завершения оплаты

Формат: YYYY-MM-DDThh:mm:ss±hh:mm
Если оплата не завершена, то параметр будет передан с пустым значением ("")

Для заказа Softline Checkout: дата и время успешной оплаты заказа

currency

string

required

Код валюты платежа

Формат: ISO 4217 alpha-3, 3 символа
Варианты значений см. в справочнике

Для заказа Softline Checkout: код валюты заказа

recurring_indicator

boolean

required

Признак родительского заказа с возможностью автооплаты через Payments API
Варианты значений:

true - заказ является родительским и для него может быть инициирован автоплатеж через Payments API. Узнайте больше о сценариях такой покупки:
- Автоплатежи
- Покупка через корзину с последующими автоплатежами
false - заказ не является родительским.

locale

string

required

Код языка интерфейса платежной формы
Варианты значений см. в справочнике.

order_detail_url

string

required

Cсылка на страницу платежной формы
При получении данных по платежу в тестовой среде - ссылка будет предназначена для тестовой среды (ссылка будет иметь суффикс .demoslweb.com).

Для заказа Softline Checkout: ссылка на страницу заказа

total_discount_amount

string

required

Не используется, параметр будет передан с значением (0.00).

Для заказа Softline Checkout: итоговая сумма скидки по всем позициям заказа

total_vat_amount

string

required

Сумма VAT

Передается в валюте платежа
Формат: Число с 2 десятичными знаками, разделитель - точка, передается как строка
Если процент VAT равен нулю, то параметр будет передан с значением "0.00"

Для заказа Softline Checkout: итоговая сумма VAT по всем позициям заказа

total_amount

string

required

Сумма платежа с учетом VAT

Передается в валюте платежа
Учитывает VAT
Формат: Число с 2 десятичными знаками, разделитель - точка, передается как строка

Для заказа Softline Checkout: итоговая сумма заказа

payment

object

required

Информация об оплате

payment

payment_method

string

required

Код платежного метода
Варианты значений см. в справочнике.

payment

payment_system_name

string

required

Название платежного метода (техническое значение)

payment

card_last_4

string

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

Может быть заполнено, если покупатель успешно завершил оплату банковской картой. В ином случае, параметр будет передан с пустым значением (null).

payment

card_expiration_date

string

Срок окончания действия банковской карты покупателя
Может быть заполнено, если покупатель успешно завершил оплату банковской картой. В ином случае, параметр будет передан с пустым значением ("").

Формат значения: MM/YYYY, например, 12/2026.

payment

is_installment_payment

boolean

required

Не используется, всегда будет передано false

Для заказа Softline Checkout: наличие оплаты в рассрочку Softline Checkout

customer

object

required

Данные покупателя

customer

country

string

required

Код страны покупателя

Формат: ISO 3166-1 alpha-2
Варианты значений см. в справочнике

customer

type

string

required

Тип покупателя

Варианты значения:

physical - физическое лицо
juridical - юридическое лицо

customer

string

required

E-mail покупателя

customer

first_name

string

required

Имя покупателя

customer

last_name

string

required

Фамилия покупателя

customer

phone

string

Телефон покупателя
Если не заполнен, то параметр будет передан с пустым значением ("").

customer

vat_number

string

Номер налогоплательщика покупателя
Также, используется для передачи:

ИНН компании при оплате в рублях
DNI/CUIL или CUIT при оплате в аргентинских песо

Если не заполнен, то параметр будет передан с пустым значением ("").

customer

company_name

string

Наименование компании покупателя

Если не заполнено, то параметр будет передан с пустым значением ("").

customer

company_billing_address

string

Юридический адрес компании покупателя

Если не заполнен, то параметр будет передан с пустым значением ("").

customer

company_delivery_address

string

Фактический адрес компании покупателя

Если не заполнен, то параметр будет передан с пустым значением ("").

products

array [objects]

required

Дополнительные данные платежа

Для заказа Softline Checkout: информация о продукте в заказе

products / [object]

number

required

Не используется, будет заполнено техническим значением

Для заказа Softline Checkout: идентификатор продукта

products / [object]

vendor_code

string

Не используется, будет передано пустым ("") или заполнено техническим значением

Для заказа Softline Checkout: ваш идентификатор продукта

products / [object]

sku

string

Не используется, будет передано пустым ("") или заполнено техническим значением

Для заказа Softline Checkout: ваш SKU продукта

products / [object]

business_segment

string

Не используется, будет передано пустым ("") или заполнено техническим значением

Для заказа Softline Checkout: бизнес сегмент продажи

products / [object]

name

string

required

Описание платежа
Это описание вы передаете при создании платежа (payment_description) или проведении автоплатежа (payment_description).

Для заказа Softline Checkout: полное наименование продукта

products / [object]

price

string

required

Сумма платежа без учета VAT

Формат: Число с 2 десятичными знаками, разделитель - точка. Передается как строка.

Для заказа Softline Checkout: цена за одну единицу продукта в валюте заказа

products / [object]

quantity

number

required

Не используется, всегда передается "1".

Для заказа Softline Checkout: количество единиц продукта в заказе

products / [object]

discount_percent

string

Не используется, параметр будет передан с пустым значением.

Для заказа Softline Checkout: процент скидки на продукт в заказе

products / [object]

discount_amount

string

Не используется, параметр будет передан с пустым значением ("")

Для заказа Softline Checkout: сумма скидки на продукт в заказе

products / [object]

vat_percent

string

required

Процент VAT

products / [object]

vat_amount

string

required

Сумма VAT

Передается в валюте платежа
Формат: Число с 2 десятичными знаками, разделитель - точка, передается как строка
Если процент VAT равен нулю, то параметр будет передан с значением "0.00"

products / [object]

amount

string

required

Полная сумма платежа

Передается в валюте платежа
Учитывает VAT
Формат: число с 2 десятичными знаками, разделитель - точка, передается как строка

Для заказа Softline Checkout: cтоимость продукта

products / [object]

margin

string

required

Сумма вашего дохода

Передается в валюте платежа
Формат: число с 2 десятичными знаками, разделитель - точка, передается как строка

products / [object]

return

object

Информация о возврате
Передается, если был сделан возврат. В ином случае не передается.

products / [object] / return

type

string

required*

Тип операции

* - Обязательный параметр, если был передан параметр products.return.

Варианты значений:

returned - возврат/chargeback
removed - не используется в Softline Payments

products / [object] / return

date

required*

Дата и время события

* - Обязательный параметр, если был передан параметр products.return
Формат: YYYY-MM-DDThh:mm:ss±hh:mm

products / [object] / return

reason

string

required*

Описание причины возврата

* - Обязательный параметр, если был передан параметр products.return.

Примеры значений:

Географически ограничения
Повторная оплата
ChargeBack
Дубли заказа
Тестовый заказ

или другая причина.

additional_data

array [objects]

Дополнительные параметры
Эти параметры могут быть заполнены при создании платежа (additional_data) или в процессе обработки. Обратите внимание, срок хранения дополнительных параметров платежа ограничен.

additional_data / [object]

name

string

required*

Название дополнительного параметра

* - Обязательный параметр, если был передан параметр additional_data.

additional_data / [object]

value

string

required*

Значение дополнительного параметра

* - Обязательный параметр, если был передан параметр 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",
  "recurring_indicator": false,
  "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

array [objects]

required

Список ошибок

errors / [error object]

error

number

required

Код ошибки

errors / [error object]

message

string

Описание ошибки

Пример ответа об ошибке

{
  "errors": [{
      "error": 15020,
      "message": "Order not found."
    }
  ]
}