Un objeto FinancialAccount representa la cuenta de crédito de un cliente dentro de un programa.
El objeto FinancialAccount
FinancialAccountAtributos
id string
Identificador único del objeto.
object string
Indica el tipo de objeto. Valor siempre será financial_account.
status enum
El estado del objeto.
| Posibles valores | Descripción |
|---|---|
active | La cuenta opera normalmente. |
frozen | La cuenta está congelada; no admite nuevos débitos. |
closed | La cuenta está cerrada (estado final). Requiere balance y fondos reservados en cero. |
customer_id string
ID objeto Customer titular de la cuenta.
program_id string
ID objeto Program al que pertenece la cuenta.
currency string
Código de moneda ISO de tres letras, heredado del programa.
credit_limit integer
Límite de crédito de la cuenta, en la unidad monetaria más pequeña.
posted_balance integer
Balance contable de la cuenta, en la unidad monetaria más pequeña. Es negativo cuando hay deuda: las compras (débitos) lo llevan hacia lo negativo y los pagos o reembolsos (créditos) lo acercan a cero.
held_amount integer
Fondos reservados por autorizaciones en curso, en la unidad monetaria más pequeña. Siempre es mayor o igual a 0.
available integer
Crédito disponible, en la unidad monetaria más pequeña. Se calcula como credit_limit + posted_balance − held_amount.
repayment_checkout_id string
ID objeto Checkout de prepago activo, si existe.
metadata object
Conjunto de pares llave-valor que puedes asociar a un objeto.
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.