создать счет на оплату

POST 
/invoices

создать счет на оплату

Request

application/json

Body

required

Примеры для метода "создать счёт на оплату"

email email

email покупателя

phone integer

телефон покупателя

is_recurrent boolean

согласие на проведение повторных списаний

send_receipt_through string

Possible values: [email, sms, nothing]

Default value: email

отправить чек через

split_data

object[]

данные о сплитованных платежах

Array [

order_id string

Possible values: <= 64 characters

номер заказа на стороне поставщика

amount floatrequired

Possible values: >= 1

сумма в валюте

comment string

Possible values: non-empty and <= 128 characters

комментарий

merchant_id stringrequired

идентификатор участника сплита

]

recurrent_schedule object

расписание рекуррентного платежа

url_success uri

Possible values: <= 255 characters

URL для редиректа успешных оплат. Если не указан, то берется параметр url_success из настроек магазина

url_error uri

Possible values: <= 255 characters

URL для редиректа неудачных оплат. Если не указан, то берется параметр url_error из настроек магазина

expire_date date-time

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

comment string

Possible values: <= 512 characters

Комментарий платежа

order_id stringrequired

Possible values: <= 64 characters

номер заказа на стороне интернет-магазина

amount stringrequired

Possible values: non-empty

сумма в валюте

currency_code stringrequired

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

Default value: RUB

валюта

service_id integer

принадлежность магазину

name stringrequired

Possible values: non-empty and <= 128 characters

наименование счета

Responses

201

OK

application/json

Schema

Schema

order_id stringrequired

Possible values: <= 64 characters

номер заказа на стороне интернет-магазина

amount stringrequired

Possible values: non-empty

сумма в валюте

currency_code stringrequired

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

Default value: RUB

валюта

service_id integer

принадлежность магазину

name stringrequired

Possible values: non-empty and <= 128 characters

наименование счета

id uuidrequired

идентификатор счета

short_id integerrequired

инкрементальный идентификатор счета (удобно использовать при обращении в техподдержку)

status stringrequired
Possible values: [error, open, success]
• open - счет открыт
• pending - началась оплата по ссылке, необходимо отобразить лоадер на форме
• success - счет успешно оплачен
• blocked - средства захолдированы, но еще не оплачены/возвращены (двухстадийная оплата)
• error - счет нельзя оплатить (истек)
email email

email покупателя

phone integer

телефон покупателя

is_recurrent boolean

согласие на проведение повторных списаний

send_receipt_through string

Possible values: [email, sms, nothing]

Default value: email

отправить чек через

recurrent_url urinullable

Possible values: <= 255 characters

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

split_data

object[]

данные о сплитованных платежах

Array [

order_id string

Possible values: <= 64 characters

номер заказа на стороне поставщика

amount floatrequired

Possible values: >= 1

сумма в валюте

comment string

Possible values: non-empty and <= 128 characters

комментарий

merchant_id stringrequired

идентификатор участника сплита

]

recurrent_schedule object

расписание рекуррентного платежа

url_success uri

Possible values: <= 255 characters

URL для редиректа успешных оплат. Если не указан, то берется параметр url_success из настроек магазина

url_error uri

Possible values: <= 255 characters

URL для редиректа неудачных оплат. Если не указан, то берется параметр url_error из настроек магазина

expire_date date-time

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

comment string

Possible values: <= 512 characters

Комментарий платежа

charge

object

сущность Charge

id uuid

идентификатор сущности

payment_token_id uuid

идентификатор токена

status string

Possible values: [waiting_3ds, charged, progress, refunded, refund_error, error, blocked]

form_link string

Ссылка для оплаты счета

Example (from schema)

{
  "order_id": "my-order-01",
  "amount": "100.00",
  "currency_code": "RUB",
  "service_id": 87668,
  "name": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "short_id": 491883531,
  "status": "open",
  "email": "dev@life-pay.ru",
  "phone": 79999999999,
  "is_recurrent": false,
  "send_receipt_through": "email",
  "recurrent_url": "string",
  "split_data": [
    {
      "order_id": "my-order-01",
      "amount": 100,
      "comment": "часть заказа #123",
      "merchant_id": "12345"
    }
  ],
  "recurrent_schedule": {},
  "url_success": "string",
  "url_error": "string",
  "expire_date": "2024-01-29 12:00:00",
  "comment": "string",
  "charge": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "payment_token_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "waiting_3ds"
  },
  "form_link": "http://partner.life-pay.ru///alba/paymentspa/1000150/de3230a2a594d30b5145fbbdeeb569c400971bc7/?go"
}

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": "Ошибка аутентификации"
}

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...