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

Регистрация Подписка

Позволяет записывать информацию для формирования подписки вместе с информацией о клиенте.

Метод

POST

URL

https://b61cr11gvd.execute-api.us-east-1.amazonaws.com/v1/api/paying/subscription

Заголовки запроса

ИмяТипОписание
Authorization*stringBearer Token

Текст запроса

ПолеСтруктураТипТребуетсяОписание
hash*stringдаХэш, сгенерированный в /payment/create
plan_idstringдаИдентификатор плана, который будет присвоен клиенту для активации подписки.
start_datestringнетДата начала подписки в формате ДД/ММ/ГГГГ. Если дата вызова не указана, будет назначена дата вызова. Эта дата соответствует первому платежу и знаменует начало периода абонентской платы. Если оплата производится кредитной картой, то этой датой будет считаться сегодняшняя дата.
customerstructдаСтруктура с информацией о пользователе, которому будет отправлена ​​подписка
emailcustomerstringдаЭлектронная почта клиента. Должен соответствовать стандартному действующему почтовому формату.
user_dicustomerstringдаИдентификационный номер клиента.
type_dicustomerstringдаТип документа, удостоверяющего личность клиента.
first_namecustomerstringдаИмя клиента в удостоверении личности (не допускаются специальные символы или знаки ударения).
last_namecustomerstringдаФамилия клиента, указанная в документе, удостоверяющем личность (не допускаются специальные символы или знаки ударения).
cellphonecustomerstringдаНомер мобильного телефона клиента. Он должен иметь код страны.
credit_card_datastructнетСтруктура для активации автоматического дебетования карты.
card_numbercredit_card_datastringда (автоматический дебет активен)Номер карты.
cvvcredit_card_dataintда (автоматический дебет активен)Код безопасности карты.
expiration_datecredit_card_datastringда (автоматический дебет активен)Срок действия карты в формате ММ/ГГ.
retriescredit_card_dataintнетОпределяет количество повторных попыток платежа в случае неудачи (например, недостаточно средств). Значение по умолчанию: 1. Допустимые значения: от 0 до 4. Если значение больше 1, повторные попытки выполняются с интервалом в один день, если процессор это позволяет.
franchisecredit_card_datastringда (автоматический дебет активен)Определяет франшизу карты.
id_typecredit_card_datastringда (автоматический дебет активен)Вид документа, удостоверяющего личность лица, осуществляющего сделку.
idcredit_card_datastringда (автоматический дебет активен)Номер документа, удостоверяющего личность лица, осуществляющего транзакцию.
holder_namecredit_card_datastringда (автоматический дебет активен)Имя владельца карты, без фамилии.
holder_last_namecredit_card_datastringда (автоматический дебет активен)Фамилия владельца карты.
emailcredit_card_datastringда (автоматический дебет активен)Адрес электронной почты лица, совершающего транзакцию.
phonecredit_card_datastringда (автоматический дебет активен)Номер телефона лица, совершающего транзакцию, без позывных.
ipcredit_card_datastringда (автоматический дебет активен)IP-адрес устройства, инициирующего транзакцию, конечного пользователя.
header_user_agentcredit_card_datastringда (автоматический дебет активен)header_user_agent браузера пользователя.
line1credit_card_datastringда (автоматический дебет активен)Строка 1 связана с платежным адресом пользователя.
line2credit_card_datastringда (автоматический дебет активен)Строка 2 связана с платежным адресом пользователя.
line3credit_card_datastringда (автоматический дебет активен)Строка 3 связана с платежным адресом пользователя.
countrycredit_card_datastringда (автоматический дебет активен)Страна пользователя.
citycredit_card_datastringда (автоматический дебет активен)Город пользователя.
statecredit_card_datastringда (автоматический дебет активен)Штат или департамент пользователя.
post_codecredit_card_datastringда (автоматический дебет активен)Почтовый индекс пользователя.
customer_idstringнетУникальный идентификатор пользователя с существующей подпиской. При создании новой подписки вы можете использовать customer_id, чтобы избежать повторной отправки данных пользователя и карты. При наличии поля customer_id в запросе структуры customer и credit_card_data не требуются.

Запрос (пример)

{
"hash": "",
"plan_id": "1da2c872-3047-4625-9507-22d7a1bd045e",
"start_date": "28/10/2024",
"customer": {
"first_name": "user-name",
"last_name": "last-name",
"user_di": "999999999",
"type_di": "CC",
"cellphone": "+57112321131331",
"email": "user@example.com"
}
}

Коды ответа

  • 202: Accepted Payment
  • 406: Payment declined
  • 422: Unprocessable Entity - El body enviado не корректно
  • 401: Unauthorized - Авторизация заголовка не отправлена
  • 401: Unauthorized - Деформация токена

Ответ (пример)

{
"status": {
"code": 202,
"message": "success",
"kind": "unknown"
},
"data": {
"CODE": "0000",
"DESC": "OK",
"DATA": {
"id": "b45fd212-2c26-4068-9807-2c9c6b8ac204",
"start_date": "14/06/2023",
"status": "ACTIVE",
"plan": {
"id": "50e25c83-12ba-442f-adf8-6d410b376045"
},
"customer": {
"id": "b45fd212-2c26-4068-9807-2c9c6b8ac204"
}
}
}
}

Чтобы дни, которые не существовали в месяцы, нужно реализовать, например, в день 31, предел для реализации паго де ла подписка станет последним днем ​​для меня.