Un objeto Loan representa un financiamiento en cuotas (BNPL) otorgado a un cliente.
El objeto Loan
LoanAtributos
id string
Identificador único del objeto.
object string
Indica el tipo de objeto. Valor siempre será loan.
status enum
El estado del objeto.
| Posibles valores | Descripción |
|---|---|
open | Estado inicial. Creado, sin aprobar ni rechazar. |
succeeded | El préstamo fue aprobado. |
failed | No fue posible aprobar el préstamo. |
canceled | El préstamo fue cancelado. |
status_reason string
Motivo del estado actual.
amount integer
Un número entero positivo que representa el monto financiado (capital), en la unidad monetaria más pequeña (por ejemplo, 100 para CLP $100).
currency string
Código de moneda ISO de tres letras.
interest_amount integer
Interés total del préstamo, en la unidad monetaria más pequeña.
interest_rate number
Tasa de interés expresada como porcentaje (0-100).
approved_at datetime
Fecha de aprobación en formato ISO 8601. En huso horario UTC.
authorized boolean
Indica si el préstamo (primer cargo) fue autorizado.
authorized_at datetime
Fecha de autorización en formato ISO 8601. En huso horario UTC.
available_for_refund integer
Monto disponible para reembolsar (amount menos refunded_amount), en la unidad monetaria más pequeña.
refunded boolean
Indica si el préstamo fue reembolsado total o parcialmente.
refunded_amount integer
Monto reembolsado, en la unidad monetaria más pequeña.
refunded_at datetime
Fecha del último reembolso en formato ISO 8601. En huso horario UTC.
surcharge_amount integer
Recargo cobrado al cliente, en la unidad monetaria más pequeña.
surcharge_tax integer
Impuesto sobre el recargo, en la unidad monetaria más pequeña.
installment_program string
Programa de financiamiento seleccionado.
installments_plan object
Detalle del plan de cuotas (cantidad, intervalo y calendario de pago).
payment_day_anchor integer
Día de pago re-anclado de las cuotas.
| Posibles valores |
|---|
5 |
15 |
30 |
payment_day_deferred_at datetime
Fecha en que el cliente difirió el día de pago (permitido una sola vez) en formato ISO 8601. En huso horario UTC.
acquirer string
Adquirente o pasarela asociada.
customer_id string
ID objeto Customer relacionado.
customer object expandible
Objeto Customer relacionado.
checkout_id string
ID objeto Checkout que originó el préstamo.
installments array of objects expandible
Listado de cuotas (Installment) del préstamo.
session_email string
Email entregado por el cliente en la sesión.
session_taxid string
Identificador tributario entregado en la sesión.
disputed boolean
Indica si el préstamo está en disputa.
disputed_at datetime
Fecha en que se inició la disputa en formato ISO 8601. En huso horario UTC.
description string
Un texto arbitrario asociado al objeto.
success_url string
Una URL a la cual el cliente será redirigido si la autorización del cargo es exitosa.
success_url_method enum
El método HTTP a utilizar al redirigir al cliente si la autorización del cargo es exitosa.
| Posibles valores |
|---|
post default |
get |
cancel_url string
Una URL a la cual el cliente será redirigido si la autorización del cargo falla o es cancelada por el cliente.
cancel_url_method enum
El método HTTP a utilizar al redirigir al cliente en caso de una autorización fallida.
| Posibles valores |
|---|
post default |
get |
url string
URL de la página alojada del préstamo.
live boolean
Indica si el objeto existe en modo live o modo test.
created_at datetime
Fecha de creación del objeto en formato ISO 8601. En huso horario UTC.
updated_at datetime
Fecha de actualización del objeto en formato ISO 8601. En huso horario UTC.