Brasil - AV (v2)

Cobertura del 100% de las cuentas conectadas vía PIX.

Parámetros de entrada

FormatoInputs
IBAN
  • country_code = "BR" (requerido)
  • account_identifier = Número de IBAN (requerido)
  • owner_id = Número de CPF/CNPJ asociado a la cuenta (requerido) (**)
  • owner_name = Nombre asociado a la cuenta (opcional para match_verdict) (**)
  • account_currency = Moneda de la cuenta (opcional para match_verdict)
(**) Debes enviar al menos owner_id u owner_name para que el motor pueda realizar la verificación de titularidad, siendo preferible owner_id para garantizar una mayor tasa de efectividad de validaciones.
Local
  • country_code = "BR" (requerido)
  • account_identifier = Número de cuenta en formato local (requerido)
  • branch_code = Número de sucursal bancaria de la cuenta (requerido)
  • bank_code o swift_code = Código de la institución bancaria (requerido)
  • account_type = Tipo de cuenta (CACC, SVGS, CASH, OTHR o TRAN) (requerido) (*)
  • owner_id = Número de CPF/CNPJ asociado a la cuenta (requerido) (**)
  • owner_name = Nombre asociado a la cuenta (opcional para match_verdict) (**)
  • account_currency = Moneda de la cuenta (opcional para match_verdict)
(*) Siendo CACC = Cuenta Corriente, SVGS = Cuenta Ahorro, CASH = Cuenta Pagos, TRAN = Cuenta Fácil, OTHR = Cuenta Entidad Pública.
(**) Debes enviar al menos owner_id u owner_name para que el motor pueda realizar la verificación de titularidad, siendo preferible owner_id para garantizar una mayor tasa de efectividad de validaciones.
Llave pix
  • country_code = "BR" (requerido)
  • account_identifier = Llave pix de la cuenta (requerido)
  • account_identifier_type = "PIX_KEY" (requerido)
  • owner_name = Nombre asociado a la cuenta (opcional para match_verdict)
  • owner_id = Documento asociado a la cuenta (opcional para match_verdict)
  • account_currency = Moneda de la cuenta (opcional para match_verdict)

Para ver más detalles visita la sección de referencia: Referencia de la API

En Brasil se encuentra disponible únicamente para cuentas en moneda local.


Contenido de la respuesta

ServicioInformación
account_validation
  • Existencia de la cuenta
  • Estado operativo de la cuenta
  • Particularidades asociadas al estado de la cuenta
account_owner_name
  • Nombre asociado a la cuenta
  • Grado de coincidencia (match) con el input ingresado
account_owner_id
  • Número y tipo de documento asociado a la cuenta

  • Grado de coincidencia (match) con el input ingresado

account_currency
  • Moneda asociada a la cuenta

  • Grado de coincidencia (match) con el input ingresado

account_details
  • Número de cuenta en sus diferentes formatos
  • Tipo de cuenta
  • Número de sucursal bancaria de la cuenta
  • Detalles sobre el banco de la cuenta
⚠️

Esta suele ser la respuesta general de la API para este país. Puede haber ocasiones en las que el banco destinatario no proporcione toda la información listada anteriormente. En ese caso, el campo será devuelto en blanco.


Códigos y subcódigos de respuestas para BR

HTTP codeSub-codeDescripción
200BR000"Cuenta reportada como activa"
200BR002"Cuenta identificada, con posibles limitaciones para recibir transferencias"
200BR007"No hay coincidencia para los datos proporcionados"
200BR010"No hay coincidencia para la llave proporcionada"
200BR015"Cuenta reportada como bloqueada"
200BR018"Sucursal reportada como inválida"
422BR040"El número de documento proporcionado no cumple con el formato requerido. Debe contener solo dígitos"
422BR041"El número de documento proporcionado no cumple con la longitud requerida para un documento válido"
422BR049"El número de documento proporcionado no supera el algoritmo de validación de CPF"
422BR050"El número de documento proporcionado no supera el algoritmo de validación de CNPJ"
422BR051"El número de sucursal proporcionado no cumple con el formato requerido. Debe contener solo dígitos o la letra X"
422BR052"El número de cuenta proporcionado no cumple con el formato requerido. Debe contener solo dígitos o la letra X"
422BR053"El valor proporcionado no corresponde a un formato válido. El IBAN debe tener 29 caracteres"
422BR054"El número de cuenta proporcionado no supera el algoritmo de validación de IBAN"
422BR055"El valor proporcionado no corresponde a un formato válido. La llave PIX debe ser un CPF, CNPJ, teléfono, email o una clave aleatoria de 32 dígitos"
422BR056"El número de documento proporcionado no cumple con el formato requerido. Debe contener solo dígitos o letras"
400BR999"El banco consultado no existe o no está soportado"

Códigos y subcódigos de respuestas generales

HTTP codeSub-codeDescripción
200XX000"Información no disponible"
202XX202"Validación pendiente"
400XX400"Parámetro faltante: XXXX"
400XX400"Parámetro inválido: XXXX"
401XX401"API key faltante"
401XX401"API key inválida"
403XX403"La funcionalidad solicitada (XXX) no está habilitada para esta API key"
403XX403"El servicio solicitado (XXX) no está habilitado para esta API key"
403XX403"El país solicitado (XX) no está habilitado para esta API key"
403XX403"Validación no permitida para este identificador"
500XX500"Error interno"
503XX503"Error de comunicación"

Datos mock para pruebas en Sandbox

CasoDatos
Cuenta válida (IBAN)"country_code": "BR"
"account_identifier": "BR7299999999010100000001001C1"
"owner_id": "58.547.642/0001-95"

"owner_name": "João da Silva"
"account_currency": "BRL"
Cuenta con posibles limitaciones (IBAN)"country_code": "BR"
"account_identifier": "BR7299999999010100000001098C1"
"owner_id": "58.547.642/0001-95"
Cuenta bloqueada (IBAN)"country_code": "BR"
"account_identifier": "BR7299999999010100000001195C1"
"owner_id": "58.547.642/0001-95"
Cuenta activa (Local)"country_code": "BR"
"account_identifier": "1001"
"bank_code": "999" o "swift_code": "PROMBR99XXX" "branch_code": "00001"
"owner_id": "58.547.642/0001-95"

"owner_name": "João da Silva"
"account_currency": "BRL"
Cuenta activa (Llave pix)"country_code": "BR"
"account_identifier": "[email protected]"
"account_identifier_type": "PIX_KEY_TEST"

"owner_name": "João da Silva"
"owner_id": "58.547.642/0001-95"
"account_currency": "BRL"
Cuenta sin coincidencia (Llave pix)"country_code": "BR"
"account_identifier": "[email protected]"
"account_identifier_type": "PIX_KEY_TEST"