Consultar planes de pago

Lectura estimada: 2 minutos

Cuando realiza un plan de pago puede consultar la situación del plan de pago o cancelar este plan, y detener todas las cuotas pendientes.

Si está usando la funcionalidad de planes de pago con éste método, puede conocer el estado de todas las cuotas en un plan de pago. El servicio estará disponible a través de un servicio REST publicado en las siguientes urls:


Test Enviroment	https://test.imspagofacil.es/client2/rservices/v1/plan/search
Production Enviroment	https://imspagofacil.es/client2/rservices/v1/plan/search

Parámetros de solicitud

Parámetro	Descripción	Tipo de dato	Requerido
payment_operation	Channel operation del primer pago	Alfanumérico	Sí
merchant_identifier	Código que identifica a este comercio en específico	Alfanumérico	Sí
signature	Firma de los parámetros enviados con la contraseña proporcionada por Kíneox	Alfanumérico	Sí

El campo «signature» contendrá una firma calculada a partir de los parámetros enviados. El proceso de cálculo del algoritmo y firma se detalla en el Anexo-1 de este documento. El orden de los campos es el siguiente:

-client, channel_operation, signature

El campo signature no viaja en la solicitud. Será facilitado por Kíneox y estará asociado con el campo merchant_identifier

Parámetro de respuesta

Parámetros	Descripción	Tipo de dato
instalments_total	Número de cuotas	Numérico
attempts	Número de re intentos para esta cuota	Numérico
state	Situación para este plan	Alfanumérico
instalments	Cadena de objetos	Cadena

Posibles valores de respuesta para los estados del plan de pagos:


Estados del plan	Resultado
plan.estado.activo	Active
plan.estado.anulado	Canceled
plan.estado.cancelado	Canceled
plan.estado.completado	Finished
plan.estado.ejecucion	Active
plan.estado.finalizado	Finished
plan.estado.impagado	Unpain
plan.estado.ko	Unpain

Cuotas del objeto

Parámetros	Descripcion	Tipo de dato
date	Número de cuotas	Fecha
amount	Cantidad de la cuota	Numérico
state	Situación para este plan de pago	Alfanumérico

Posibles valores de respuesta para los estados de las cuotas:


Estado de las cuotas	Resultado
plan.cuota.estado.impagada	Previous non-payment
plan.cuota.estado.impagoPrevio	Previous non-payment
plan.cuota.estado.pagada	Paid
plan.cuota.estado.pendiente	Pending
plan.cuota.estado.pendienteCaptura	Pending capture

Ejemplo de solicitud

				
					{ "instalmentsTotal": "6",

"attempts": "3",

"state": "canceled",

 "instalments": [ {

 "date": "2019-12-01",

 "amount": 100,

 "state": "2"

},

 { "date": "2020-01-01",

"amount": 100,

"state": "2"

 },

 { "date": "2020-02-01",

"amount": 100,

 "state": "2"

 },

 { "date": "2020-03-01",

 "amount": 100,

 "state": "2"

 },

{ "date": "2020-04-01",

"amount": 100,

"state": "2"

 },

 { "date": "2020-05-01",

"amount": 100,

 "state": "2"

 } ],

 }

Documentación KX PaymentSuite

Documentación técnica de integración

Consultar planes de pago

Parámetros de solicitud

Parámetro de respuesta

Cuotas del objeto

Ejemplo de solicitud