# Enumere todos los cargos para una intención de pago.

Enumere todos los cargos asociados con una intención de pago.

Endpoint: GET /payments/br/payment-intents/{payment_intent_id}/charges/
Version: 1.223.0
Security: basicAuth

## Path parameters:

  - `payment_intent_id` (string, required)
    El payment-intent.id al que pertenecen los cargos.
    Example: "a3b92311-1888-449f-acaa-49ae28d68fcd"

## Query parameters:

  - `page` (integer)
    Un número de página dentro del conjunto de resultados paginados.
    Example: 1

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

  - `status` (string)
    Devuelve resultados solo para este valor.
    Example: "SUCCEEDED"

  - `status__in` (string)
    Devolver resultados para el estado listado.
    Example: "PENDING,SUCCEEDED"

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.

En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.

  - `results` (array)
    Matriz de objetos de charge.

  - `results.id` (string, required)
    Identificador único de Belvo para el elemento actual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.created_at` (string, required)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.updated_at` (string,null, required)
    La marca de tiempo ISO-8601 de cuando se actualizó por última vez el estado del cargo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.created_by` (string)
    El ID único para el usuario que creó este elemento.
    Example: "bcef7f35-67f2-4b19-b009-cb38795faf09"

  - `results.customer` (string)
    El ID único de Belvo para el cliente para el cual se creó el cargo.
    Example: "531aa631-70a0-4eeb-ab97-51dea3e90c89"

  - `results.payment_intent` (string)
    El payment_intent.id asociado con este cargo.
    Example: "50c04229-7b1d-4a53-951c-8ad53e10c6ca"

  - `results.status` (string, required)
    El estado actual del cargo. Puede ser uno de los siguientes valores:

  - CANCELED
  - PENDING
  - SCHEDULED
  - SUCCEEDED
  - FAILED
  - PARTIAL
    Enum: "CANCELED", "PENDING", "SCHEDULED", "SUCCEEDED", "FAILED", "PARTIAL"

  - `results.amount` (string,null, required)
    El monto del cargo.
    Example: "100.12"

  - `results.currency` (string)
    La moneda del monto pagado. Para 🇧🇷 Brasil, el valor debe ser BRL (Real Brasileño).
    Enum: "BRL"

  - `results.description` (string)
    La descripción del pago.
    Example: "Training shoes"

  - `results.statement_description` (string)
    La descripción que aparecerá en el extracto bancario del cliente (si se proporciona).
    Example: "Super Shoe Store - Brown Sneakers"

  - `results.beneficiary` (string, required)
    ID único de Belvo utilizado para identificar la cuenta bancaria del beneficiario.
    Example: "58524ccc-89ac-4ab6-b62b-c3da3f19a722"

  - `results.payment_method_type` (string)
    Tipo de método de pago seleccionado. Para OFPI de 🇧🇷 Brasil, el valor debe ser open_finance.
    Enum: "open_finance"

  - `results.payment_method_details` (object, required)
    Detalles sobre el método de pago.

  - `results.payment_method_details.open_finance` (object)
    Información sobre el pagador de un pago OFPI.

  - `results.payment_method_details.open_finance.schedule` (object,null) — one of:
    Detalles sobre el pago programado (opcional). Para obtener más información sobre cómo programar pagos, consulte nuestra guía dedicada OFPI Scheduled Payments.
    - Soltero/Soltera:
      - `single` (object,null)
        Detalles sobre el pago programado (único).
      - `single.date` (string)
        La fecha en que debe realizarse el pago programado único, en formato YYYY-MM-DD.
        Example: "2024-10-22"
    - Diario:
      - `daily` (object)
        Detalles sobre el pago recurrente diario.
      - `daily.start_date` (string)
        La fecha en la que debe comenzar el pago diario recurrente, en formato YYYY-MM-DD.

>Nota: La start_date debe ser al menos 1 día en el futuro.
        Example: "2024-10-22"
      - `daily.occurrences` (integer)
        El número de veces que el pago debe repetirse.

>Nota: Debes programar al menos 2 ocurrencias y no más de 60.
        Example: 10
    - Semanalmente:
      - `weekly` (object)
        Detalles sobre el pago recurrente semanal.
      - `weekly.start_date` (string)
        La fecha en la que debe comenzar el pago semanal recurrente, en formato YYYY-MM-DD.

>Nota: El start_date debe corresponder al primer day_of_week especificado y ser al menos 1 día en el futuro.
        Example: "2024-10-22"
      - `weekly.day_of_week` (string)
        El día de la semana en que se debe realizar el pago. Puede ser uno de los siguientes valores:

  - MONDAY
  - TUESDAY
  - WEDNESDAY
  - THURSDAY
  - FRIDAY
  - SATURDAY
  - SUNDAY
        Enum: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
      - `weekly.occurrences` (integer)
        El número de veces que el pago debe repetirse.

>Nota: Debes programar al menos 2 ocurrencias y no más de 60.
        Example: 10
    - Mensual:
      - `monthly` (object)
        Detalles sobre el pago recurrente mensual.
      - `monthly.start_date` (string)
        La fecha en la que debe comenzar el pago mensual recurrente, en formato YYYY-MM-DD.

>Nota: El start_date debe corresponder al primer day_of_month especificado y ser al menos 1 día en el futuro.
        Example: "2024-10-26"
      - `monthly.day_of_month` (integer)
        El día del mes en que se debe realizar el pago. Puede ser cualquier número entero entre 1 y 31.
        Example: 26
      - `monthly.occurrences` (integer)
        El número de veces que el pago debe repetirse.

>Nota: Debes programar al menos 2 ocurrencias y no más de 24.
        Example: 12
    - Personalizado:
      - `custom` (object)
        Detalles sobre el pago recurrente personalizado.
      - `custom.dates` (array)
        Las fechas únicas en las que se debe realizar el pago recurrente, en formato YYYY-MM-DD.

>Nota: Las fechas deben ser al menos 1 día en el futuro y no más de 720 días en el futuro.
        Example: ["2024-10-22","2024-10-26"]
      - `custom.description` (string)
        Una descripción del pago recurrente personalizado que se mostrará a su usuario cuando sea redirigido a su banco para aceptar el pago.

> Nota: Recomendamos encarecidamente que este mensaje esté en portugués brasileño y que explique claramente el propósito, así como la naturaleza recurrente del pago.
        Example: "Os pagamentos ocorrerão a cada três dias até a data final (30.09.2024)"

  - `results.payment_method_details.open_finance.payer_institution` (string)
    Identificador único para la institución del pagador.
    Example: "db201c6a-e0ee-4caa-92d6-72b480d6d86f"

  - `results.payment_method_details.open_finance.beneficiary_bank_account` (string)
    El ID único de Belvo utilizado para identificar la cuenta bancaria del beneficiario.
    Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc"

  - `results.payment_method_information` (object, required)
    Información sobre el método de pago seleccionado.

  - `results.payment_method_information.open_finance` (object)
    Tipo de método de pago seleccionado.

  - `results.payment_method_information.open_finance.provider_request_id` (string,null)
    ID único para el pago, tal como lo envía el proveedor.
    Example: "978c0c97ea847e78e8849634473c1f1"

  - `results.payment_method_information.open_finance.redirect_url` (string,null)
    La URL que redirige al usuario al sitio web de su institución para autorizar el pago.
    Example: "https://wakandanational.com/"

  - `results.payment_method_information.open_finance.end_to_end_id` (string,null)
    Un ID único para la transacción en el sistema de pago PIX de Brasil.
    Example: "F203262942022211117487a213b1d140"

  - `results.payment_method_information.open_finance.settlement_date` (string)
    El campo settlement_date indica la fecha en la que se planea liquidar un pago programado (cargo). Este campo es relevante en varios estados del ciclo de vida del cargo:

  - Cargos Programados: Cuando un cargo tiene el estado SCHEDULED, este campo representa la fecha de liquidación planificada.
  - Cargos Completados: Cuando un cargo tiene el estado SUCCEEDED, este campo refleja la fecha en que se realizó el pago.
  - Cargos Fallidos o Cancelados: Cuando un cargo tiene el estado CANCELED o FAILED, este campo aún contendrá la fecha de liquidación calculada originalmente, indicando cuándo se pretendía liquidar el cargo.

> Nota: El settlement_date no cambia según el éxito o el fracaso del cargo. Refleja consistentemente la fecha de liquidación planificada originalmente.
    Example: "2024-10-22"

  - `results.payer_information` (object)
    Información sobre la cuenta bancaria del pagador.

> Nota: Este objeto solo se devuelve cuando el status del cargo es SUCCEEDED.

  - `results.payer_information.bank_account` (object)
    Información sobre la cuenta bancaria del pagador.

  - `results.payer_information.bank_account.type` (string)
    El tipo de la cuenta bancaria del pagador. Puede ser CHECKINGS, SAVINGS o PAYMENTS.
    Example: "CHECKINGS"

  - `results.payer_information.bank_account.agency` (string)
    El número de agencia de la cuenta bancaria del pagador.
    Example: "1234"

  - `results.payer_information.bank_account.number` (string)
    El número de cuenta de la cuenta bancaria del pagador.
    Example: "123456789"

  - `results.payer_information.bank_account.institution_id` (string)
    El ID de institución de Belvo de la cuenta bancaria del pagador.
    Example: "528228e2-d40d-4cec-948d-ec5edd7d081c"

  - `results.transactions` (array)
    Una matriz de objetos Transaction relacionados con el cargo.

  - `results.transactions.id` (string, required)
    Identificador único de Belvo para el elemento actual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.transactions.created_at` (string, required)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.transactions.created_by` (string, required)
    El ID único para el usuario que creó este elemento.
    Example: "bcef7f35-67f2-4b19-b009-cb38795faf09"

  - `results.transactions.amount` (string, required)
    El monto de la transacción.

Nota: El monto mostrado siempre es positivo ya que indicamos la dirección de la transacción en el parámetro transaction_type.
    Example: "1020.00"

  - `results.transactions.currency` (string, required)
    La moneda del monto pagado, por ejemplo, BRL (Real Brasileño).
    Enum: same as `results.currency` (1 values)

  - `results.transactions.description` (string, required)
    La descripción del pago.
    Example: "Training shoes"

  - `results.transactions.transaction_type` (string, required)
    La dirección de la transacción.

  - INFLOW indica dinero que entra en la cuenta.
  - OUTFLOW indica dinero que sale de la cuenta.
    Enum: "INFLOW", "OUTFLOW"

  - `results.transactions.beneficiary` (string, required)
    El ID único de Belvo utilizado para identificar la cuenta bancaria del beneficiario.
    Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc"

  - `results.transactions.payer` (any, required)
    Nota: Para OFPI, esto devolverá un objeto vacío {}.

  - `results.transactions.payment_intent` (string)
    El ID único del payment intent asociado con la transacción.
    Example: "004a28bb-fac2-4172-884b-5b6ea15314ad"

  - `results.transactions.customer` (string)
    El ID único de Belvo para el cliente asociado con esta transacción.
    Example: "9eebd63b-3339-44a9-8a5a-72bb6cb2f310"

  - `results.failure_code` (string,null, required)
    Código de error que explica la razón por la cual un pago no fue exitoso (si corresponde).

  - `results.failure_message` (string,null, required)
    Más información sobre el failure_code.

  - `results.metadata` (object, required)
    Objeto opcional y personalizable donde puedes proporcionar cualquier par clave-valor adicional para tus propósitos internos. Por ejemplo, un número de referencia interno.

⚠️ Nota: Solo puedes proporcionar hasta 50 claves (las claves pueden tener hasta 50 caracteres cada una y cada valor puede tener hasta 500 caracteres). No admitimos objetos anidados, solo valores ASCII.
    Example: {"internal_reference_id":"GGq73487w2"}

  - `results.provider` (string, required)
    Nota: Este campo ha sido desaprobado y será eliminado de la API en el futuro.

El proveedor utilizado para el enlace de pago.
    Enum: "belvo"

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único (access_to_resource_denied) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores access_to_resource_denied, la descripción es:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Un código de error único (not_found) que te permite clasificar y manejar el error de manera programática.
    Example: "not_found"

  - `message` (string)
    Una breve descripción del error.

Para errores not_found, la descripción es:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único (request_timeout) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de request_timeout, la descripción es:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores unexpected_error, la descripción es:

- Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"