Documentación Collectar

Documentación Collectar

Documentación técnica de integración

Planes de pago

Estimated reading: 5 minutes 125 views

El siguiente bloque, contiene el detalle de campos a utilizar para el registro de planes de pago:

Planes fijo

Este método se utiliza para aquellos casos donde el importe a cobrar es el mismo en todas las cuotas, el cobro siempre es mensual y el mismo día que se realiza la primera transacción.

Ejeplo de petición
				
					{
"instalments":"6",
"attempts":"5",
"amount":5250,
"email":"correo@gmail.com"
}
				
			

En este caso creará un plan de pagos de 6 meses de duración, en cada cuota realizará 5 reintentos de cobro y cobrará 52,50€ en cada cuota. En caso de fallo avisará al email indicando en el campo ‘email’.

Planes a medida

En este caso se puede definir el detalle de todas las cuotas a cobrar, lo que permite variar la fecha de cobro a una fecha concreta y el importe de cada cuota.

Ejemplo de petición
				
					{
"attempts":"5",
"email":"correo@gmail.com",
"listInstalments":
[{
"date": "25-01-2021",
"amount":150
},
{
"date": "26-02-2021",
"amount":120
}]
}
				
			

En este caso el plan de pagos tendrá hasta 5 reintentos y ejecutará 2 cuotas; la primera el 25 de Enero de 2021 por importe de 1,5€ y la segunda el 26 de Febrero de 2021 por 1,20€. En caso de error informará al correo indicado.

Para crearse un plan de pagos debemos tener un pago exitoso, sólo en el caso de que el pago sea OK se creará el plan de pagos.

Hay que tener en cuenta que el pago inicial ya se considera la primera cuota, con lo cual si es un contrato a 12 meses, el número de cuotas sería 11 siendo la primera el día de la captura. Además, esta primera cuota puede ser del mismo importe que el plan de pagos o puede ser de otro importe, incluso 0€. Este se define en el campo amount de la configuración general de ese pago.

Dentro de los planes de pago tenemos además dos métodos que nos van a permitir consultar la situación y detalles de un plan de pagos y cancelar un plan de pagos. Los planes de pago no pueden ser modificados ya que cualquier cambio requiere de una nueva adquisición de la tarjeta, informando al usuario de las nuevas condiciones

Consulta de un plan de pagos

Servicio REST con envío de parámetros por POST

Parámetros de entrada

El campo “signature” contendrá una firma calculada a partir de los parámetros enviados. El orden de los campos es el siguiente:

-channelOperation, client, signature.

El campo signature no viaja en la solicitud. Será facilitado por CollectAR y estará asociado con el comercio cliente dado de alta en pasarela.
Parámetros de salida

Valores válidos para la cadena: 

cuota

Los valores del campo state en el plan de pagos son:

  • ACTIVO – No hay cuotas impagadas y queda cuotas por paga
  • IMPAGADO – Tiene alguna cuota impagada
  • FINALIZADO – Se han terminado de pagar todas las cuotas
Los valores del campo state en la cuota son:

  • Pendiente – Se ha intentado pagar la cuota aún. Posiblemente porque no ha llegado el momento.
  • Realizado con éxito – Se ha realizado correctamente el pago de la cuota.
  • Fallado – Se ha intentado realizar el pago y ha dado algún tipo de error.
  • Impago previo – Alguna cuota anterior del plan está impagada. Este estado evita que se intente pagar esta cuota.

Cancel installment plans

Este servicio web cancela un plan de pagos. La entrada en Json y la salida una cadena para indicar el resultado.

Servicio REST con envío de parámetros por POST
Parámetros de entrada

El campo “signature” contendrá una firma calculada a partir de los parámetros enviados. El orden de los campos es el siguiente:

-channelOperation, client, signature.

El campo signature no viaja en la solicitud. Será facilitado por CollectAR y estará asociado con el comercio cliente dado de alta en pasarela.
Parámetros de salida

CONTENTS
en_GBEnglish (UK)