# Crear una nueva Payment Intent Crear una Intención de Pago. Puedes crear una Intención de Pago en las siguientes configuraciones: |Beneficiario|Cliente (Pagador)|Ejemplo| |---|---|---| |Clave Pix|Ya registrado con Belvo|Clave Pix (Con Cliente Existente)| |Clave Pix|Registrar con Belvo en el momento de la solicitud de Intención de Pago|Clave Pix (Con Nuevo Cliente)| |Cuenta Bancaria (Ya Registrada)|Ya Registrado|Cuenta Bancaria (Con Cliente Existente)| |Cuenta Bancaria (Ya Registrada)|Registrar con Belvo en el momento de la solicitud de Intención de Pago|Cuenta Bancaria (Con Nuevo Cliente)| |Cuenta Bancaria (Registrar en el momento de la solicitud de Intención de Pago)|Registrar con Belvo en el momento de la solicitud de Intención de Pago|Cuenta Bancaria (Con Nuevo Cliente y Cuenta Bancaria del Beneficiario)| {% admonition type="warning" name="Pagos Pix" %} Cuando creas Intenciones de Pago usando una Clave Pix, debes realizar una solicitud PATCH Complete a Payment Intent para completar la creación de la Intención de Pago. {% /admonition %} Endpoint: POST /payments/br/payment-intents/ Version: 1.223.0 Security: basicAuth ## Header parameters: - `Belvo-Idempotency-Key` (string) Un UUID para asegurar solicitudes idempotentes. Esta clave ayuda a prevenir operaciones duplicadas al permitir que el servidor reconozca solicitudes repetidas con la misma clave y devuelva la respuesta original en lugar de procesar la solicitud nuevamente. {% admonition type="info" name="Altamente Recomendado" %} Recomendamos encarecidamente incluir este encabezado en cualquier solicitud donde desee asegurar la idempotencia, como al crear recursos o realizar acciones que no deben duplicarse. {% /admonition %} Puede recibir los siguientes errores en caso de que haya un problema con su solicitud: - 409 Conflict: Si una solicitud anterior aún se está procesando con la misma clave de idempotencia. Verifique el encabezado de respuesta Belvo-Idempotency-Status para conocer el estado actual de esa clave de idempotencia. - 422 Unprocessable Entity: Si una nueva solicitud utiliza una clave de idempotencia que se ha utilizado previamente en otra solicitud que contiene una carga útil diferente. En este caso, debe cambiar la clave de idempotencia a un nuevo valor único. {% admonition type="warning" name="En Beta" %} Esta función está actualmente en Beta y solo está disponible para clientes seleccionados. Si encuentra algún problema o está interesado en usar esta función, comuníquese con su representante de Belvo. {% /admonition %} Example: "82737f32-7730-4832-a985-dd86df70301c" ## Request fields (application/json): - `body` (object) — one of: - Pix Keys (Con Cliente Existente): - `amount` (string, required) Cantidad a pagar por su cliente. Puede enviar números con hasta dos decimales, separados por un punto .. Por ejemplo: 1234.12 Example: "1234.12" - `customer` (string, required) ID único de Belvo para referenciar a su cliente creado previamente. Example: "06dc2f14-1217-4480-9b36-550a944a39d1" - `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" - `description` (string, required) Una descripción legible para humanos del pago. Example: "Shoe payment" - `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" - `allowed_payment_method_types` (array, required) Una lista de tipos de métodos de pago permitidos en esta intención de pago. Para Brasil (OFPI), este valor debe establecerse en open_finance. Enum: "open_finance", "open_finance_biometric_pix" - `payment_method_details` (object, required) Detalles sobre el método de pago OFPI. - `payment_method_details.open_finance` (any, required) — one of: - INDIVIDUAL: - `pix_key` (string, required) La clave Pix asociada con el beneficiario de la transacción. Puede ser un correo electrónico, número de teléfono (incluyendo el código de país, por ejemplo, +5511999998888), CPF/CNPJ, o una clave aleatoria. Example: "53497b80-81a2-4ea8-9296-83a909c05bdf" - `payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - NEGOCIOS: - `pix_key` (string, required) La clave Pix asociada con el beneficiario de la transacción. Puede ser un correo electrónico, número de teléfono (incluyendo el código de país, por ejemplo, +5511999998888), CPF/CNPJ, o una clave aleatoria. Example: "53497b80-81a2-4ea8-9296-83a909c05bdf" - `payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `cpf` (string, required) El número de CPF del cliente. Se proporciona cuando está disponible; este valor está ofuscado en las respuestas. Example: 9744477770 - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - `confirm` (boolean, required) Boolean que confirma la intención de pago. Nota: Enviar este parámetro configurado en true confirma la intención de pago. - `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 para la intención de pago. ⚠️ 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"} - `provider` (string) 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" - Pix Keys (Con Nuevo Cliente): - `amount` (string, required) Cantidad a pagar por su cliente. Puede enviar números con hasta dos decimales, separados por un punto .. Por ejemplo: 1234.12 Example: "1234.12" - `customer` (object, required) Crear un cliente para la Iniciación de Pagos - `customer.identifier` (string, required) El número de CPF o CNPJ del cliente. Example: "10187609363" - `customer.name` (string) El nombre completo del cliente que deseas crear. Example: "Gustavo Veloso" - `customer.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" - `customer.email` (string) La dirección de correo electrónico del cliente. Example: "gustavo.veloso@musicabrazil.br" - `customer.phone` (string,null) El número de teléfono del cliente. Example: "+5511987654321" - `customer.address` (string,null) La dirección física del cliente. Example: "Rua de Gustavo Veloso 432, 70200 Brasilia" - `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" - `description` (string, required) Una descripción legible para humanos del pago. Example: "Shoe payment" - `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" - `allowed_payment_method_types` (array, required) Una lista de tipos de métodos de pago permitidos en esta intención de pago. Para Brasil (OFPI), este valor debe establecerse en open_finance. Enum: same as `allowed_payment_method_types` in "Pix Keys (Con Cliente Existente)" (2 values) - `payment_method_details` (object, required) Detalles sobre el método de pago OFPI. - `payment_method_details.open_finance` (any, required) — one of: - INDIVIDUAL: - `pix_key` (string, required) La clave Pix asociada con el beneficiario de la transacción. Puede ser un correo electrónico, número de teléfono (incluyendo el código de país, por ejemplo, +5511999998888), CPF/CNPJ, o una clave aleatoria. Example: "53497b80-81a2-4ea8-9296-83a909c05bdf" - `payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - NEGOCIOS: - `pix_key` (string, required) La clave Pix asociada con el beneficiario de la transacción. Puede ser un correo electrónico, número de teléfono (incluyendo el código de país, por ejemplo, +5511999998888), CPF/CNPJ, o una clave aleatoria. Example: "53497b80-81a2-4ea8-9296-83a909c05bdf" - `payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `cpf` (string, required) El número de CPF del cliente. Se proporciona cuando está disponible; este valor está ofuscado en las respuestas. Example: 9744477770 - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - `confirm` (boolean, required) Boolean que confirma la intención de pago. Nota: Enviar este parámetro configurado en true confirma la intención de pago. - `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 para la intención de pago. ⚠️ 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"} - `provider` (string) Nota: Este campo ha sido desaprobado y será eliminado de la API en el futuro. El proveedor utilizado para el enlace de pago. Enum: same as `provider` in "Pix Keys (Con Cliente Existente)" (1 values) - Cuenta Bancaria (Con Cliente Existente): - `amount` (string, required) Cantidad a pagar por su cliente. Para OFPI, puede enviar números con hasta dos decimales, separados por un . punto. Por ejemplo: 1234.12 Example: "1234.12" - `customer` (string, required) ID único de Belvo para referenciar a su cliente creado previamente. Example: "06dc2f14-1217-4480-9b36-550a944a39d1" - `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" - `description` (string, required) Una descripción legible para humanos del pago. Example: "Shoe payment" - `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" - `allowed_payment_method_types` (array, required) Una lista de tipos de métodos de pago permitidos en esta intención de pago. Para Brasil (OFPI), este valor debe establecerse en open_finance. Enum: same as `allowed_payment_method_types` in "Pix Keys (Con Cliente Existente)" (2 values) - `payment_method_details` (object, required) Detalles sobre el método de pago OFPI. - `payment_method_details.open_finance` (any, required) — one of: - INDIVIDUAL: - `beneficiary_bank_account` (string, required) El ID único de Belvo utilizado para identificar la cuenta bancaria del beneficiario. Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc" - `payer_institution` (string) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - NEGOCIOS: - `beneficiary_bank_account` (string, required) El ID único de Belvo utilizado para identificar la cuenta bancaria del beneficiario. Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc" - `payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `cpf` (string, required) El número de CPF del cliente. Se proporciona cuando está disponible; este valor está ofuscado en las respuestas. Example: 9744477770 - `confirm` (boolean, required) Boolean que confirma la intención de pago. Nota: Enviar este parámetro configurado en true confirma la intención de pago. - `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 para la intención de pago. ⚠️ 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"} - `provider` (string) Nota: Este campo ha sido desaprobado y será eliminado de la API en el futuro. El proveedor utilizado para el enlace de pago. Enum: same as `provider` in "Pix Keys (Con Cliente Existente)" (1 values) - Cuenta Bancaria (Con Nuevo Cliente): - `amount` (string, required) Cantidad a pagar por su cliente. Para OFPI, puede enviar números con hasta dos decimales, separados por un . punto. Por ejemplo: 1234.12 Example: "1234.12" - `customer` (object, required) Crear un cliente para la Iniciación de Pagos - `customer.identifier` (string, required) El número de CPF o CNPJ del cliente. Example: "10187609363" - `customer.name` (string) El nombre completo del cliente que deseas crear. Example: "Gustavo Veloso" - `customer.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" - `customer.email` (string) La dirección de correo electrónico del cliente. Example: "gustavo.veloso@musicabrazil.br" - `customer.phone` (string,null) El número de teléfono del cliente. Example: "+5511987654321" - `customer.address` (string,null) La dirección física del cliente. Example: "Rua de Gustavo Veloso 432, 70200 Brasilia" - `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" - `description` (string, required) Una descripción legible para humanos del pago. Example: "Shoe payment" - `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" - `allowed_payment_method_types` (array, required) Una lista de tipos de métodos de pago permitidos en esta intención de pago. Para Brasil (OFPI), este valor debe establecerse en open_finance. Enum: same as `allowed_payment_method_types` in "Pix Keys (Con Cliente Existente)" (2 values) - `payment_method_details` (object, required) Detalles sobre el método de pago OFPI. - `payment_method_details.open_finance` (any, required) — one of: - INDIVIDUAL: - `beneficiary_bank_account` (object, required) - `beneficiary_bank_account.institution` (string, required) El ID único de Belvo para la institución en la que se crea la cuenta bancaria. Example: "f512d996-583a-4a91-8b5b-eba2e103b068" - `beneficiary_bank_account.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" - `beneficiary_bank_account.holder` (object, required) Detalles sobre el titular de la cuenta bancaria individual. - `beneficiary_bank_account.holder.type` (string, required) El tipo de cuenta bancaria. Para individuos, esto debe establecerse en INDIVIDUAL. Enum: "INDIVIDUAL" - `beneficiary_bank_account.holder.information` (object, required) Información adicional sobre el titular de la cuenta bancaria requerida para crear la cuenta para OFPI. - `beneficiary_bank_account.holder.information.first_name` (string, required) El nombre de pila del titular de la cuenta bancaria. Example: "Gustavo" - `beneficiary_bank_account.holder.information.last_name` (string, required) El apellido del titular de la cuenta bancaria. Example: "Veloso" - `beneficiary_bank_account.holder.information.identifier_type` (string, required) El tipo de documento de identificación del cliente. Para individuos en Brasil, esto debe establecerse en CPF. Enum: "CPF" - `beneficiary_bank_account.holder.information.identifier` (string, required) El número de documento de la identificación del cliente. Example: 191 - `beneficiary_bank_account.details` (object, required) Información sobre la cuenta bancaria. - `beneficiary_bank_account.details.account_type` (string, required) El tipo de cuenta bancaria. Puede ser: - CHECKINGS (también conocida como Conta Corrente en Brasil) - SAVINGS (también conocida como Conta Poupança en Brasil) - SALARY (también conocida como Conta Salário en Brasil) - PAYMENTS (también conocida como Conta de Pagamento Instantâneo o Conta de Pagamento en Brasil) Enum: "CHECKINGS", "SAVINGS", "SALARY", "PAYMENTS" - `beneficiary_bank_account.details.agency` (string, required) La agencia (número de sucursal) de la institución donde se creó la cuenta. Example: "0444" - `beneficiary_bank_account.details.number` (string, required) El número de cuenta bancaria. > 📘 Caracteres válidos para el número de cuenta > > Solo puedes enviar números (^[0-9]+$) en la cadena. Por ejemplo, "457220" es un número de cuenta bancaria válido, mientras que "45722-0" es inválido ya que contiene un guion (-). Example: "457220" - `payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - NEGOCIOS: - `beneficiary_bank_account` (object, required) - `beneficiary_bank_account.institution` (string, required) El ID único de Belvo para la institución en la que se crea la cuenta bancaria. Example: "f512d996-583a-4a91-8b5b-eba2e103b068" - `beneficiary_bank_account.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" - `beneficiary_bank_account.holder` (object, required) Detalles sobre el titular de la cuenta bancaria empresarial. - `beneficiary_bank_account.holder.type` (string, required) El tipo de cuenta bancaria. Para cuentas bancarias de negocios, esto debe establecerse en BUSINESS. Enum: "BUSINESS" - `beneficiary_bank_account.holder.information` (object, required) Información adicional sobre el titular de la cuenta bancaria requerida para crear la cuenta para OFPI. - `beneficiary_bank_account.holder.information.name` (string, required) El nombre completo del negocio Example: "Gustavo Veloso Entertainment Universe" - `beneficiary_bank_account.holder.information.identifier_type` (string, required) El tipo de documento de identificación del cliente. Para las empresas en Brasil, esto debe establecerse en CNPJ. Enum: "CNPJ" - `beneficiary_bank_account.holder.information.identifier` (string, required) El número de documento CNPJ. Example: 191 - `beneficiary_bank_account.details` (object, required) Información sobre la cuenta bancaria. - `beneficiary_bank_account.details.account_type` (string, required) El tipo de cuenta bancaria. Puede ser: - CHECKINGS (también conocida como Conta Corrente en Brasil) - SAVINGS (también conocida como Conta Poupança en Brasil) - SALARY (también conocida como Conta Salário en Brasil) - PAYMENTS (también conocida como Conta de Pagamento Instantâneo o Conta de Pagamento en Brasil) Enum: same as `beneficiary_bank_account.details.account_type` in "INDIVIDUAL" (4 values) - `beneficiary_bank_account.details.agency` (string, required) La agencia (número de sucursal) de la institución donde se creó la cuenta. Example: "0444" - `beneficiary_bank_account.details.number` (string, required) El número de cuenta bancaria. > 📘 Caracteres válidos para el número de cuenta > > Solo puedes enviar números (^[0-9]+$) en la cadena. Por ejemplo, "457220" es un número de cuenta bancaria válido, mientras que "45722-0" es inválido ya que contiene un guion (-). Example: "457220" - `payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `cpf` (string, required) El número de CPF del cliente. Se proporciona cuando está disponible; este valor está ofuscado en las respuestas. Example: 9744477770 - `confirm` (boolean, required) Boolean que confirma la intención de pago. > 📘 Proporcione payer_institution > > Para confirmar la intención de pago (confirm: true), debe proporcionar el parámetro payer_institution. Nota: Enviar este parámetro configurado en true confirma la intención de pago. - `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 para la intención de pago. ⚠️ 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"} - `provider` (string) Nota: Este campo ha sido desaprobado y será eliminado de la API en el futuro. El proveedor utilizado para el enlace de pago. Enum: same as `provider` in "Pix Keys (Con Cliente Existente)" (1 values) - Cuenta Bancaria (Con Nuevo Cliente y Cuenta Bancaria Beneficiaria): - `amount` (string, required) Cantidad a pagar por su cliente. Para OFPI, puede enviar números con hasta dos decimales, separados por un . punto. Por ejemplo: 1234.12 Example: "1234.12" - `customer` (object, required) Crear un cliente para la Iniciación de Pagos - `customer.identifier` (string, required) El número de CPF o CNPJ del cliente. Example: "10187609363" - `customer.name` (string) El nombre completo del cliente que deseas crear. Example: "Gustavo Veloso" - `customer.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" - `customer.email` (string) La dirección de correo electrónico del cliente. Example: "gustavo.veloso@musicabrazil.br" - `customer.phone` (string,null) El número de teléfono del cliente. Example: "+5511987654321" - `customer.address` (string,null) La dirección física del cliente. Example: "Rua de Gustavo Veloso 432, 70200 Brasilia" - `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" - `description` (string, required) Una descripción legible para humanos del pago. Example: "Shoe payment" - `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" - `allowed_payment_method_types` (array, required) Una lista de tipos de métodos de pago permitidos en esta intención de pago. Para Brasil (OFPI), este valor debe establecerse en open_finance. Enum: same as `allowed_payment_method_types` in "Pix Keys (Con Cliente Existente)" (2 values) - `payment_method_details` (object, required) Detalles sobre el método de pago OFPI. - `payment_method_details.open_finance` (any, required) — one of: - INDIVIDUAL: - `beneficiary_bank_account` (object, required) - `beneficiary_bank_account.institution` (string, required) El ID único de Belvo para la institución en la que se crea la cuenta bancaria. Example: "f512d996-583a-4a91-8b5b-eba2e103b068" - `beneficiary_bank_account.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" - `beneficiary_bank_account.holder` (object, required) Detalles sobre el titular de la cuenta bancaria individual. - `beneficiary_bank_account.holder.type` (string, required) El tipo de cuenta bancaria. Para individuos, esto debe establecerse en INDIVIDUAL. Enum: same as `beneficiary_bank_account.holder.type` in "INDIVIDUAL" (1 values) - `beneficiary_bank_account.holder.information` (object, required) Información adicional sobre el titular de la cuenta bancaria requerida para crear la cuenta para OFPI. - `beneficiary_bank_account.holder.information.first_name` (string, required) El nombre de pila del titular de la cuenta bancaria. Example: "Gustavo" - `beneficiary_bank_account.holder.information.last_name` (string, required) El apellido del titular de la cuenta bancaria. Example: "Veloso" - `beneficiary_bank_account.holder.information.identifier_type` (string, required) El tipo de documento de identificación del cliente. Para individuos en Brasil, esto debe establecerse en CPF. Enum: same as `beneficiary_bank_account.holder.information.identifier_type` in "INDIVIDUAL" (1 values) - `beneficiary_bank_account.holder.information.identifier` (string, required) El número de documento de la identificación del cliente. Example: 191 - `beneficiary_bank_account.details` (object, required) Información sobre la cuenta bancaria. - `beneficiary_bank_account.details.account_type` (string, required) El tipo de cuenta bancaria. Puede ser: - CHECKINGS (también conocida como Conta Corrente en Brasil) - SAVINGS (también conocida como Conta Poupança en Brasil) - SALARY (también conocida como Conta Salário en Brasil) - PAYMENTS (también conocida como Conta de Pagamento Instantâneo o Conta de Pagamento en Brasil) Enum: same as `beneficiary_bank_account.details.account_type` in "INDIVIDUAL" (4 values) - `beneficiary_bank_account.details.agency` (string, required) La agencia (número de sucursal) de la institución donde se creó la cuenta. Example: "0444" - `beneficiary_bank_account.details.number` (string, required) El número de cuenta bancaria. > 📘 Caracteres válidos para el número de cuenta > > Solo puedes enviar números (^[0-9]+$) en la cadena. Por ejemplo, "457220" es un número de cuenta bancaria válido, mientras que "45722-0" es inválido ya que contiene un guion (-). Example: "457220" - `payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - NEGOCIOS: - `beneficiary_bank_account` (object, required) - `beneficiary_bank_account.institution` (string, required) El ID único de Belvo para la institución en la que se crea la cuenta bancaria. Example: "f512d996-583a-4a91-8b5b-eba2e103b068" - `beneficiary_bank_account.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" - `beneficiary_bank_account.holder` (object, required) Detalles sobre el titular de la cuenta bancaria empresarial. - `beneficiary_bank_account.holder.type` (string, required) El tipo de cuenta bancaria. Para cuentas bancarias de negocios, esto debe establecerse en BUSINESS. Enum: same as `beneficiary_bank_account.holder.type` in "NEGOCIOS" (1 values) - `beneficiary_bank_account.holder.information` (object, required) Información adicional sobre el titular de la cuenta bancaria requerida para crear la cuenta para OFPI. - `beneficiary_bank_account.holder.information.name` (string, required) El nombre completo del negocio Example: "Gustavo Veloso Entertainment Universe" - `beneficiary_bank_account.holder.information.identifier_type` (string, required) El tipo de documento de identificación del cliente. Para las empresas en Brasil, esto debe establecerse en CNPJ. Enum: same as `beneficiary_bank_account.holder.information.identifier_type` in "NEGOCIOS" (1 values) - `beneficiary_bank_account.holder.information.identifier` (string, required) El número de documento CNPJ. Example: 191 - `beneficiary_bank_account.details` (object, required) Información sobre la cuenta bancaria. - `beneficiary_bank_account.details.account_type` (string, required) El tipo de cuenta bancaria. Puede ser: - CHECKINGS (también conocida como Conta Corrente en Brasil) - SAVINGS (también conocida como Conta Poupança en Brasil) - SALARY (también conocida como Conta Salário en Brasil) - PAYMENTS (también conocida como Conta de Pagamento Instantâneo o Conta de Pagamento en Brasil) Enum: same as `beneficiary_bank_account.details.account_type` in "INDIVIDUAL" (4 values) - `beneficiary_bank_account.details.agency` (string, required) La agencia (número de sucursal) de la institución donde se creó la cuenta. Example: "0444" - `beneficiary_bank_account.details.number` (string, required) El número de cuenta bancaria. > 📘 Caracteres válidos para el número de cuenta > > Solo puedes enviar números (^[0-9]+$) en la cadena. Por ejemplo, "457220" es un número de cuenta bancaria válido, mientras que "45722-0" es inválido ya que contiene un guion (-). Example: "457220" - `payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `schedule` (object) — 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) Programar un pago único (de una sola vez) en el futuro. - `single.date` (string) La fecha en la que se debe realizar el pago programado único, en formato YYYY-MM-DD. >Nota: La fecha debe ser al menos 1 día en el futuro y no más de 720 días en el futuro. Example: "2024-10-22" - Diario: - `daily` (object) Programar un 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) Programar un 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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) Programa un 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) Programar un pago recurrente personalizado. - `custom.dates` (array, required) 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, required) 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)" - `callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `cpf` (string, required) El número de CPF del cliente. Se proporciona cuando está disponible; este valor está ofuscado en las respuestas. Example: 9744477770 - `confirm` (boolean, required) Boolean que confirma la intención de pago. > 📘 Proporcione payer_institution > > Para confirmar la intención de pago (confirm: true), debe proporcionar el parámetro payer_institution. Nota: Enviar este parámetro configurado en true confirma la intención de pago. - `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 para la intención de pago. ⚠️ 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"} - `provider` (string) Nota: Este campo ha sido desaprobado y será eliminado de la API en el futuro. El proveedor utilizado para el enlace de pago. Enum: same as `provider` in "Pix Keys (Con Cliente Existente)" (1 values) ## Response 201 fields (application/json): - `body` (object) — one of: - Clave Pix: - `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: same as `allowed_payment_method_types` in "Pix Keys (Con Cliente Existente)" (2 values) - `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) — one of: Detalles sobre el método de pago Pix Key. - INDIVIDUAL: - `open_finance` (object, required) Tipo de método de pago seleccionado. - `open_finance.pix_key` (string, required) La clave Pix asociada con el beneficiario de la transacción. Puede ser un correo electrónico, número de teléfono (incluyendo el código de país, por ejemplo, +5511999998888), CPF/CNPJ o una clave aleatoria. {% admonition type="info" name="Enmascaramiento de Clave Pix" %} En el caso de que la Clave Pix proporcionada sea un CPF, dirección de correo electrónico o número de teléfono, el valor en payment_method_details.open_finance.pix_key será enmascarado. Si es un CNPJ o una clave Pix aleatoria UUID, el valor no será enmascarado. {% /admonition %} Example: "53497b80-81a2-4ea8-9296-83a909c05bdf" - `open_finance.payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `open_finance.callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `open_finance.cpf` (string,null) El número de CPF del cliente. Se proporciona cuando está disponible; este valor está ofuscado en las respuestas. Example: "23******00" - `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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - NEGOCIOS: - `open_finance` (object, required) Tipo de método de pago seleccionado. - `open_finance.pix_key` (string, required) La clave Pix asociada con el beneficiario de la transacción. Puede ser un correo electrónico, número de teléfono (incluyendo el código de país, por ejemplo, +5511999998888), CPF/CNPJ o una clave aleatoria. {% admonition type="info" name="Enmascaramiento de Clave Pix" %} En el caso de que la Clave Pix proporcionada sea un CPF, dirección de correo electrónico o número de teléfono, el valor en payment_method_details.open_finance.pix_key será enmascarado. Si es un CNPJ o una clave Pix aleatoria UUID, el valor no será enmascarado. {% /admonition %} Example: "53497b80-81a2-4ea8-9296-83a909c05bdf" - `open_finance.payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `open_finance.callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `open_finance.cpf` (string,null, required) El número de CPF del cliente. Se proporciona cuando está disponible; este valor está ofuscado en las respuestas. Example: "23******00" - `payment_method_information` (any, required) — one of: Información sobre el método de pago Pix Key. En el momento de la creación de la intención de pago, solo se incluirá la propiedad open_finance.pix_key_details, que necesitas mostrar a tu usuario para confirmar que sus datos son correctos (ver el esquema Inicial). Después de que confirmen sus datos en tu aplicación y envíes la solicitud PATCH, este objeto se completará con propiedades adicionales (ver el esquema Confirmado). - Inicial: - `open_finance` (object) - `open_finance.pix_key_details` (object) Detalles sobre la Clave Pix utilizada para el pago. Necesitas mostrar esta información a tu usuario para que confirme que los detalles son correctos. Después de que lo confirmen, puedes enviar una solicitud PATCH para confirmar la Intención de Pago. - `open_finance.pix_key_details.identifier` (string) El identificador enmascarado del propietario. Example: "23******00" - `open_finance.pix_key_details.name` (string) El nombre del titular de la Clave Pix. Example: "João da Silva" - Confirmado: - `open_finance` (object) - `open_finance.provider_request_id` (string,null) ID único para el pago, tal como lo envía el proveedor. Example: "978c0c97ea847e78e8849634473c1f1" - `open_finance.redirect_url` (string,null) La URL que redirige al pagador al sitio web de su institución para autorizar el pago. Example: "https://wakandanational.com/" - `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" - `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" - `open_finance.pix_key_details` (object) Detalles sobre la clave Pix utilizada para el pago. - `open_finance.pix_key_details.identifier` (string) El identificador enmascarado del propietario. Example: "23******00" - `open_finance.pix_key_details.name` (string) El nombre del titular de la clave Pix. Example: "João da Silva" - `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: same as `currency` in "Clave Pix" (1 values) - `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,null, required) El ID único de Belvo utilizado para identificar la cuenta bancaria del beneficiario. En el caso de que el beneficiario sea una Clave Pix, este campo será null. - `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 Pix. - `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.pix_key` (string) La clave Pix asociada con el beneficiario de la transacción. Puede ser un correo electrónico, número de teléfono, CPF/CNPJ o una clave aleatoria. Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc" - `charges.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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `charges.payment_method_information` (object, required) Información sobre el método de pago Pix Key después de que la intención de pago ha sido confirmada a través de una solicitud PATCH. - `charges.payment_method_information.open_finance` (object) - `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 pagador 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.payment_method_information.open_finance.pix_key_details` (object) Detalles sobre la clave Pix utilizada para el pago. - `charges.payment_method_information.open_finance.pix_key_details.identifier` (string) El identificador enmascarado del propietario. Example: "23******00" - `charges.payment_method_information.open_finance.pix_key_details.name` (string) El nombre del titular de la clave Pix. Example: "João da Silva" - `charges.payer_information` (object) Información sobre el archivo ChargePayerInformation.yaml - `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` (any) Para los pagos con clave Pix, este será un arreglo vacío. Example: [] - `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: same as `provider` in "Pix Keys (Con Cliente Existente)" (1 values) - `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: same as `provider` in "Pix Keys (Con Cliente Existente)" (1 values) - `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. - `error_code` (string, required) Un código de error único (payment_error) que te permite clasificar y manejar el error de manera programática. Example: "payment_error" - `error_message` (string, required) Una breve descripción del error. Example: "Unexpected error to confirm the payment" - `next_step` (any, required) — one of: 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. - OFPI - Mostrar información del método de pago: - `type` (string) El tipo de next_step que necesitas seguir. Enum: "open_finance_display_payment_method_information", "open_finance_display_confirmation_required", "open_finance_display_needs_redirect", "open_finance_display_payment_processing", "open_finance_display_payment_succeeded", "open_finance_display_payment_failed" - `open_finance_display_payment_method_information` (object) Objeto que detalla qué información del método de pago necesitas mostrar. - `open_finance_display_payment_method_information.institutions` (array) Un array de objetos de institución. - `open_finance_display_payment_method_information.institutions.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_method_information.institutions.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_payment_method_information.institutions.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_payment_method_information.institutions.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_payment_method_information.institutions.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_method_information.institutions.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_payment_method_information.institutions.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_method_information.institutions.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_method_information.institutions.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_method_information.institutions.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_payment_method_information.institutions.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: "BRA", "null" - `open_finance_display_payment_method_information.institutions.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_payment_method_information.institutions.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_payment_method_information.institutions.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. - OFPI - Necesita redirección: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_needs_redirect` (object) Detalles sobre la institución pagadora. - `open_finance_display_needs_redirect.payer_institution` (object) - `open_finance_display_needs_redirect.payer_institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_needs_redirect.payer_institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_needs_redirect.payer_institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_needs_redirect.payer_institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_needs_redirect.payer_institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_needs_redirect.payer_institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_needs_redirect.payer_institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_needs_redirect.payer_institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_needs_redirect.payer_institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_needs_redirect.payer_institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_needs_redirect.payer_institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_needs_redirect.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_needs_redirect.payer_institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_needs_redirect.payer_institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. - OFPI - Se requiere confirmación de visualización: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_confirmation_required` (object) Objeto que detalla los próximos pasos que debes seguir para un tipo específico de next_step. - `open_finance_display_confirmation_required.beneficiary_bank_account` (object) - `open_finance_display_confirmation_required.beneficiary_bank_account.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_confirmation_required.beneficiary_bank_account.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" - `open_finance_display_confirmation_required.beneficiary_bank_account.created_by` (string, required) El ID único para el usuario que creó este elemento. Example: "bcef7f35-67f2-4b19-b009-cb38795faf09" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution` (object, required) - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `open_finance_display_confirmation_required.beneficiary_bank_account.details` (any) — one of: - OFPI (Información de Cuenta PIX): - `country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `account_type` (string, required) El tipo de cuenta bancaria. Puede ser: - CHECKINGS (también conocida como Conta Corrente en Brasil) - SAVINGS (también conocida como Conta Poupança en Brasil) - SALARY (también conocida como Conta Salário en Brasil) - PAYMENTS (también conocida como Conta de Pagamento Instantâneo o Conta de Pagamento en Brasil) Enum: same as `beneficiary_bank_account.details.account_type` in "INDIVIDUAL" (4 values) - `agency` (string, required) La agencia (número de sucursal) de la institución donde se creó la cuenta. Example: "0444" - `number` (string, required) El número de cuenta bancaria. Example: "45722-0" - OFPI (PIX Keys): - `country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `pix_key` (string, required) El identificador de clave PIX de la cuenta bancaria. Example: "RANDOM://6c1c236c-a035-4b80-ab12-e38f88ce82ab" - `open_finance_display_confirmation_required.beneficiary_bank_account.holder` (object, required) Detalles sobre el titular de la cuenta bancaria. - `open_finance_display_confirmation_required.beneficiary_bank_account.holder.type` (string, required) El tipo de cuenta bancaria. Puede ser INDIVIDUAL o BUSINESS. Enum: "INDIVIDUAL", "BUSINESS" - `open_finance_display_confirmation_required.beneficiary_bank_account.holder.information` (any, required) — one of: - NEGOCIOS: - `name` (string, required) El nombre de pila del titular de la cuenta bancaria. Example: "Gustavo Veloso Entertainment Universe" - `identifier_type` (string, required) El tipo de documento de identificación del cliente. Para las empresas en Brasil, esto debe establecerse en CNPJ. Enum: same as `beneficiary_bank_account.holder.information.identifier_type` in "NEGOCIOS" (1 values) - `identifier` (string, required) El número de documento CNPJ. Example: 191 - INDIVIDUAL: - `first_name` (string, required) El nombre de pila del titular de la cuenta bancaria. Example: "Dom" - `last_name` (string, required) El apellido del titular de la cuenta bancaria. Example: "Mesa" - `identifier_type` (string, required) El tipo de documento de identificación del cliente. Para individuos en Brasil, esto debe establecerse en CPF. Enum: same as `beneficiary_bank_account.holder.information.identifier_type` in "INDIVIDUAL" (1 values) - `identifier` (string, required) El número de documento de la identificación del cliente. Example: 191 - `open_finance_display_confirmation_required.payer_name` (string) El nombre del pagador. Example: "Gustavo Veloso" - `open_finance_display_confirmation_required.payer_identifier` (string) El ID del pagador. Example: "LV890273900-23" - `open_finance_display_confirmation_required.payer_institution` (object) - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. Example: true - OFPI - Procesamiento de Pagos: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_payment_processing` (object) Detalles sobre la institución pagadora. - `open_finance_display_payment_processing.payer_institution` (object) - `open_finance_display_payment_processing.payer_institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_processing.payer_institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_payment_processing.payer_institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_payment_processing.payer_institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_payment_processing.payer_institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_processing.payer_institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_payment_processing.payer_institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_processing.payer_institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_processing.payer_institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_processing.payer_institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_payment_processing.payer_institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_payment_processing.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_payment_processing.payer_institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_payment_processing.payer_institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. - OFPI - Pago Exitoso: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_payment_succeeded` (object) Detalles sobre la institución pagadora. - `open_finance_display_payment_succeeded.payer_institution` (object) - `open_finance_display_payment_succeeded.payer_institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_succeeded.payer_institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_payment_succeeded.payer_institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_payment_succeeded.payer_institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_payment_succeeded.payer_institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_succeeded.payer_institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_payment_succeeded.payer_institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_payment_succeeded.payer_institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_payment_succeeded.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_payment_succeeded.payer_institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_payment_succeeded.payer_institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. - OFPI - Pago fallido: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_payment_failed` (object) Detalles sobre la institución pagadora. - `open_finance_display_payment_failed.payer_institution` (object) - `open_finance_display_payment_failed.payer_institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_failed.payer_institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_payment_failed.payer_institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_payment_failed.payer_institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_payment_failed.payer_institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_failed.payer_institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_payment_failed.payer_institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_failed.payer_institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_failed.payer_institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_failed.payer_institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_payment_failed.payer_institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_payment_failed.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_payment_failed.payer_institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_payment_failed.payer_institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. - Cuenta Bancaria: - `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: same as `status` in "Clave Pix" (5 values) - `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: same as `currency` in "Clave Pix" (1 values) - `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: same as `allowed_payment_method_types` in "Pix Keys (Con Cliente Existente)" (2 values) - `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) — one of: Detalles sobre el método de pago OFPI. - INDIVIDUAL: - `open_finance` (object, required) Tipo de método de pago seleccionado. - `open_finance.beneficiary_bank_account` (string, required) El ID único de Belvo utilizado para identificar la cuenta bancaria del beneficiario. Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc" - `open_finance.payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `open_finance.callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `open_finance.cpf` (string,null) El número de CPF del cliente. Se proporciona cuando está disponible; este valor está ofuscado en las respuestas. Example: "23******00" - NEGOCIOS: - `open_finance` (object, required) Tipo de método de pago seleccionado. - `open_finance.beneficiary_bank_account` (string, required) El ID único de Belvo utilizado para identificar la cuenta bancaria del beneficiario. Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc" - `open_finance.payer_institution` (string, required) ID único de Belvo para referenciar la institución del pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `open_finance.callback_url` (string, required) La URL de callback a la que se redirigirá a su usuario después de confirmar el pago en su aplicación bancaria. Example: "https://www.acmecorp.com/checkout/3487321" - `open_finance.cpf` (string,null, required) El número de CPF del cliente. Se proporciona cuando está disponible; este valor está ofuscado en las respuestas. Example: "23******00" - `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: same as `charges.status` in "Clave Pix" (6 values) - `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: same as `currency` in "Clave Pix" (1 values) - `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: same as `charges.payment_method_type` in "Clave Pix" (1 values) - `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) — 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `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.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: same as `currency` in "Clave Pix" (1 values) - `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: same as `provider` in "Pix Keys (Con Cliente Existente)" (1 values) - `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: same as `provider` in "Pix Keys (Con Cliente Existente)" (1 values) - `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. - `error_code` (string, required) Un código de error único (payment_error) que te permite clasificar y manejar el error de manera programática. Example: "payment_error" - `error_message` (string, required) Una breve descripción del error. Example: "Unexpected error to confirm the payment" - `next_step` (any, required) — one of: 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. - OFPI - Mostrar información del método de pago: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_payment_method_information` (object) Objeto que detalla qué información del método de pago necesitas mostrar. - `open_finance_display_payment_method_information.institutions` (array) Un array de objetos de institución. - `open_finance_display_payment_method_information.institutions.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_method_information.institutions.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_payment_method_information.institutions.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_payment_method_information.institutions.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_payment_method_information.institutions.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_method_information.institutions.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_payment_method_information.institutions.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_method_information.institutions.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_method_information.institutions.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_method_information.institutions.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_payment_method_information.institutions.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_payment_method_information.institutions.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_payment_method_information.institutions.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_payment_method_information.institutions.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. - OFPI - Necesita redirección: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_needs_redirect` (object) Detalles sobre la institución pagadora. - `open_finance_display_needs_redirect.payer_institution` (object) - `open_finance_display_needs_redirect.payer_institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_needs_redirect.payer_institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_needs_redirect.payer_institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_needs_redirect.payer_institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_needs_redirect.payer_institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_needs_redirect.payer_institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_needs_redirect.payer_institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_needs_redirect.payer_institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_needs_redirect.payer_institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_needs_redirect.payer_institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_needs_redirect.payer_institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_needs_redirect.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_needs_redirect.payer_institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_needs_redirect.payer_institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. - OFPI - Se requiere confirmación de visualización: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_confirmation_required` (object) Objeto que detalla los próximos pasos que debes seguir para un tipo específico de next_step. - `open_finance_display_confirmation_required.beneficiary_bank_account` (object) - `open_finance_display_confirmation_required.beneficiary_bank_account.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_confirmation_required.beneficiary_bank_account.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" - `open_finance_display_confirmation_required.beneficiary_bank_account.created_by` (string, required) El ID único para el usuario que creó este elemento. Example: "bcef7f35-67f2-4b19-b009-cb38795faf09" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution` (object, required) - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `open_finance_display_confirmation_required.beneficiary_bank_account.details` (any) — one of: - OFPI (Información de Cuenta PIX): - `country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `account_type` (string, required) El tipo de cuenta bancaria. Puede ser: - CHECKINGS (también conocida como Conta Corrente en Brasil) - SAVINGS (también conocida como Conta Poupança en Brasil) - SALARY (también conocida como Conta Salário en Brasil) - PAYMENTS (también conocida como Conta de Pagamento Instantâneo o Conta de Pagamento en Brasil) Enum: same as `beneficiary_bank_account.details.account_type` in "INDIVIDUAL" (4 values) - `agency` (string, required) La agencia (número de sucursal) de la institución donde se creó la cuenta. Example: "0444" - `number` (string, required) El número de cuenta bancaria. Example: "45722-0" - OFPI (PIX Keys): - `country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `pix_key` (string, required) El identificador de clave PIX de la cuenta bancaria. Example: "RANDOM://6c1c236c-a035-4b80-ab12-e38f88ce82ab" - `open_finance_display_confirmation_required.beneficiary_bank_account.holder` (object, required) Detalles sobre el titular de la cuenta bancaria. - `open_finance_display_confirmation_required.beneficiary_bank_account.holder.type` (string, required) El tipo de cuenta bancaria. Puede ser INDIVIDUAL o BUSINESS. Enum: same as `open_finance_display_confirmation_required.beneficiary_bank_account.holder.type` in "OFPI - Se requiere confirmación de visualización" (2 values) - `open_finance_display_confirmation_required.beneficiary_bank_account.holder.information` (any, required) — one of: - NEGOCIOS: - `name` (string, required) El nombre de pila del titular de la cuenta bancaria. Example: "Gustavo Veloso Entertainment Universe" - `identifier_type` (string, required) El tipo de documento de identificación del cliente. Para las empresas en Brasil, esto debe establecerse en CNPJ. Enum: same as `beneficiary_bank_account.holder.information.identifier_type` in "NEGOCIOS" (1 values) - `identifier` (string, required) El número de documento CNPJ. Example: 191 - INDIVIDUAL: - `first_name` (string, required) El nombre de pila del titular de la cuenta bancaria. Example: "Dom" - `last_name` (string, required) El apellido del titular de la cuenta bancaria. Example: "Mesa" - `identifier_type` (string, required) El tipo de documento de identificación del cliente. Para individuos en Brasil, esto debe establecerse en CPF. Enum: same as `beneficiary_bank_account.holder.information.identifier_type` in "INDIVIDUAL" (1 values) - `identifier` (string, required) El número de documento de la identificación del cliente. Example: 191 - `open_finance_display_confirmation_required.payer_name` (string) El nombre del pagador. Example: "Gustavo Veloso" - `open_finance_display_confirmation_required.payer_identifier` (string) El ID del pagador. Example: "LV890273900-23" - `open_finance_display_confirmation_required.payer_institution` (object) - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. Example: true - OFPI - Procesamiento de Pagos: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_payment_processing` (object) Detalles sobre la institución pagadora. - `open_finance_display_payment_processing.payer_institution` (object) - `open_finance_display_payment_processing.payer_institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_processing.payer_institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_payment_processing.payer_institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_payment_processing.payer_institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_payment_processing.payer_institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_processing.payer_institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_payment_processing.payer_institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_processing.payer_institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_processing.payer_institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_processing.payer_institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_payment_processing.payer_institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_payment_processing.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_payment_processing.payer_institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_payment_processing.payer_institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. - OFPI - Pago Exitoso: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_payment_succeeded` (object) Detalles sobre la institución pagadora. - `open_finance_display_payment_succeeded.payer_institution` (object) - `open_finance_display_payment_succeeded.payer_institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_succeeded.payer_institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_payment_succeeded.payer_institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_payment_succeeded.payer_institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_payment_succeeded.payer_institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_succeeded.payer_institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_payment_succeeded.payer_institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_payment_succeeded.payer_institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_payment_succeeded.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_payment_succeeded.payer_institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_payment_succeeded.payer_institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. - OFPI - Pago fallido: - `type` (string) El tipo de next_step que necesitas seguir. Enum: same as `type` in "OFPI - Mostrar información del método de pago" (6 values) - `open_finance_display_payment_failed` (object) Detalles sobre la institución pagadora. - `open_finance_display_payment_failed.payer_institution` (object) - `open_finance_display_payment_failed.payer_institution.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_failed.payer_institution.active` (boolean, required) Indica si esta institución está disponible para su uso o no. Example: true - `open_finance_display_payment_failed.payer_institution.name` (string, required) El nombre de la institución, según lo designado por Belvo. Example: "wakanda_national" - `open_finance_display_payment_failed.payer_institution.display_name` (string, required) El nombre de cara al cliente de la institución. Example: "Wakanda National Bank" - `open_finance_display_payment_failed.payer_institution.legal_entity_name` (string,null, required) El nombre de la entidad legal de la institución, tal como está registrado ante la autoridad reguladora correspondiente. Solo aplicable para 🇧🇷 Brasil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_failed.payer_institution.website` (string, required) La URL del sitio web de la institución. Example: "https://www.wakandanational.com" - `open_finance_display_payment_failed.payer_institution.logo` (string, required) La URL del logotipo de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_failed.payer_institution.icon_logo` (string, required) La URL del logotipo del icono de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_failed.payer_institution.text_logo` (string, required) La URL del logotipo de texto de la institución. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_failed.payer_institution.primary_color` (string, required) El color primario en el sitio web de la institución. Example: "#fdbc24" - `open_finance_display_payment_failed.payer_institution.country` (string,null, required) El país de residencia del cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Mostrar información del método de pago" (2 values) - `open_finance_display_payment_failed.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `label` (string) La etiqueta del campo del formulario. Por ejemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica si este parámetro depende o no de que se proporcione otro parámetro. Por ejemplo, si este campo dependency = username_type, esto significa que también debes enviar el parámetro username_type. Example: "username_type" - `validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid client number" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos cuando el tipo es token. Example: 6 - `optional` (boolean) Indica si este campo de formulario es opcional. - InstitutionFormFieldUsernameType: - `name` (string) El campo de nombre de usuario, contraseña o tipo de nombre de usuario. Example: "username" - `type` (string) El tipo de entrada para el campo del formulario. Por ejemplo, string. Example: "text" - `placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "Username" - `values` (array) Matriz de valores adicionales de campos de formulario. - `values.code` (string) El código del documento. Example: "001" - `values.label` (string) La etiqueta para el campo. Por ejemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) El tipo de validación de entrada utilizada para el campo. Example: "^.{1,}$" - `values.validation_message` (string) El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario. Example: "Invalid document number" - `values.placeholder` (string) El texto del marcador de posición en el campo del formulario. Example: "DEF4444908M22" - `preselected` (integer) Indique qué opción del array username_types se preselecciona automáticamente para el usuario. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Si el usuario desea o no guardar las credenciales para esta institución para pagos futuros. Example: "save_credentials" - `type` (string) El tipo de entrada para el campo del formulario. Para save_credentials, esto se establece en checkbox. Example: "checkbox" - `label` (string) La etiqueta del campo del formulario. Para save_credentials, esto se establece en Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) El tipo de validación de entrada utilizada para el campo. Para save_credentials, esto es null. - `open_finance_display_payment_failed.payer_institution.sort_priority` (integer, required) Número que representa el orden en el que la institución debe mostrarse en una aplicación, siendo 1 el más alto. Example: 1 - `open_finance_display_payment_failed.payer_institution.description` (string,null, required) Una breve descripción de la institución. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica si la intención de pago está lista para ser confirmada. Nota: Cuando se establece en true, necesitas confirmar el pago haciendo una solicitud PATCH enviando confirm: true. ## Response 400 fields (application/json): - `code` (string, required) Un código de error único (null, does_not_exist, required, already_registered, invalid_choice, max_length, min_length, blank, null, cancellation_error, idempotency_key_invalid) que te permite clasificar y manejar el error de manera programática. Example: "required" - `message` (string, required) Una breve descripción del error. La descripción puede ser (entre otras): - Este campo es obligatorio. - El objeto con nombre=narnia no existe. - Este campo no puede ser nulo. - Este campo no puede estar en blanco. - Este cliente ya está registrado. - Asegúrese de que este campo tenga al menos 2 caracteres. - Asegúrese de que este campo no tenga más de 4 caracteres. - El valor ingresado no es válido. - Debe establecer todos los campos obligatorios: username, password, username_type. - Payment Intent no puede ser cancelado porque no está SCHEDULED. - Payment Intent no puede ser cancelado ya que el tiempo límite (23:59:00) ha pasado. - La clave de idempotencia proporcionada no es válida. Example: "This field is required." - `request_id` (string, required) 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" - `field` (string,null) Nombre del campo donde se encontró el error. > Nota: Este campo solo está presente cuando el error está relacionado con un campo específico. Example: "institution" ## 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 409 fields (application/json): - `code` (string, required) Un código de error único (idempotency_key_conflict) que te permite clasificar y manejar el error de manera programática. Example: "idempotency_key_conflict" - `message` (string, required) Una breve descripción del error. Para los errores de idempotency_key_conflict, la descripción es: - Una solicitud con esta idempotency key ya está siendo procesada. Example: "A request with this idempotency key is already being processed." - `request_id` (string, required) 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 422 fields (application/json): - `code` (string, required) Un código de error único (idempotency_payload_mismatch) que te permite clasificar y manejar el error de manera programática. Example: "idempotency_payload_mismatch" - `message` (string, required) Una breve descripción del error. Para los errores idempotency_payload_mismatch, la descripción es: - Ya existe una solicitud diferente con la misma clave de idempotencia. Example: "A different request with the same idempotency key already exists." - `request_id` (string, required) 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"