# Payment Instruction List

Este método se conecta a la plataforma del Coordinador Eléctrico Nacional (CEN) y obtiene la lista de instrucciones de pago asociadas al acreedor enviado como parámetro. Retorna los datos correspondientes de las instrucciones de pago en formato JSON.

El uso del campo CallbackUrl desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir  con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo CallbackUrl pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Endpoint: POST /v1/cl/services/cenpagos.cl/payments/instruction-list
Version: v1.0
Security: JWT, Api-Key

## Request fields (application/json):

  - `RequestData` (object, required)
    Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

  - `RequestData.Creditor` (string, required)
    Nombre del acreedor del cual se obtendrán las instrucciones de pago.
    Example: "Colbún"

  - `RequestData.Offset` (string, required)
    Posición desde donde comienza la lista de instrucciones de pago.
    Example: "0"

  - `RequestData.Limit` (string, required)
    Posición hasta donde llega la lista de instrucciones de pago.
    Example: "200"

  - `RequestData.AccountCredential` (any)
    Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

  - `CallbackUrl` (string)
    URL para enviar el mensaje de respuesta utilizando un método POST.
    Example: "https://my-api.my-business.com/api/open-data-response"

## Response 200 fields (application/json):

  - `OperationId` (string, required)
    Identificador único de la operación.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Estado de la operación. OK significa que el servicio se ha ejecutado correctamente aunque no devuelva datos. ERROR indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.
    Enum: "OK", "ERROR"

  - `Data` (object,null, required)

  - `Data.PaymentList` (object, required)
    Example: {"TotalInstruccionesDePago":33650,"InstruccionesDePago":[]}

  - `Data.PaymentList.TotalInstruccionesDePago` (integer, required)
    Total de instrucciones de pago.
    Example: 33650

  - `Data.PaymentList.InstruccionesDePago` (array, required)
    Lista de instrucciones de pago.
    Example: []

  - `Data.PaymentList.InstruccionesDePago.IdentificadorUnico` (string, required)
    Identificador único de la instrucción de pago.
    Example: "12345678"

  - `Data.PaymentList.InstruccionesDePago.Concepto` (string, required)
    Concepto del pago.
    Example: "Servicios De Ejemplo"

  - `Data.PaymentList.InstruccionesDePago.Periodos` (string, required)
    Periodo(s) de facturación.
    Example: "Sep25"

  - `Data.PaymentList.InstruccionesDePago.Acreedor` (string, required)
    Nombre del acreedor.
    Example: "Empresa"

  - `Data.PaymentList.InstruccionesDePago.Deudor` (string, required)
    Nombre del deudor.
    Example: "Empresa"

  - `Data.PaymentList.InstruccionesDePago.MontoNeto` (string, required)
    Monto neto mostrado por el portal (como texto).
    Example: "$ 700.000"

  - `Data.PaymentList.InstruccionesDePago.Publicacion` (string, required)
    Fecha de publicación mostrada por el portal (DD/MM/AAAA).
    Example: "21/10/2025"

  - `Data.PaymentList.InstruccionesDePago.FechaMaximaDePago` (string, required)
    Fecha máxima de pago (vacío si no aplica).

  - `Data.PaymentList.InstruccionesDePago.EstadoDeFacturacion` (string, required)
    Estado de facturación.
    Example: "No Facturado"

  - `Data.PaymentList.InstruccionesDePago.EstadoDePago` (string, required)
    Estado de pago.
    Example: "No Pagado"

  - `AdditionalInformation` (string,null, required)
    Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

  - `Error` (object,null, required)
    Objeto con los detalles del error, utilizado cuando Status=ERROR. Si Status=OK este campo será nulo. Puede leer una explicación completa de este objeto visitando [este enlace](https://docs.khipu.com/portal/en/errors/)

  - `Error.Code` (string)
    Código interno del sistema que identifica el error.
    Example: "E201"

  - `Error.Type` (string)
    Indica cómo tratar este código de error específico, en función del tipo de error.
    Enum: "RETRY_IMMEDIATELY", "DO_NOT_RETRY", "WAIT_4_HOURS_BEFORE_RETRY", "RETRY_AFTER_NOTIFICATION"

  - `Error.Description` (string)
    Descripción asociada al código de error.
    Example: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."

  - `LifeSpan` (string,null, required)
    null en peticiones sincrónicas.

## Response 202 fields (application/json):

  - `OperationId` (string, required)
    Identificador único de la operación.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Estado de la operación. Al realizar solicitudes asíncronas, siempre devolverá OK.
    Example: "OK"

  - `Data` (object, required)
    null en solicitudes asíncronas.

  - `AdditionalInformation` (string, required)
    Mensaje de la operación, puede usarse para mostrar información adicional.
    Example: "Data will be sent to the callback URL."

  - `Error` (object, required)
    null en solicitudes asíncronas.

  - `LifeSpan` (string, required)
    Fecha máxima estimada de entrega para solicitudes asíncronas, en formato de fecha y hora ISO 8601, zona horaria UTC.
    Example: "2017-07-22T00:00:00-0400"


## Response 400 fields

## Response 401 fields

## Response 404 fields

## Response 500 fields