Перейти к основному содержимому

Создание счета на оплату методом APM

POST 

/merchant-api/v1/invoices/create-apm

Этот метод создает счет на оплату методом APM

Request

Body

required

Описание тела POST-запроса

    amount numberrequired

    Сумма счета на оплату

    gate_id string

    Идентификатор гейта, используемого для транзакции

    comment stringrequired

    Комментарий счета

    currency_id stringrequired

    Possible values: [USD, EGP, RUB, KZT, EUR, UAH, MXN, INR, TRY, UZS, AZN, MDL, VND, KRW, AED, IDR, PKR, PEN, CLP, MAD, BYN, COP, NGN, ZAR, SAR, XOF, CAD, AUD, GBP, PLN, NZD, NOK, DKK, SEK, HUF, PHP, TJS, RSD]

    Валюта счета

    external_id stringrequired

    Внешний идентификатор заказа клиента (должен быть уникальным)

    succeed_url string

    URL для перенаправления после успешной оплаты

    failed_url string

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

    callback_url string

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

    client_ip string

    IP-адрес плательщика

    account string

    Учетная запись пользователя, связанная с кошельком (например, адрес электронной почты)

    email string

    Электронная почта плательщика

    first_name string

    Имя плательщика

    last_name string

    Фамилия плательщика

    country_code string

    Код страны выставления счета вашего клиента. Может состоять из 2 или 3 букв для разных гейтов

    country_name string

    Название страны вашего клиента

    city string

    Город проживания клиента.Необходимо для некоторых гейтов

    state string

    Страна проживания клиента. Требуется для некоторых гейтов

    zip string

    Почтовый индекс плательщика

    address string

    Адрес клиента. Требуется для некоторых гейтов

    doc_number string

    При совершении платежа в ЮАР необходимо дополнительно передать номер документа, удостоверяющего личность пользователя, в параметре doc_number. Это может быть номер паспорта (1 буква и 8 цифр) или идентификационный номер пользователя (13 цифр). При совершении покупки в валюте MXN необходимо добавить параметр doc_number, содержащий номер документа покупателя: CURP (содержит 18 цифр) для Мексики. In COP currency you need to add doc_number parameter, only digits without spaces and punctuation. В валюте COP необходимо добавить параметр doc_number, только цифры без пробелов и знаков препинания. Установите этот параметр на номер карты гражданства (CC — Cédula de Ciudadanía) или на уникальный номер налогоплательщика Колумбии (NIT — Número de Identificación Tributaria)

    doc_type string

    Тип документа, необходимый для некоторых валютных гейтов COP, возможные значения: CC, NIT

    phone string

    Номер телефона плательщика с кодом страны и без '+'

    service_provider string

    Оператор телефонной связи FREEMONEY, EXPRESSO, ORANGE, MTN - для валюты XOF, ETISALAT, ORANGE, VODAFONE, WEPAY - для валюты EGP

    date_of_birth string

    Дата рождения вашего клиента (должно быть 18+ лет). В формате ISO 8601

    code string

    Телефонный код страны плательщика

    card_cvv string

    CVV кредитной карты

    card_month string

    Месяц истечения срока действия кредитной карты

    card_year string

    Год истечения срока действия кредитной карты

    card_number string

    Номер кредитной карты

    cardholder string

    Владелец кредитной карты

    form_language string

    Possible values: [ru, en, ua, es, it, de, pt, bg, pl, fr]

    Язык формы

    init_payment_token boolean

    Возможность создания платежного токена

    project_url string

    Для некоторых гейтов нужен URL вашего проекта

Responses

Счет на оплату методом APM успешно создан

Schema

    transaction_uid stringrequired

    Уникальный идентификатор транзакции

    amount stringrequired

    Сумма счёта на оплату

    status stringrequired

    Possible values: [Created, Pending, Failed, Succeed, Refund]

    Текущий статус счёта

    remark stringrequired

    Дополнительная информация о статусе

    currency_id stringrequired

    Валюта счёта

    invoice_url stringrequired

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

    external_id numberrequired

    Внешний идентификатор заказа клиента (должен быть уникальным)

    comment stringrequired

    Комментарий к счёту

    created_at stringrequired

    Дата и время создания счёта

Loading...