Registrar Suscripción

Permite registrar la información para generar una suscripción junto a la información del cliente

Método

POST

URL

https://b61cr11gvd.execute-api.us-east-1.amazonaws.com/v1/api/payment/suscription

Encabezados de solicitud

Nombre	Tipo	Descripción
Authorization*	string	Bearer Token

Cuerpo de la solicitud

Campo	Estructura	Tipo	Requerido	Descripción
hash*		string	si	Hash generado en /payment/create
plan_id		string	sí	id del plan que se le asignará al cliente para activar la suscripción.
start_date		string	no	Fecha de inicio de la suscripción en formato DD/MM/AAAA. Si no se proporciona, se asignará la fecha de invocación. Esta fecha corresponde al primer pago y marca el comienzo de la frecuencia de pagos de la suscripción. Si el pago es con tarjeta de credito se tomara esta fecha como la fecha de hoy.
customer		struct	sí	Estructura con la información de usuario a la que se le enviará la suscripción
email	customer	string	sí	Correo electrónico del cliente. Debe cumplir con el formato estándar de correo válido.
user_di	customer	string	sí	Número del documento de identidad del cliente.
type_di	customer	string	sí	Tipo del documento de identidad del cliente.
first_name	customer	string	sí	Nombre del cliente en el documento de identidad (no acepta caracteres especiales ni acentos).
last_name	customer	string	sí	Apellido del cliente en el documento de identidad (no acepta caracteres especiales ni acentos).
cellphone	customer	string	sí	Número de celular del cliente. Debe llevar el indicativo del país.
credit_card_data		struct	no	Estructura para activar débito automático de tarjeta.
card_number	credit_card_data	string	sí (débito automático activo)	Número de la tarjeta.
cvv	credit_card_data	int	sí (débito automático activo)	Código de seguridad de la tarjeta.
expiration_date	credit_card_data	string	sí (débito automático activo)	Fecha de expiración de la tarjeta en formato MM/AA.
retries	credit_card_data	int	no	Define la cantidad de veces que se reintenta un pago en caso de ser fallido (ej. fondos insuficentes). Valor por defecto: 1. Valores permitidos: entre 0 - 4. Si es mayor a 1, se ejecutan los reintentos con un día de diferencia, siempre y cuando el procesador lo permita.
franchise	credit_card_data	string	sí (débito automático activo)	Define la franquicia de la tarjeta.
id_type	credit_card_data	string	sí (débito automático activo)	Tipo de documento de identificación de la persona que realiza la transacción.
id	credit_card_data	string	sí (débito automático activo)	Número de documento de identificación de la persona que realiza la transacción.
holder_name	credit_card_data	string	sí (débito automático activo)	Nombre del titular de la tarjeta, sin apellidos.
holder_last_name	credit_card_data	string	sí (débito automático activo)	Apellidos del titular de la tarjeta.
email	credit_card_data	string	sí (débito automático activo)	Dirección de correo electrónico de la persona que realiza la transacción.
phone	credit_card_data	string	sí (débito automático activo)	Número telefónico de la persona que realiza la transacción sin indicativos.
ip	credit_card_data	string	sí (débito automático activo)	Dirección IP del dispositivo origen de la transacción, del usuario final.
header_user_agent	credit_card_data	string	sí (débito automático activo)	header_user_agent de el navegador de el usuario.
line1	credit_card_data	string	sí (débito automático activo)	Línea 1 asociada a la dirección de facturación del usuario.
line2	credit_card_data	string	sí (débito automático activo)	Línea 2 asociada a la dirección de facturación del usuario.
line3	credit_card_data	string	sí (débito automático activo)	Línea 3 asociada a la dirección de facturación del usuario.
country	credit_card_data	string	sí (débito automático activo)	País del usuario.
city	credit_card_data	string	sí (débito automático activo)	Ciudad del usuario.
state	credit_card_data	string	sí (débito automático activo)	Estado o departamento del usuario.
post_code	credit_card_data	string	sí (débito automático activo)	Código postal de usuario.
customer_id		string	no	Identificador único de un usuario con una suscripción existente. Al crear una nueva suscripción, puedes usar el customer_id para evitar enviar nuevamente la información del usuario y la tarjeta. Con el campo customer_id en el request las estructuras customer y credit_card_data no son requeridas.

Solicitud (ejemplo)

{
  "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"
  }
}

Códigos de respuesta

• 202: Accepted Payment
• 406: Payment declined
• 422: Unprocessable Entity - El body enviado no es correcto
• 401: Unauthorized - Header Authorization not sent
• 401: Unauthorized - Token malformation

Respuesta (ejemplo)

{
  "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"
      }
    }
  }
}

Para los días que no existan en meses donde se debe realizar un pago, por ejemplo el día 31, el límite para realizar el pago de la suscripción será el último día de dicho mes.