настройки магазина

GET 
/services/:service_id

получить настройки магазина

Request

Path Parameters

service_id integerrequired

номер магазина

Responses

200

OK

application/json

Schema

Schema

id int32required

Possible values: >= 1

идентификатор магазина

name stringrequired

Possible values: <= 128 characters

имя магазина

logo urinullable

логотип (опциональный)

lang string

Possible values: <= 2 characters, [RU, EN]

язык формы по умолчанию

payment_types

object[]

required

доступные способы оплаты

Array [

name stringrequired

Possible values: <= 128 characters

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

mnemonic payment-type (string)required

Possible values: [card, applepay, yandexpay, yandexsplit, googlepay, sbp, mirpay]

способ оплаты, значение для mnemonic

]

success_url string

Possible values: <= 255 characters

страница, на которую нужно перенаправить плательщика при изменении Invoice.status на "success"

fail_url string

Possible values: <= 255 characters

страница, на которую нужно перенаправить плательщика при изменении ошибке

recurrent_url urinullable

Possible values: <= 255 characters

адрес с офертой для рекуррентных платежей

cardholder_is_required boolean

Требовать отправки Cardholder Name при оплате картой

require_email int32

обязательность заполнения email

require_email_mode int32

Possible values: <= 1, [0, 1]

отображать поле ввода email(если require_email True, то всегда 1), 0 - не отображать, 1 - отображать

Example (from schema)

{
  "id": 1000,
  "name": "my shop",
  "logo": "https://partner.life-pay.ru/gui/lifepay_widget/img/lifepay_logo.png",
  "lang": "RU",
  "payment_types": [
    {
      "name": "string",
      "mnemonic": "card"
    }
  ],
  "success_url": "https://test.dev/success",
  "fail_url": "https://test.dev/fail",
  "recurrent_url": "string",
  "cardholder_is_required": true,
  "require_email": 1,
  "require_email_mode": 1
}

success

{
  "id": 1,
  "name": "Какой-то тестовый магазин",
  "logo": "https://partner.life-pay.ru/gui/images/logo.png",
  "lang": "RU",
  "payment_types": [
    {
      "name": "Оплата картой",
      "mnemonic": "card"
    },
    {
      "name": "СБП",
      "mnemonic": "sbp"
    }
  ],
  "success_url": "http://dev.local/success",
  "fail_url": "http://dev.local/fail",
  "recurrent_url": "https://life-pay.ru",
  "required_email": 0,
  "require_email_mode": 1
}

400

Bad Request

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

BadRequest

{
  "code": "missing_required_request_parameter",
  "message": "Отсутствует обязательный параметр запроса"
}

InvalidParameterValue

{
  "code": "invalid_parameter_value",
  "message": "Некорректный параметр запроса"
}

401

Unauthorized

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

Unauthorized

{
  "code": "unauthorized",
  "message": "Ошибка аутентификации"
}

404

Not Found

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

NotFound

{
  "code": "resource_not_found",
  "message": "Запрашиваемая информация не найдена"
}

429

Too Many Requests

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

Too Many Requests

{
  "code": "too_many_requests",
  "message": "Превышено ограничение на количество запросов в секунду"
}

498

Invalid Token

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

No Service Id

{
  "code": "invalid_token",
  "message": "Ошибка JWT Token. Идентификатор service_id в теле токена не может быть пустым",
  "info": "JWT token must contain service_id"
}

Bad Service Id

{
  "code": "invalid_token",
  "message": "Ошибка JWT Token. Вы не можете проводить операцию для этого service_id",
  "info": "Service_id in JWT token doesn't match service_id from URL"
}

Loading...