Docs · Referencia

Cuentas

Las cuentas del negocio y sus saldos. Los números se ocultan salvo los últimos 4 dígitos.

Listar las cuentas del negocio al que está vinculada tu clave

GET/v1/accounts

Hoy hay una cuenta corriente por negocio; la respuesta es una lista para que pueda crecer. Los números de cuenta y de ruta se ocultan salvo los últimos 4 dígitos. Los saldos llevan signo: un saldo negativo significa que la cuenta está en sobregiro. Los saldos pueden tener un retraso de duración desconocida, y todavía no se devuelve una hora as_of. Si una parte de la respuesta no se puede cargar, recibes un 503 con Retry-After, nunca un 200 parcial.

Autenticación

Token bearer cuyo cliente tiene el scope accounts:read

Respuesta · una lista de Account

dataarray of Account

La página de resultados

Cada elemento de data:

idstringobligatorio

El id de la cuenta

namestring

Nombre de la cuenta, oculto

typestringobligatorio

Tipo de cuenta

statusstringobligatorio

Estado de la cuenta

account_number_last4stringobligatorio

Últimos 4 dígitos del número de cuenta

4 caracteres

routing_number_last4stringobligatorio

Últimos 4 dígitos del número de ruta

4 caracteres

freeze_typestring

Presente cuando la cuenta tiene restricciones. Se omite en los demás casos

Uno de FULL_FREEZEWITHDRAWAL_FREEZE

balanceobjectobligatorio

Los saldos de la cuenta

balance.availableSignedMoneyobligatorio

Saldo disponible

balance.available.amountstringobligatorio

Cadena decimal con dos decimales. Negativa cuando la cuenta está en sobregiro

patrón ^-?[0-9]+\.[0-9]{2}$

balance.available.currencystringobligatorio

Siempre USD

Uno de USD

balance.currentSignedMoneyobligatorio

Saldo actual

balance.current.amountstringobligatorio

Cadena decimal con dos decimales. Negativa cuando la cuenta está en sobregiro

patrón ^-?[0-9]+\.[0-9]{2}$

balance.current.currencystringobligatorio

Siempre USD

Uno de USD

balance.spendableSignedMoneyobligatorio

Saldo disponible menos los fondos reservados

balance.spendable.amountstringobligatorio

Cadena decimal con dos decimales. Negativa cuando la cuenta está en sobregiro

patrón ^-?[0-9]+\.[0-9]{2}$

balance.spendable.currencystringobligatorio

Siempre USD

Uno de USD

balance.as_ofstring

Hora del último cambio de saldo. Todavía no se devuelve

date-time

opened_atstring

Fecha de apertura de la cuenta

date

Respuestas

200OK
401Falta el token, venció o es desconocido, o el cliente se revocó o se desactivó
403Al cliente le falta el scope, la situación del titular cambió o la API no está habilitada para este negocio
429Demasiadas solicitudes. Espera lo que indique Retry-After
500Algo falló de forma inesperada del lado de Novo. No se puede reintentar: menciona request_id a soporte
503Algo de lo que depende la respuesta no está disponible. Reintenta después de Retry-After

Solicitud

curl "https://$NOVO_API_HOST/v1/accounts" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Respuesta · 200

{
  "data": [
    {
      "id": "acct_example_01",
      "name": "xxxxxx1234",
      "type": "EXAMPLE_TYPE",
      "status": "EXAMPLE_STATUS",
      "account_number_last4": "1234",
      "routing_number_last4": "5678",
      "balance": {
        "available": {
          "amount": "1250.00",
          "currency": "USD"
        },
        "current": {
          "amount": "1300.00",
          "currency": "USD"
        },
        "spendable": {
          "amount": "1150.00",
          "currency": "USD"
        }
      },
      "opened_at": "2024-03-14"
    }
  ]
}

Obtener una cuenta

GET/v1/accounts/{account_id}

El mismo objeto de cuenta que en la lista.

Autenticación

Token bearer cuyo cliente tiene el scope accounts:read

Parámetros

account_idpath · stringobligatorio

El id de la cuenta

Respuesta · Account

idstringobligatorio

El id de la cuenta

namestring

Nombre de la cuenta, oculto

typestringobligatorio

Tipo de cuenta

statusstringobligatorio

Estado de la cuenta

account_number_last4stringobligatorio

Últimos 4 dígitos del número de cuenta

4 caracteres

routing_number_last4stringobligatorio

Últimos 4 dígitos del número de ruta

4 caracteres

freeze_typestring

Presente cuando la cuenta tiene restricciones. Se omite en los demás casos

Uno de FULL_FREEZEWITHDRAWAL_FREEZE

balanceobjectobligatorio

Los saldos de la cuenta

balance.availableSignedMoneyobligatorio

Saldo disponible

balance.available.amountstringobligatorio

Cadena decimal con dos decimales. Negativa cuando la cuenta está en sobregiro

patrón ^-?[0-9]+\.[0-9]{2}$

balance.available.currencystringobligatorio

Siempre USD

Uno de USD

balance.currentSignedMoneyobligatorio

Saldo actual

balance.current.amountstringobligatorio

Cadena decimal con dos decimales. Negativa cuando la cuenta está en sobregiro

patrón ^-?[0-9]+\.[0-9]{2}$

balance.current.currencystringobligatorio

Siempre USD

Uno de USD

balance.spendableSignedMoneyobligatorio

Saldo disponible menos los fondos reservados

balance.spendable.amountstringobligatorio

Cadena decimal con dos decimales. Negativa cuando la cuenta está en sobregiro

patrón ^-?[0-9]+\.[0-9]{2}$

balance.spendable.currencystringobligatorio

Siempre USD

Uno de USD

balance.as_ofstring

Hora del último cambio de saldo. Todavía no se devuelve

date-time

opened_atstring

Fecha de apertura de la cuenta

date

Respuestas

200OK
401Falta el token, venció o es desconocido, o el cliente se revocó o se desactivó
403Al cliente le falta el scope, la situación del titular cambió o la API no está habilitada para este negocio
404No hay nada con ese id en el negocio vinculado
429Demasiadas solicitudes. Espera lo que indique Retry-After
500Algo falló de forma inesperada del lado de Novo. No se puede reintentar: menciona request_id a soporte
503Algo de lo que depende la respuesta no está disponible. Reintenta después de Retry-After

Solicitud

curl "https://$NOVO_API_HOST/v1/accounts/acct_example_01" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Respuesta · 200

{
  "id": "acct_example_01",
  "name": "xxxxxx1234",
  "type": "EXAMPLE_TYPE",
  "status": "EXAMPLE_STATUS",
  "account_number_last4": "1234",
  "routing_number_last4": "5678",
  "balance": {
    "available": {
      "amount": "1250.00",
      "currency": "USD"
    },
    "current": {
      "amount": "1300.00",
      "currency": "USD"
    },
    "spendable": {
      "amount": "1150.00",
      "currency": "USD"
    }
  },
  "opened_at": "2024-03-14"
}

Previsto para cuentas

Cambiar los datos de la cuenta

Todavía no está disponible, y no se publica ningún endpoint para esto. Aparecerán aquí cuando el contrato los defina. Todo lo marcado como “requiere tu aprobación” espera a que el titular de la cuenta lo apruebe en su teléfono, cada vez. Dinos qué necesitas primero cuando pidas tu lugar.