Skip to main content

параметры счета на оплату

GET 
/invoices/:invoice_id

параметры счета на оплату

Request​

Path Parameters

    invoice_id uuidrequired

    внутренний номер инвойса

Responses​

OK

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

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

Loading...