Documentación Técnica - BNB API’s Market

Banco Nacional de Bolivia S.A.

©2019 Banco Nacional de Bolivia S.A.

 BNB API’S MARKET

1. Introducción.

El Banco Nacional de Bolivia a partir de sus iniciativas de innovación, desarrolló una

continua evolución por la introducción de nuevos modelos de negocio disruptivos.
Es por este motivo que la institución inicialmente emprendió el proyecto de API
empresarial abierto, con el objetivo de mejorar la relación comercial con las
personas jurídicas de la región.

El BNB API’s Market es una plataforma abierta orientada a mejorar las jornadas
bancarias de nuestros clientes, esto genera una mejor experiencia de nuestros
clientes, ayudándoles a tomar mejores decisiones, a través de la mejora en la oferta
de servicios y la seguridad de los clientes, generando una experiencia de usuario
sin fricciones, optimizada, personalizada y en tiempo real.

2. Funcionalidades ofrecidas.
El BNB API’s Market es una plataforma global y abierta del Banco Nacional de
Bolivia, que ofrece un catálogo de productos con API’s disponibles que te permite
acceder a soluciones financieras de manera ágil e implementarlas fácilmente en las
empresas de nuestros clientes.

Nuestros clientes pueden desarrollar nuevas líneas de negocio, a partir de nuevos

servicios y mejorar la experiencia de sus usuarios mediante las siguientes API’s
ofrecidas por el Banco Nacional de Bolivia:

API’s para Empresas:

 Transferencias: ofrece el servicio de realización de transferencias

 Consulta de Saldos: ofrece el servicio de realización de consulta de saldos
 Extractos: ofrece el servicio de realización de consulta de extractos
 Boletas de garantía: Permite a nuestros clientes registrar Boletas de
Garantía.
 Giros enviados al exterior: Permite a nuestros clientes realizar Giros.
 Cobro/Pagos Simple: Permite a nuestros clientes realizar Transferencias
mediante Simple.

API’s para Personas Naturales:

 Transferencias: ofrece el servicio de realización de transferencias

 Consulta de Saldos: ofrece el servicio de realización de consulta de saldos
 Extractos: Permite a nuestros clientes ofrecer el servicio de consulta de
extractos bancarios a usuarios pre autorizados.

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 1 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

3. Niveles de acceso en BNB API’s Market.

Los clientes pueden acceder a las API’s abiertas del Banco Nacional de Bolivia en
distintos niveles de acceso, los cuales le permitirán tomar mejores decisiones y
enfocar sus productos en nuevas líneas de negocio, ajustado a sus diferentes
necesidades:

 SANDBOX: Consola que permite a los clientes familiarizarse con una API en
un ambiente de prueba por un tiempo ilimitado.

 PRODUCCIÓN: El cliente puede acceder a un ambiente de producción, una

vez que ha evaluado su modelo de negocio y ha firmado contrato con el
Banco.

4. Servicios API.

Ruta del servicio Azure: http://bnbapideveloper.azurewebsites.net/

I. Servicio: “Transferencia”
Nombre del servicio: Transfer

 Diccionario de datos:

Campo Descripción
userKey Clave de usuario
sourceAccountNumber Número de cuenta de origen
destinationAccountNumber Número de cuenta del destinatario
currency Moneda
ammount Monto
reference Referencia
success Resultado
messasge Mensaje
ResponseCode code Código de respuesta

 Estructuras

public class Transfer

{
public class Request
{
// Clave de usuario
public string userKey { get; set; }
// Número de cuenta de origen

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 2 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

public long sourceAccountNumber { get; set; }

// Número de cuenta del destinatario
public long destinationAccountNumber { get; set; }
// Moneda
public int currency { get; set; }
// Monto
public int ammount { get; set; }
// Referencia
public string reference { get; set; }
}
public class Response
{
// Resultado
public bool success { get; set; }
// Mensaje
public string messasge { get; set; }
// Código de respuesta
public ResponseCode code { get; set; }
}
}

 Ejemplo de envío

Ruta: http://bnbapideveloper.azurewebsites.net/api/Enterprise/Transfer
Json:
{
"userKey":"e8k7crKA9S0:APA91bGDZ76NccQkYXIzS5",
"sourceAccountNumber":"1501243627",
"destinationAccountNumber":"1500842918",
"currency":"1",
"ammount":"10",
"reference":"TEST"
}

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 3 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

II. Servicio: “Extracto de últimos 10 movimientos”

Nombre del servicio: BankStatement

 Diccionario de datos:

Campo Descripción
userKey Clave de usuario
accountNumber Número de cuenta
accountType Tipo de cuenta
List<BankingMovements> movements Lista de movimientos bancarios
DateTime date Fecha y hora
ammount Monto
currency Moneda
currencyDescription Descripción de moneda
reference Referencia

 Estructuras:

public class BankStatement

{
public class Request
{
// Clave de usuario
public string userKey { get; set; }
// Número de cuenta
public long accountNumber { get; set; }
}
public class Response : BaseResponse
{
// Número de cuenta
public long accountNumber { get; set; }
// Tipo de cuenta
public int accountType { get; set; }
// Lista de movimientos bancarios
public List<BankingMovements> movements { get; set; }
}
public class BankingMovements
{
// Fecha y hora
public DateTime date { get; set; }
// Monto
public double ammount { get; set; }
// Moneda

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 4 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

public int currency { get; set; }

// Descripción de moneda
public string currencyDescription { get; set; }
// Referencia
public string reference { get; set; }
}
}

 Ejemplo de envío

Ruta: http://bnbapideveloper.azurewebsites.net/api/Enterprise/BankStatement
Json:

{
"userKey":"e8k7crKA9S0:APA91bGDZ76NccQkYXIzS5",
"accountNumber":"1501243627"
}

III. Servicio: “Saldo de una determinada cuenta”

Nombre del servicio: Balance

 Diccionario de datos

Campo Descripción
userKey Clave de usuario
accountNumber Número de cuenta
Account Cuenta
accountType Tipo de cuenta
balance Saldo
currency Moneda
currencyDescripcion Descripción de moneda

 Estructuras:

public class Balance

{
public class Request
{
// Clave de usuario
public string userKey { get; set; }
// Número de cuenta
public long accountNumber { get; set; }
}

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 5 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

public class Response : BaseResponse

{
// Cuenta
public Account account { get; set; }
}
}
public class Account
{
// Número de cuenta
public long acountNumber { get; set; }
// Tipo de cuenta
public int accountType { get; set; }
// Saldo
public double balance { get; set; }
// Moneda
public double currency { get; set; }
// Descripción de moneda
public string currencyDescripcion { get; set; }
}

 Ejemplo de envío

Ruta: http://bnbapideveloper.azurewebsites.net/api/Enterprise/Balance
Json:
{
"userKey":"e8k7crKA9S0:APA91bGDZ76NccQkYXIzS5",
"accountNumber":"1501243627"
}

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 6 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

IV. Servicio: “Saldos de todas las cuentas”

Nombre del servicio: AccountBalances

 Diccionario de datos:

Campo Descripción
userKey Clave de usuario
List<Account> accounts Lista de cuentas

 Estructuras:

public class Balances

{
public class Request
{
// Clave de usuario
public string userKey { get; set; }
}
public class Response : BaseResponse
{
// Lista de cuentas
public List<Account> accounts { get; set; }
}
}

 Ejemplo de envío

Ruta: http://bnbapideveloper.azurewebsites.net/api/Enterprise/accountBalances
Json
{
"userKey":"e8k7crKA9S0:APA91bGDZ76NccQkYXIzS5"
}

V. Servicio: “Registro de Boletas de garantía”

Nombre del servicio: RegisterGuaranteeBill

 Diccionario de datos:

Campo Descripción
userKey Clave de usuario
clientCode Código de cliente del obligado

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 7 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

bailType Tipo de fianza: Boleta de Garantía /

Garantía a Primer Requerimiento
bailConcept Concepto de la fianza
operationType Tipo de operación: Operación
Prepagada/Operación bajo línea de
crédito
isRenewal Si es renovación de otra boleta de
garantía
guaranteeBillRenewal Nro. Operación de la boleta que se está
renovando (si aplica)
currency Moneda de la boleta
amountGuaranteeBill Monto de la boleta
DateTime termEndDate Fecha fin de vigencia de la boleta
termAmountDays Cantidad de días de vigencia de la
boleta
accountNumberForPrepaid Número de cuenta cuando el tipo de
operación es prepago
loanLineAccountNumber Línea de crédito cuando el tipo de
operación es bajo línea de crédito
branchOfficePick Oficina en la que se recogerá el título
fullNamePick Nombre de la persona que recogerá el
título
documentNumberPick Número de documento de la persona
que recogerá el título
guaranteeInFavorOf Boleta de garantía en favor de
guaranteeObjectFor Objeto de la boleta de garantía
guaranteeOnBehalfOf Boleta de garantía por cuenta de
accountNumberCommissionPay Número de cuenta de donde se debitará
la comisión
includeTitle Incluir el texto: Título irrevocable,
renovable y de ejecución inmediata
en el objeto de la boleta
operationNumber Número de operación

 Estructuras

public class GuaranteeBill

{
public class Request
{
// Clave de ususario
public string userKey { get; set; }
// Código de cliente del obligado
public long clientCode { get; set; }

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 8 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

// Tipo de fianza: Boleta de Garantía / Garantía a Primer Requerimiento

public int bailType { get; set; }
// Concepto de la fianza
public int bailConcept { get; set; }
// Tipo de operación: Operación Prepagada/Operación bajo línea de crédito
public int operationType { get; set; }
// Si es renovación de otra boleta de garantía
public bool isRenewal { get; set; }
// Nro. Operación de la boleta que se está renovando (si aplica)
public long guaranteeBillRenewal { get; set; }
// Moneda de la boleta
public int currency { get; set; }
// Monto de la boleta
public decimal amountGuaranteeBill { get; set; }
// Fecha fin de vigencia de la boleta
public DateTime termEndDate { get; set; }
// Cantidad de días de vigencia de la boleta
public int termAmountDays { get; set; }
// Número de cuenta cuando el tipo de operación es prepago
public long accountNumberForPrepaid { get; set; }
// Línea de crédito cuando el tipo de operación es bajo línea de crédito
public long? loanLineAccountNumber { get; set; }
// Oficina en la que se recogerá el título
public int branchOfficePick { get; set; }
// Nombre de la persona que recogerá el título
public string fullNamePick { get; set; }
// Número de documento de la persona que recogerá el título
public long? documentNumberPick { get; set; }
// boleta de garantía en favor de
public string guaranteeInFavorOf { get; set; }
// Objeto de la boleta de garantía
public string guaranteeObjectFor { get; set; }
// Boleta de garantía por cuenta de
public string guaranteeOnBehalfOf { get; set; }
// Número de cuenta de donde se debitará la comisión
public long accountNumberCommissionPay { get; set; }
// Incluir el texto: Título irrevocable, renovable y de ejecución inmediata
en el objeto de la boleta
public bool includeTitle { get; set; }
}
public class Response : BaseResponse
{
// Número de operación
public long operationNumber { get; set; }

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 9 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

}
}

 Ejemplo de envío

Ruta:
http://bnbapideveloper.azurewebsites.net/api/Enterprise/RegisterGuaranteeBill
Json:
{
"userKey": "XrYi9OrZ0CCw7LGgOVDFh8aYT3M5KnPyAt",
"clientCode": "1010026582",
"bailType": "1014",
"bailConcept":"5",
"operationType": "1",
"isRenewal":"true",
"guaranteeBillRenewal":"1012227119",
"currency": "2003",
"amountGuaranteeBill": "133",
"termEndDate": "2017-08-01",
"termAmountDays": "365",
"accountNumberForPrepaid": "1520468087",
"loanLineAccountNumber": "1520468087",
"branchOfficePick": "1",
"fullNamePick": "IVAN SERGIO ESPINAL ALVAREZ",
"documentNumberPick": "8264274",
"guaranteeInFavorOf": "TERCERO",
"guaranteeObjectFor": "OBJETO",
"guaranteeOnBehalfOf": "GARANTE",
"accountNumberCommissionPay": "1520468087",
"includeTitle": "true"
}

 Parámetros de ejemplo

BailType

1011 = Seriedad de Propuesta

1012 = Cumplimiento de Contrato
1013 = Pago de derechos arancelarios
1014 = Consecuencias judiciales
1015 = Ejecución de Obra
1016 = Buena inversión del anticipo
1017 = Caución de cargos

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 10 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

Si el valor envío del campo es isRenewal es “true”, se validará el campo

“guaranteeBillRenewal”

Según los siguientes ejemplos de valores:

1012226519
1012226619
1012226719
1012226819
1012226919
1012227019
1012227119
1012227719
1012227819
1012227919
1012228019
1012228119
1012228219
1012228319

BranchOffice

LaPaz = 1,
SantaCruz = 2,
Cochabamba = 3,
Sucre = 4,
Oruro = 5,
Potosi = 6,
Tarija = 7,
Beni = 8,
Pando = 9

VI. Servicio: “Registro de Giros”

Nombre del servicio: RegisterWireTransfer

 Diccionario de datos:

Campo Descripción
userKey Clave de usuario
customerNumber Número de cliente
amountRequest Monto solicitado
currencyRequestId Moneda del giro
commisionType Tipo de comisión: Por separado/
Descontar

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 11 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

includeCertification Solicitar certificación

Beneficiary Beneficiario
BeneficiaryBank Banco beneficiario
accountToDebit Cuenta de la que se debitará
email Correo electrónico al que se enviará la
confirmación del giro
transactionReason Motivo de la transacción
fundsSource Origen de fondos
fundDestinationDescription Descripción de la destinación de los
fondos
fundsDestination Destino de los fondos
typePerson Tipo de persona
accountNumber Número de cuenta
fullName Nombre completo
documentNumber Número de documento
documentExt Documento exterior
nationality Nacionalidad
address Dirección
city Ciudad
countryId ID del país
phoneNumber Número de teléfono
economicActivityId ID de actividad económica
swiftCode Código Swift
bankAccount Cuenta del Banco
fullnameBank Nombre completo del banco
address Dirección
abaCode Código ABA
city Ciudad
countryId ID del país
agency Agencia
hasIntermediaryBank Si tiene un Banco intermediario
IntermediaryBank Banco intermediario
swiftCode Código Swift
fullnameBank Nombre completo del Banco
abaCode Código aba
city Ciudad
countryId ID País
address Dirección

 Estructuras

public class WireTransfer

{

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 12 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

public class Request

{
// Clave de usuario
public string userKey { get; set; }
// Número de cliente
public long customerNumber { get; set; }
// Monto solicitado
public decimal amountRequest { get; set; }
// Moneda del giro
public int currencyRequestId { get; set; }
// Tipo de comisión: Por separado/ Descontar
public int commisionType { get; set; }
// Solicitar certificación
public bool includeCertification { get; set; }
// Beneficiario
public Beneficiary beneficiary { get; set; }
// Banco beneficiario
public BeneficiaryBank beneficiaryBank { get; set; }
// Cuenta de la que se debitará
public long accountToDebit { get; set; }
// Correo electrónico al que se enviará la confirmación del giro
public string email { get; set; }
// Motivo de la transacción
public string transactionReason { get; set; }
// Origen de fondos
public string fundsSource { get; set; }
// Descripción de la destinación de los fondos
public string fundDestinationDescription { get; set; }
// Destino de los fondos
public int fundsDestination { get; set; }
}
public class Response : BaseResponse
{
}
}

public class Beneficiary

{
// Tipo de persona
public int typePerson { get; set; }
// Número de cuenta
public long accountNumber { get; set; }
// Nombre completo
public string fullName { get; set; }

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 13 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

// Número de documento
public long documentNumber { get; set; }
// Documento exterior
public int documentExt { get; set; }
// Nacionalidad
public int nationality { get; set; }
// Dirección
public string address { get; set; }
// Ciudad
public string city { get; set; }
// ID del país
public int countryId { get; set; }
// Número de teléfono
public long phoneNumber { get; set; }
// ID de actividad económica
public int economicActivityId { get; set; }
}

public class BeneficiaryBank

{
// Código Swift
public string swiftCode { get; set; }
// Cuenta del Banco
public string bankAccount { get; set; }
// Nombre completo del banco
public string fullnameBank { get; set; }
// Dirección
public string address { get; set; }
// Código ABA
public string abaCode { get; set; }
// Ciudad
public string city { get; set; }
// ID del país
public int countryId { get; set; }
// Agencia
public string agency { get; set; }
// Si tiene un Banco intermediario
public bool hasIntermediaryBank { get; set; }
// Banco intermediario
public IntermediaryBank intermediaryBank { get; set; }
}

public class IntermediaryBank

{

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 14 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

// Código Swift
public string swiftCode { get; set; }
// Nombre completo del Banco
public string fullnameBank { get; set; }
// Código aba
public string abaCode { get; set; }
// Ciudad
public string city { get; set; }
// ID País

public int countryId { get; set; }

// Dirección
public string address { get; set; }
}

 Ejemplo de envío
Ruta:
http://bnbapideveloper.azurewebsites.net/api/Enterprise/RegisterWireTransfer

Json:

{
"userKey": "XrYi9OrZ0CCw7LGgOVDFh8aYT3M5KnPyAt",
"customerNumber": "1010027094",
"amountRequest": "125.2",
"currencyRequestId": "2003",
"commisionType": "1",
"includeCertification": "false",
"beneficiary": {
"typePerson" : "1",
"accountNumber": "1520468087",
"fullName": "Nombre Completo del Beneficiario",
"documentNumber": "6795862",
"documentExt": "5",
"nationality": "1",
"address": "Zona Villa Victoria Nro. 75",
"city": "La Paz",
"countryId": "1",
"phoneNumber": "72545109",
"economicActivityId": "2"
},
"beneficiaryBank": {
"swiftCode": "BOFAUS3MXXX",
"bankAccount": "1520468052",

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 15 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital
 BNB API’S MARKET

"fullnameBank": "Bank Of America N.A",

"address": "Nationsbank Tower Miami, Fl 33131",
"abaCode": "1",
"city": "Miami, FL",
"countryId": "150",
"agency": "XXX",
"hasIntermediaryBank": "false",
"intermediaryBank": {
"swiftCode": "",
"fullnameBank": "",
"abaCode": "",
"city": "",
"countryId": "",
"address": ""
}
},

"accountToDebit": "1520467951",
"email": "[email protected]",
"transactionReason": "reason",
"fundsSource": "source",
"fundDestinationDescription": "destination",
"fundsDestination": "10"
}

BNB API’s Market

Innovation Center BNB Revisado por: Vicepresidencia Página: 16 de 16
Preparado por: Innovation Center BNB
Innovación y Transformación Digital