Регистрация Подписка
Позволяет записывать информацию дл я формирования подписки вместе с информацией о клиенте.
Метод
POST
URL
https://b61cr11gvd.execute-api.us-east-1.amazonaws.com/v1/api/paying/subscription
Заголовки запроса
Имя | Тип | Описание |
---|---|---|
Authorization* | string | Bearer Token |
Текст запроса
Поле | Структура | Тип | Требуется | Описание |
---|---|---|---|---|
hash* | string | да | Хэш, сгенерированный в /payment/create | |
plan_id | string | да | Идентификатор плана, который будет присвоен клиенту для активации подписки. | |
start_date | string | нет | Дата нача ла подписки в формате ДД/ММ/ГГГГ. Если дата вызова не указана, будет назначена дата вызова. Эта дата соответствует первому платежу и знаменует начало периода абонентской платы. Если оплата производится кредитной картой, то этой датой будет считаться сегодняшняя дата. | |
customer | struct | да | Структура с информацией о пользователе, которому будет отправлена подписка | |
customer | string | да | Электронная почта клиента. Должен соответствовать стандартному действующему почтовому формату. | |
user_di | customer | string | да | Идентификационный номер клиента. |
type_di | customer | string | да | Тип документа, удостоверяющего личность клиента. |
first_name | customer | string | да | Имя клиента в удостоверении личности (не допускаются специальные символы или знаки ударения). |
last_name | customer | string | да | Фамилия клиента, указанная в документе, удостоверяющем личность (не допускаются специальные символы или знаки ударения). |
cellphone | customer | string | да | Номер мобильного телефона клиента. Он должен иметь код страны. |
credit_card_data | struct | нет | Структура для активации автоматического дебетования карты. | |
card_number | credit_card_data | string | да (автоматический дебет активен) | Номер карты. |
cvv | credit_card_data | int | да (автоматический дебет активен) | Код безопасности карты. |
expiration_date | credit_card_data | string | да (автоматический дебет активен) | Срок действия карты в формате ММ/ГГ. |
retries | credit_card_data | int | нет | Определяет количество повторных попыток платежа в случае неудачи (например, недостаточно средств). Значение по умолчанию: 1. Допустимые значения: от 0 до 4. Если значение больше 1, повторные попытки выполняются с интервалом в один день, если процессор это позволяет. |
franchise | credit_card_data | string | да (автоматический дебет активен) | Определяет франшизу карты. |
id_type | credit_card_data | string | да (автоматический дебет активен) | Вид документа, удостоверяющего личность лица, осуществляющего сделку. |
id | credit_card_data | string | да (автоматический дебет активен) | Номер документа, удостоверяющего личность лица, осуществляющего транзакцию. |
holder_name | credit_card_data | string | да (автоматический дебет активен) | Имя владельца карты, без фамилии. |
holder_last_name | credit_card_data | string | да (автоматический дебет активен) | Фамилия владельца карты. |
credit_card_data | string | да (автоматический дебет активен) | Адрес электронной почты лица, совершающего транзакцию. | |
phone | credit_card_data | string | да (автоматический дебет активен) | Номер телефона лица, совершающего транзакцию, без позывных. |
ip | credit_card_data | string | да (автоматический дебет активен) | IP-адрес устройства, инициирующего транзакцию, конечного пользователя. |
header_user_agent | credit_card_data | string | да (автоматический дебет активен) | header_user_agent браузера пользователя. |
line1 | credit_card_data | string | да (автоматический дебет активен) | Строка 1 связана с платежным адресом пользователя. |
line2 | credit_card_data | string | да (автоматический дебет активен) | Строка 2 связана с платежным адресом пользователя. |
line3 | credit_card_data | string | да (автоматический дебет активен) | Строка 3 связана с платежным а дресом пользователя. |
country | credit_card_data | string | да (автоматический дебет активен) | Страна пользователя. |
city | credit_card_data | string | да (автоматический дебет активен) | Город пользователя. |
state | credit_card_data | string | да (автоматический дебет активен) | Штат или департамент пользователя. |
post_code | credit_card_data | string | да (автоматический дебет активен) | Почтовый индекс пользователя. |
customer_id | string | нет | Уникальный идентификатор пользователя с существующей подпиской. При создании новой подписки вы можете использовать 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, предел для реализации паго де ла подписка станет последним днем для меня.