Saltar al contenido principal

Registrar Plan

Permite registrar un plan de cobro con la periodicidad de la suscripción y recordatorio de pago oportuno hacia el usuario.

Método

POST

URL

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

Encabezados de solicitud

NombreTipoDescripción
Authorization*stringBearer Token

Cuerpo de la solicitud

NombreTipoDescripción
hash*stringHash generado en /payment/create
interval*stringLa frecuencia con la que se paga un plan. Valores permitidos: month, week, day
interval_count*stringEl número de intervalos (especificados en el atributo interval) entre los pagos del plan. Por ejemplo, si interval=month e interval_count=1, se pagará mensualmente. Si interval=month e interval_count=3, se pagará cada 3 meses. Si interval=week e interval_count=1, se pagará semanalmente.
amount*stringValor del plan. Puede tener máximo 2 números decimales.
description*stringDescripción corta del plan. No incluir caracteres especiales.

Solicitud (ejemplo)

{
"hash": "U2FsdGVkX19oU6%....",
"interval": "month",
"timestamp": 1686943428,
"interval_count": "1",
"amount": "10",
"description": "Test Suscripcion 2"
}

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":"1172a142-f29c-4ddb-b822-b518e9bb79cb",
"description":"",
"interval":"month",
"interval_count":"1",
"amount":"12000",
}
}
}