# Obtener detalles sobre una intención de pago

Obtén los detalles sobre una intención de pago específica.

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

## Path parameters:

  - `id` (string, required)
    El payment-intent.id sobre el cual deseas obtener información detallada.
    Example: "a3b92311-1888-449f-acaa-49ae28d68fcd"

## Response 200 fields (application/json):

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

  - `customer` (string, required)
    ID único de Belvo para el cliente relacionado con esta intención de pago.
    Example: "1c83ead8-6665-429c-a17a-ddc76cb3a95e"

  - `external_id` (string)
    Un identificador único adicional para el recurso con fines internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para almacenar su propio identificador único para cada recurso (cliente, cuenta bancaria, intención de pago o inscripción). Esto puede ser útil para rastrear el recurso en su sistema y para fines de depuración.
{% /admonition %}
    Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"

  - `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"

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

  - `updated_at` (string,null, required)
    La marca de tiempo ISO-8601 de cuando se actualizó por última vez la intención de pago.
    Example: "2022-02-09T08:45:50.406032Z"

  - `status` (string, required)
    El estado actual de la intención de pago.
    Enum: "REQUIRES_PAYMENT_METHOD", "REQUIRES_ACTION", "SUCCEEDED", "PROCESSING", "FAILED"

  - `amount` (string, required)
    Monto a ser pagado por su cliente.
    Example: "1234.12"

  - `currency` (string, required)
    La moneda del monto pagado, por ejemplo, BRL (Real Brasileño).
    Enum: "BRL"

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

  - `statement_description` (string)
    Una descripción que aparecerá en el extracto bancario del cliente (recomendado).

> Nota: Si no utiliza el parámetro statement_description, se usará el valor de description como la descripción del extracto.
    Example: "Super Shoe Store - Brown Sneakers"

  - `selected_payment_method_type` (string, required)
    Tipo de método de pago seleccionado. Para OFPI de 🇧🇷 Brasil, puede ser:

  - open_finance: Para pagos regulares.
  - open_finance_biometric_pix: Para pagos biométricos utilizando la red PIX.
    Enum: "open_finance", "open_finance_biometric_pix"

  - `allowed_payment_method_types` (array, required)
    Una lista de tipos de métodos de pago permitidos en esta intención de pago. Para OFPI, el valor será open_finance.
    Example: ["open_finance"]

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

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

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

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

  - `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/"

  - `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"

  - `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"

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

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

  - `metadata` (object)
    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"}

  - `charges` (array)
    Un array de objetos de cargo relacionados con esta intención de pago. Si no hay cargos asociados, devolvemos un array vacío.

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

  - `charges.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"

  - `charges.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"

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

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

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

  - `charges.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"

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

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

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

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

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

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

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

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

  - `charges.payment_method_details.open_finance.schedule` (object,null)
    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.

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

  - `charges.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"

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

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

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

  - `charges.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/"

  - `charges.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"

  - `charges.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"

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

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

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

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

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

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

  - `charges.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"

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

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

  - `charges.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"

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

  - `charges.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"

  - `charges.transactions.currency` (string, required)
    La moneda del monto pagado, por ejemplo, BRL (Real Brasileño).
    Enum: "BRL"

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

  - `charges.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"

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

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

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

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

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

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

  - `charges.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"}

  - `charges.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"

  - `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"

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

Información sobre el error que encontraste en el paso anterior de la intención de pago, si corresponde. Este error puede ocurrir cuando algo inesperado sucede durante el proceso de la intención de pago.

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

Objeto que detalla los próximos pasos que debes seguir para un tipo específico de next_step.

## 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"