Litbit Invoice API

Qué son los Litbits

El Litbit (sigla LTB) es un token interno de BitBook Lite, que no puede convertirse en otra forma de dinero (como monedas fiduciarias o criptomonedas) de forma oficial.
Los Litbits pueden obtenerse, intercambiarse y transferirse dentro de BitBook Lite posibilitando varias funciones. Puedes aprender más en la sección de Litbit.
Nota: "Litbit" también es el nombre que lleva el libro contable de tokens internos de BitBook Lite, y no deben confundirse: Litbit (libro contable digital sobre el que funciona LTB, BBLUSD, etc.), LTB (el token llamado "Litbit").

Procesamiento de pagos con Litbits

Gracias a la Litbit Invoice API, tú como desarrollador podrás integrar el libro contable Litbit en tu propia plataforma, programa o servicio.
La Litbit Invoice API es una sección del API de BitBook Lite que permite crear y administrar Facturas Litbit (estilo checkout).
En otras palabras, permite al desarrollador crear, por medio de la API, facturas que pueden ser pagadas por los usuarios con tokens digitales de BitBook Lite, como el LTB o BBLUSD; lo que a su vez posibilita vender y comerciar productos en Tokens Litbit fuera de BitBook Lite.

¿Cómo funciona?

Aquí tenemos un escenario de ejemplo:

Creas una Factura Litbit con tus credenciales de acceso a la API.
Diriges al usuario a la página de pago.
El usuario realiza el pago con sus Litbits, que se transfieren a tu cuenta de BitBook Lite.
Confirmas el pago de la Factura Litbit y entregas el producto vendido al usuario.

Puntos clave

Para acceder a la API necesitas tus credenciales de acceso (usuario y contraseña) que encontrarás aquí.
Los tokens cobrados se transferirán a tu cuenta de BitBook Lite, la misma de la que obtienes las credenciales de acceso a la API.
Los pagos NO tienen comisión.

Métodos y ejemplos

Los ejemplos están escritos en sentencias CURL. Puedes convertir las sentencias CURL a PHP usando esta página web.

create_litbit_invoice

Crea una Factura Litbit.

Ejemplo

curl -X POST https://bitbooklite.com/api/?type=create_litbit_invoice&apiUser=00000-AAAAA-00000-AAAAA-00000&apiPassword=000000-AAAAAA-000000-AAAAAA-000000
            -d 'pay_amount=10.45'
            -d 'pay_currency=LTB'
            -d 'return_url=https://web.com/'
            -d 'meta_title=Producto vendido'
            -d 'meta_description=Descripción del producto vendido'
            -d 'meta_custom_id=CUSTOM_ID_123'

Endpoint

https://bitbooklite.com/api/

GET parameters

type (obligatorio - string): Método de la API, en este caso, "create_litbit_invoice".
apiUser (obligatorio - string): Usuario de tu credencial de acceso API.
apiPassword (obligatorio - string): Contraseña de tu credencial de acceso API.

POST parameters

pay_amount (obligatorio - float[round(5)]): Monto a pagar.
pay_currency (obligatorio - string): Token digital interno en el que se emite la factura. Valores admitidos: LTB, BBLUSD, BBLBTC.
return_url (obligatorio - string): URL a la que el usuario será redirigido cuando complete el pago o lo cancele.
meta_title (obligatorio - string): Título de la factura [Largo máximo 200].
meta_description (opcional - string): Descripción de la factura [Largo máximo 2000].
meta_custom_id (opcional - string): Identificador variable del desarrollador [Largo máximo 9999]. Puedes guardar lo que quieras en este campo, como por ejemplo, el ID del producto vendido o la factura en tu sistema.

Valores devueltos

JSON


            {
                "error" : false,
                "errores" : {},
                "answer" : {
                    "invoice_id" : 100,
                    "invoice_url" : "https://bitbooklite.com/litbit/invoice/?id=100",
                    "pay_amount" : 10.45,
                    "pay_currency" : "LTB",
                    "return_url" : "https://web.com/",
                },
            }

error (obligatorio - boolean): "true" en caso de error.
errores (obligatorio - array): Conjunto de strings con los errores producidos, si existen.
answer (obligatorio - array):
- invoice_id (obligatorio - integer): ID de la Factura Litbit.
- invoice_url (obligatorio - string): URL de la Factura Litbit, donde el usuario puede realizar el pago.
- pay_amount (obligatorio - float): Monto de la factura.
- pay_currency (obligatorio - string): Moneda/token de la factura.
- return_url (obligatorio - string).

get_litbit_invoice

Obtiene la información de una Factura Litbit.

Ejemplo

curl -X POST https://bitbooklite.com/api/?type=get_litbit_invoice&apiUser=00000-AAAAA-00000-AAAAA-00000&apiPassword=000000-AAAAAA-000000-AAAAAA-000000
            -d 'invoice_id=100'

Endpoint

https://bitbooklite.com/api/

GET parameters

type (obligatorio - string): Método de la API, en este caso, "get_litbit_invoice".
apiUser (obligatorio - string): Usuario de tu credencial de acceso API.
apiPassword (obligatorio - string): Contraseña de tu credencial de acceso API.

POST parameters

invoice_id (obligatorio - integer): ID de la Factura Litbit.

Valores devueltos

JSON


            {
                "error" : false,
                "errores" : {},
                "answer" : {
                    "invoice_id" : 100,
                    "invoice_url" : "https://bitbooklite.com/litbit/invoice/?id=100",
                    "pay_amount" : 10.45,
                    "pay_currency" : "LTB",
                    "return_url" : "https://web.com/",
                    "creation_date" : "2022-12-31 00:00:00",
                    "payed" : 1,
                    "payed_date" : "2022-12-31 05:00:00",
                    "payer_user_id" : 562,
                    "meta_title" : "Producto vendido",
                    "meta_description" : "Descripción del producto vendido",
                    "meta_custom_id" : "CUSTOM_ID_123",
                },
            }

error (obligatorio - boolean): "true" en caso de error.
errores (obligatorio - array): Conjunto de strings con los errores producidos, si existen.
answer (obligatorio - array):
- invoice_id (obligatorio - integer): ID de la Factura Litbit.
- invoice_url (obligatorio - string): URL de la Factura Litbit, donde el usuario puede realizar el pago.
- pay_amount (obligatorio - float): Monto de la factura.
- pay_currency (obligatorio - string): Moneda/token de la factura.
- return_url (obligatorio - string).
- payed (obligatorio - integer): 0 si la factura está impaga, 1 si ya fue pagada.
- payed_date (obligatorio - string): Fecha en que se pagó la factura.
- payer_user_id (obligatorio - string): ID del usuario que pagó la factura.
- meta_title (obligatorio - string).
- meta_description (obligatorio - string).
- meta_custom_id (obligatorio - string).

list_litbit_invoices

Obtener una lista de Facturas Litbit creadas por ti.

Ejemplo

curl https://bitbooklite.com/api/v2/?apiUser=00000-AAAAA-00000-AAAAA-00000&apiPassword=000000-AAAAAA-000000-AAAAAA-000000
        -d 'api_consult_type=list_litbit_invoices'
        -d 'operation_data={"limit":10}'

Endpoint

https://bitbooklite.com/api/v2/

GET parameters

apiUser (obligatorio - string): Usuario de tu credencial de acceso API.
apiPassword (obligatorio - string): Contraseña de tu credencial de acceso API.

POST parameters

api_consult_type (obligatorio - string): Método de la API, en este caso, "list_litbit_invoices".
operation_data (obligatorio - json encoded array):
- limit (obligatorio - integer): Limite de movimientos a obtener (máximo 500).
- limitStart (opcional - integer): Inicio del límite, útil para paginación de resultados. DEFAULT = 0
- orderMode (opcional - string): Modo de ordenar los resultados, por la fecha de creación de las facturas, ascendente o descendente. Valores admitidos: ["ASC", "DESC"]. DEFAULT = "DESC"
- pay_currency (opcional - string): Si se envía, los resultados solo incluirán facturas con este token digital.
- payed (opcional - integer): Si se envía, los resultados solo incluirán facturas pagadas (1) o no pagadas (0).
- meta_custom_id (opcional - string): Si se envía, los resultados solo incluirán facturas con este meta_custom_id.

Valores devueltos

JSON


            {
                "error":false,
                "errores":[],
                "answer":{
                    "invoices":[
                        {
                            "invoice_id" : 100,
                            "invoice_url" : "https://bitbooklite.com/litbit/invoice/?id=100",
                            "pay_amount" : 10.45,
                            "pay_currency" : "LTB",
                            "return_url" : "https://web.com/",
                            "creation_date" : "2022-12-31 00:00:00",
                            "payed" : 1,
                            "payed_date" : "2022-12-31 05:00:00",
                            "payer_user_id" : 562,
                            "meta_title" : "Producto vendido",
                            "meta_description" : "Descripción del producto vendido",
                            "meta_custom_id" : "CUSTOM_ID_123",
                        },
                        {
                            "invoice_id" : 101,
                            "invoice_url" : "https://bitbooklite.com/litbit/invoice/?id=100",
                            "pay_amount" : 10.45,
                            "pay_currency" : "LTB",
                            "return_url" : "https://web.com/",
                            "creation_date" : "2022-12-31 00:01:00",
                            "payed" : 1,
                            "payed_date" : "2022-12-31 05:00:00",
                            "payer_user_id" : 623,
                            "meta_title" : "Producto vendido",
                            "meta_description" : "Descripción del producto vendido",
                            "meta_custom_id" : "CUSTOM_ID_456",
                        },
                    ]
                }
            }

error (obligatorio - boolean): "true" en caso de error.
errores (obligatorio - array): Conjunto de strings con los errores producidos, si existen.
answer (obligatorio - array): respuesta del servidor.
- invoices (obligatorio - array): Lista de Facturas Litbit.
  - Ver: Valores devueltos del método get_litbit_invoice

Flujo sugerido

Guardar en tu base de datos la compra iniciada.
Crear Factura Litbit con el método create_litbit_invoice, enviando el ID de la compra iniciada en tu base de datos como meta_custom_id y como parámetro GET en la return_url.
Actualizar la compra iniciada en tu base de datos para guardar invoice_id.
Redirigir al usuario a la invoice_url.
Obtener la Factura Litbit actualizada con el método get_litbit_invoice, usando el invoice_id obtenido previamente.
Verificar si fue pagada (payed == 1).
Si fue pagada, entregar el producto al usuario.

Volver atrás

Nuevo post

Categorías del post

Qué son los Litbits

Procesamiento de pagos con Litbits

¿Cómo funciona?

Puntos clave

Métodos y ejemplos

create_litbit_invoice

Ejemplo

Endpoint

GET parameters

POST parameters

Valores devueltos

get_litbit_invoice

Ejemplo

Endpoint

GET parameters

POST parameters

Valores devueltos

list_litbit_invoices

Ejemplo

Endpoint

GET parameters

POST parameters

Valores devueltos

Flujo sugerido