Активировать платежную ссылку

POST 
/activate_rpl

Метод для подготовки статической платежной ссылки к работе.

Request

application/json

Body

apikey LpApiKey (string)required

API ключ из кабинета LIFE PAY. Ключ можно получить в разделе Настройки → Разработчикам

uuid NspkId (string)required

Possible values: Value must match regular expression ^[A-Z][A-Z0-9]{31}$

Значение ссылки после /web.qr.nspk.ru/. Пример: https://web.qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2

description stringrequired

Possible values: <= 2000 characters

Назначение платежа. В случае, если description передается в формате "<товар 1> x <кол-во> = <сумма>, <товар 2> x <кол-во> = <сумма>", то позиции в чеке и счете на оплату будут разбиты на отдельные строчки.

amount integerrequired

Сумма платежа в копейках которая будет отправлена по кассовой ссылке. Примеры корректных значений: 10000, 14020

order_id stringrequired

id заказа в кассовом ПО, используется для дальнейшей идентификации в системе и проведения возвратов

callback_url string

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

Responses

200

Ответ API

application/json

Schema

Schema

anyOf

ActivateLinkSuccessResponse

code ActivateLinkStatusCode (integer)required

Possible values: [0, 1, 2, 3]

Код ответа:

• 0 - успешный запрос.
• 1 - Ошибка в apikey \ ошибка в uuid.
• 2 - Дубль по параметру order_id.
• 3 - В запросе отсутствует поле amount

message stringrequired

Сообщение о статусе операции

data

object

required

lp_transaction_number stringrequired

payment_url stringrequired

ActivateLinkErrorResponse

code ActivateLinkStatusCode (integer)required

Possible values: [0, 1, 2, 3]

Код ответа:

• 0 - успешный запрос.
• 1 - Ошибка в apikey \ ошибка в uuid.
• 2 - Дубль по параметру order_id.
• 3 - В запросе отсутствует поле amount

message stringrequired

Сообщение об ошибке

data

object

lp_transaction_number string

payment_url string

Example (from schema)

{}

Success (code 0)

{
  "code": 0,
  "message": "Activated.",
  "data": {
    "lp_transaction_number": "10510020312",
    "payment_url": "https://web.qr.nspk.ru/A837MBJMT9E5QRJGT4"
  }
}

Error (code 1)

{
  "code": 1,
  "message": "Not found.",
  "data": {}
}

Error (code 2)

{
  "code": 2,
  "message": "Заказ уже существует (номер заказа).",
  "data": {}
}

Error (code 3)

{
  "code": 3,
  "message": "QR код не создан",
  "data": {}
}

400

Validation error

application/json

Schema

Schema

validation_error

object

body_params

object[]

Array [

loc string[]required

msg stringrequired

type stringrequired

]

Example (from schema)

{
  "validation_error": {
    "body_params": [
      {
        "loc": [
          "string"
        ],
        "msg": "string",
        "type": "string"
      }
    ]
  }
}

415

Unsupported Media Type error

application/json

Schema

Schema

validation_error

object

body_params

object[]

Array [

loc string[]required

msg stringrequired

type stringrequired

]

Example (from schema)

{
  "validation_error": {
    "body_params": [
      {
        "loc": [
          "string"
        ],
        "msg": "string",
        "type": "string"
      }
    ]
  }
}

Callbacks

POST TransactionCallback

POST 
{$request.body#/callback_url}

Формат сообщений который отправляется сервером LIFE PAY в формате POST запроса. Сообщения отправляются с хоста 84.252.142.255

application/json

Body

order_id stringrequired

Номер заказа по которому была активирована ссылка.

lp_transaction_number stringrequired

Номер транзакции в системе LIFE PAY.

amount numberrequired

Сумма транзакции.

description stringrequired

Описание платежа которое было передано при активации ссылки.

status stringrequired

Possible values: [error, completed]

Конечный статус транзакции.

status_code numberrequired

Possible values: [10, 20]

Код значения статуса транзакции. 10 - успешен. 20 - неуспешен

transaction_type stringrequired

Possible values: [payment, refund]

Тип транзакции

created_at stringrequired

Время в которое была активирована транзакция по времени сервера.

updated_at stringrequired

Время изменения статуса транзакции.

Callbacks Responses

200

OK

Loading...