Introduction

Bienvenido a la documentación de la API de Kutamma! Puedes usar esta api para acceder a todos las caracteristicas de kutamma a traves de una integración directa con tu solución o producto digital, de manera de complementarlo y extenderlo a traves de las posibilidades entregadas por un ecosistema de wallets cashless privado.

Con la API de Kutama podras crear espacios, subespacios, productos, coins, cupones y personalizar toda la experiencias con tus clientes en los distintos touchpoint existentes con estos.

Ya sea utilices Kutamma para vender, emitir ecosistemas de prepago, generar activaciones de marketing, generar programa de fidelización o para diseñar flujos de trabajo mediante el uso de wallets y microtransacciones entre usuarios, esta API te permitira controlar de punta a punta las distintas interacciones asi como la información generada.

Sientete libre de solicitar nuevos features o capacidades a traves de nuestro Service Desk.

Autorización

# With shell, you can just pass the correct header with each request
curl "https://api.kutamma.com/endpoint" \
  -H "X-API-Key: DUCK-API-KEY"
  -H "X-Secret: DUCK-SECRET"

const kittn = require("kittn");

let api = kittn.authorize("meowmeowmeow");

Para utilizar la API, debes obtener una API Key autorizada para transaccionar con la cuenta de Kutamma. Recuerda que una clave de API Key solo puede ejecutar operaciones sobre los espacios creados por la cuenta:

Para obtener una API Key por favor visita el siguiente enlace API KEY Integration.

Todas los endpoints de la API, necesitan la llave y el secret como mandatorios para aceptar la petición en los header como se indica a continuación:

X-API-Key: DUCK-API-KEY

X-Secret: DUCK-SECRET

Debes reemplazar DUCK-API-KEY y DUCK-SECRET con tus API key y secret.

Espacios

Crear Espacio.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
  --data-raw '{"name":"Espacio de prueba","description": "Descripción del espacio de prueba","image":"7a34be8c-f584-4205-983e-347479f88412","charge":false,"transfer":false,"nominal":false,"initDate":"2023-04-26T04:45:37.620Z","endDate":"2023-05-31T04:45:37.620Z"}' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "name": "Espacio de prueba",
  "description": "Descripción del espacio de prueba",
  "initDate": "2023-03-26T06:30:26.830Z",
  "endDate": "2023-04-01T06:30:26.830Z",
  "transfer": false,
  "charge": false,
  "nominal": true,
  "image": "https://static.kutamma.com/6075b200-dc1f-4099-b12e-e1acb41f6a41"
}

Este endopint permite crear un espacio dentro de una cuenta. Cada espacio representa un contexto donde poder emitir billeteras digitales y efectuar transacciones.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.

Payload

Propiedad	Obligatorio	Type	Descripción
name	true	String	Es el nombre que se asignara al espacio.
description	false	String	Es la descripción que tendra el espacio para los usuarios del backoffice.
image	false	String	Es el ID temporal de la imagen del espacio.
initDate	false	String	Es la fecha de inicio donde sera valido y activo el evento para comenzar a efectuar transacciones.
endDate	false	String	Es la fecha de termino donde sera valido y activo el evento para comenzar a efectuar
charge	true	String	Indica si por defecto las billeteras emitidas podran cargar dinero.
transfer	true	String	Indica si por defecto las billeteras emitidas podran efectuar transferencias entre usuarios.
nominal	false	String	Indica si por defecto las billeteras seran nominales, solicitando los datos del usuario y siendo individualizado a traves de su DNI

Editar Espacio.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
  --data-raw '{"name":"Espacio de prueba","description": "Descripción del espacio de prueba","image":"7a34be8c-f584-4205-983e-347479f88412","charge":false,"transfer":false,"nominal":false,"initDate":"2023-04-26T04:45:37.620Z","endDate":"2023-05-31T04:45:37.620Z"}' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "name": "Espacio de prueba",
  "description": "Descripción del espacio de prueba",
  "initDate": "2023-03-26T06:30:26.830Z",
  "endDate": "2023-04-01T06:30:26.830Z",
  "transfer": false,
  "charge": false,
  "nominal": true,
  "image": "https://static.kutamma.com/6075b200-dc1f-4099-b12e-e1acb41f6a41"
}

Este endopint permite editar un espacio dentro de una cuenta. Cada espacio representa un contexto donde poder emitir billeteras digitales y efectuar transacciones.

HTTP Request

PATCH https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.

Payload

Propiedad	Obligatorio	Type	Descripción
name	true	String	Es el nombre que se asignara al espacio.
description	false	String	Es la descripción que tendra el espacio para los usuarios del backoffice.
image	false	String	Es el ID temporal de la imagen del espacio.
initDate	false	String	Es la fecha de inicio donde sera valido y activo el evento para comenzar a efectuar transacciones.
endDate	false	String	Es la fecha de termino donde sera valido y activo el evento para comenzar a efectuar
charge	true	String	Indica si por defecto las billeteras emitidas podran cargar dinero.
transfer	true	String	Indica si por defecto las billeteras emitidas podran efectuar transferencias entre usuarios.
nominal	false	String	Indica si por defecto las billeteras seran nominales, solicitando los datos del usuario y siendo individualizado a traves de su DNI
visible	false	Boolean	Indica si un espacio esta visible dentro de la cuenta y la aplicación movil

Obtener un espacio.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "name": "Evento Principal - Puerto Varas",
  "description": "Convención latinoamericana de ventas Principal 2023",
  "initDate": "2023-03-26T06:30:26.830Z",
  "endDate": "2023-04-01T06:30:26.830Z",
  "transfer": false,
  "charge": false,
  "nominal": true,
  "image": "https://static.kutamma.com/6075b200-dc1f-4099-b12e-e1acb41f6a41"
}

Este endopint permite obtener un espacio a partir de su ID. Cada espacio representa un contexto donde poder emitir billeteras digitales y efectuar transacciones.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
ID	Representa el id del espacio seleccionado.

Obtener espacios de una cuenta.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \

[
  {
    "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
    "createdAt": "2023-03-28T06:30:33.008Z",
    "updatedAt": "2023-03-28T06:30:33.008Z",
    "name": "Evento Principal - Puerto Varas",
    "description": "Convención latinoamericana de ventas Principal 2023",
    "initDate": "2023-03-26T06:30:26.830Z",
    "endDate": "2023-04-01T06:30:26.830Z",
    "transfer": false,
    "charge": false,
    "nominal": true,
    "image": "https://static.kutamma.com/6075b200-dc1f-4099-b12e-e1acb41f6a41"
  }
]

Este endopints devuelve todos los espacios creados en la cuenta y no se hallan eliminado.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces

URL Parameters

Parameter	Description
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.

Subespacios

Crear un subespacio.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces' \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  --data-raw '{"name":"Subespacio de prueba","initDate":"2023-05-01T12:03:26.226Z","endDate":"2023-05-31T12:03:26.226Z","description":"Es un subespacio de prueba","image":"965fec8e-bd98-4759-aa56-027267d0e83d"}'

{
  "id": "e7f73799-1d3c-4ecf-af04-3d38f27bfba5",
  "name": "Subespacio de prueba",
  "description": "Es un subespacio de prueba",
  "initDate": "2023-05-01T12:03:26.226Z",
  "endDate": "2023-05-31T12:03:26.226Z",
  "image": "61f6497a-49ee-4ee6-9541-0aff54867afb",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "createdAt": "2023-04-26T16:03:31.672Z",
  "updatedAt": "2023-04-26T16:03:31.672Z"
}

Este endopint permite crear un subespacio dentro de un espacio. Un subespacio es una agrupación logica y virtual de caractersiticas que permiten separar dentro de un mismo scope tanto productos, usuarios, como operaciones. En un futuro proximo los subespacios se podran asignar a usuarios de tal manera que estos solo puedan acceder a los productos y elementos agregados al subespacio delimitado.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.

Payload

Propiedad	Obligatorio	Descripción
name	true	Es el nombre que se asignara al espacio.
description	false	Es la descripción que tendra el espacio para los usuarios del backoffice.
image	false	Es el ID temporal de la imagen del espacio.
initDate	false	Es la fecha de inicio donde sera valido y activo el evento para comenzar a efectuar transacciones.
endDate	false	Es la fecha de termino donde sera valido y activo el evento para comenzar a efectuar

Editar un subespacio.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<ID>' \
  -X 'PATCH' \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  --data-raw '{"id":"5d8312b2-90fe-43df-9574-7233746056c9","createdAt":"2023-04-26T16:02:53.783Z","updatedAt":"2023-04-26T16:02:53.783Z","name":"Subspacio de prueba","description":"Es un subespacio de prueba editado","initDate":"2023-05-01T12:02:46.951Z","endDate":"2023-05-31T12:02:46.951Z","image":"https://static.kutamma.com/c04ad259-d0e5-4954-8ed0-6252136f473b","date":["2023-05-01T12:02:46.951Z","2023-05-31T12:02:46.951Z"]}'

{
  "id": "e7f73799-1d3c-4ecf-af04-3d38f27bfba5",
  "name": "Subespacio de prueba",
  "description": "Es un subespacio de prueba editado",
  "initDate": "2023-05-01T12:03:26.226Z",
  "endDate": "2023-05-31T12:03:26.226Z",
  "image": "61f6497a-49ee-4ee6-9541-0aff54867afb",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "createdAt": "2023-04-26T16:03:31.672Z",
  "updatedAt": "2023-04-26T16:03:31.672Z"
}

Este endopint permite editar un subespacio creado, para editar sus campos basidos descriptivos.

HTTP Request

PATCH https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.
ID	Representa el id del subespacio seleccionado.

Payload

Propiedad	Obligatorio	Descripción
name	true	Es el nombre que se asignara al espacio.
description	false	Es la descripción que tendra el espacio para los usuarios del backoffice.
image	false	Es el ID temporal de la imagen del espacio.
initDate	false	Es la fecha de inicio donde sera valido y activo el evento para comenzar a efectuar transacciones.
endDate	false	Es la fecha de termino donde sera valido y activo el evento para comenzar a efectuar

Obtener subespacio.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<ID>' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'Content-Type: application/json' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "name": "Evento Principal - Puerto Varas",
  "description": "Convención latinoamericana de ventas Principal 2023",
  "initDate": "2023-03-26T06:30:26.830Z",
  "endDate": "2023-04-01T06:30:26.830Z",
  "transfer": false,
  "charge": false,
  "nominal": true,
  "image": "https://static.kutamma.com/6075b200-dc1f-4099-b12e-e1acb41f6a41"
}

Este endopint permite obtener un subespacio a partir de su ID.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.
ID	Representa el id del subespacio seleccionado.

Obtener productos de subespacio.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<ID>/products' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \

[
  {
    "id": "b35609e6-5030-4737-bb1d-82c5bf6f212f",
    "createdAt": "2023-03-28T11:06:10.583Z",
    "updatedAt": "2023-03-28T11:06:10.583Z",
    "name": "Producto de prueba",
    "description": "Descripcion producto de prueba",
    "image": "https://static.kutamma.com/47bc6a1a-8dc9-4f7c-9612-254efe26b8d3",
    "costs": [
      {
        "id": "ab7594b8-f648-46d7-9e8b-5647fd710017",
        "createdAt": "2023-03-28T11:11:49.552Z",
        "updatedAt": "2023-03-28T11:11:49.552Z",
        "money": null,
        "type": 1,
        "amount": 1
      }
    ]
  }
]

Este endopint permite obtener los productos asociados a un subespacio.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<ID>/products

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.
ID	Representa el id del subespacio seleccionado.

Agregar producto a subespacio.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<SUBSPACE>/products' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'Content-Type: application/json' \
  --data-raw '{"product":"fddb6072-f052-437c-b3d4-42782c252884"}' \

Status Code: 201 Created

Este endopint permite agregar un producto a un subespacio creado previamente.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<SUBSPACE>/products/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.
SUBSPACE	Representa el id del subespacio seleccionado.

Payload

Propiedad	Obligatorio	Type	Descripción
product	true	String	Id del producto que se desea asignar al subspacio

Eliminar producto de subespacio.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<SUBSPACE>/products/<ID>' \
  -X 'DELETE' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'Content-Type: application/json' \

No response - Code 204

Este endopint permite remover un producto asociado a un subespacio previamente.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/subspaces/<SUBSPACE>/products/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.
SUBSPACE	Representa el id del subespacio seleccionado.
ID	Representa el id del producto seleccionado.

Productos

Crear un producto.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<ID>' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
 --data-raw '{"name":"Producto de prueba","description":"Es un producto utilizado a modo de ejemplo","image":"db06ed6f-78cb-4e07-b0bd-6ec01e1d9340"}'

{
  "id": "26090826-003e-48e4-b731-ce8e79a28f18",
  "name": "Producto de prueba",
  "description": "Es un producto utilizado a modo de ejemplo",
  "image": "fef758db-d725-4f99-93ce-33e7300fb4ab",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "createdAt": "2023-04-27T01:01:46.832Z",
  "updatedAt": "2023-04-27T01:01:46.832Z"
}

Este endopint permite crear un producto dentro del espacio. Un producto es la unidad basica que sera utilizada para generar transacciones y efectuar interacciones entre los usuarios. Un producto puede consumir cupones o dinero cargado en una wallet, asi como efectuar operaciónes en las wallets involucradas.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.

Payload

Propiedad	Obligatorio	Type	Descripción
name	true	String	Nombre del producto
description	false	String	Descripción del producto que sera utilizado para efectuar transacciones
image	false	String	Id de la imagen a utilizar

Editar un producto.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<ID>' \
  -X 'PATCH' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
  --data-raw '{"name":"Producto de prueba modificado","description":"Es un producto utilizado a modo de ejemplo"}'

{
  "id": "26090826-003e-48e4-b731-ce8e79a28f18",
  "createdAt": "2023-04-27T01:01:46.832Z",
  "updatedAt": "2023-04-27T01:03:38.396Z",
  "name": "Producto de prueba modificado",
  "description": "Es un producto utilizado a modo de ejemplo",
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c"
}

Permite editar un producto previamente creado a partir de su ID.

HTTP Request

PATCH https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.
ID	Representa el id del producto que se desea editar.

Payload

Propiedad	Obligatorio	Type	Descripción
name	true	String	Nombre del producto
description	false	String	Descripción del producto que sera utilizado para efectuar transacciones
image	false	String	Id de la imagen a utilizar

Agregar costo a producto.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<ID>/costs' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'Content-Type: application/json' \
  --data-raw '{"type":0,"money":7000}'

{
  "id": "4080ed03-705e-448b-8cc5-6a27f84c58ca",
  "money": 7000,
  "type": 0,
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "product": "117628bf-c30c-4b84-83bc-b7e6a95a8b00",
  "amount": null,
  "createdAt": "2023-04-27T17:19:28.426Z",
  "updatedAt": "2023-04-27T17:19:28.426Z"
}

Este endopint permite agregar un costo a un producto creado. Es importante indicar que un producto sin costos, sera una transacción gratuita entre usuarios, por lo que es necesario agregar costos a un producto para que consuma dinero o cupones entre usuarios.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<ID>/costs

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
ID	Representa el ID del producto seleccionado.

Payload

Propiedad	Obligatorio	Type	Descripción
type	true	Enum	0: Dinero, 1: Cupon
money	Depends on type = 0	Number	Indica la cantidad de dinero que sera utilizado como costo
cupon	Depends on type = 1	String	Id del cupon a utilizar como costo
amount	Depends on type = 1	Number	Indica la cantidad de cupones que seran consumidos como costo

Eliminar costo.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<PRODUCT>/costs/<ID>' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -X 'DELETE' \
  -H 'Content-Type: application/json'

Status Code: 204

Este endopint permite eliminar un costo de un producto creado. Es importante indicar que un producto sin costos, sera una transacción gratuita entre usuarios, por lo que es necesario agregar costos a un producto para que consuma dinero o cupones entre usuarios.

HTTP Request

DELETE https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<PRODUCT>/costs/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
PRODUCT	Representa el ID del producto seleccionado.
ID	Representa el ID del costo seleccionado.

Agregar operación.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<PRODUCT>/operations' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
  --data-raw '{"type":0,"money":7000}'

{
  "id": "61cde051-56a7-4d9f-8afd-e633b1f0cfea",
  "type": 0,
  "money": 7000,
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "product": "6ef89ad1-c63e-47be-981e-12f7bc214dbe",
  "amount": null,
  "createdAt": "2023-04-27T14:35:32.886Z",
  "updatedAt": "2023-04-27T14:35:32.886Z"
}

Este endopint permite agregar una operación a un producto en particular. Una operación es una acción que se ejecuta en la billetera de los usuarios producto de una transacción.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<PRODUCT>/operations

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.
PRODUCT	Representa el ID del producto seleccionado.

Payload

Propiedad	Obligatorio	Type	Descripción
type	true	Enum	0: Cargar Dinero, 1: Cargar Cupon, 2: Generar asociación
money	Depends on type = 0	Number	Indica la cantidad de dinero que sera cargado
cupon	Depends on type = 1	String	Id del cupon a utilizar como operación
amount	Depends on type = 1	Number	Indica la cantidad de cupones que seran cargados

Eliminar operación.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<PRODUCT>/operations/<ID>' \
  -X 'DELETE' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json'

Status Code: 204

Este endopint permite eliminar una operación de un producto en particular. Una operación es una acción que se ejecuta en la billetera de los usuarios producto de una transacción.

HTTP Request

DELETE https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/products/<PRODUCT>/operations/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.
PRODUCT	Representa el id del producto seleccionado.
ID	Representa el id de la operación seleccionado.

Cupones y Coins

Crear cupon.

  curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/coupons' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
  --data-raw '{"name":"Cupon de prueba","description":"Es un cupon de prueba para la documentación"}'

{
  "id": "6dccbd54-2d3e-4783-af12-196a24ba164c",
  "name": "Cupon de prueba",
  "description": "Es un cupon de prueba para la documentación",
  "createdAt": "2023-04-27T14:45:39.442Z",
  "updatedAt": "2023-04-27T14:45:39.442Z"
}

Este endopint permite crear un cupon en el espacio. Un cupon representa un activo de la billetera digital que puede ser utilizado para efectuar transacciones, ya que sirve como insumo para adquirir productos. Las billeteras pueden ser cargadas con cupones.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/coupons

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el id del espacio seleccionado.

Payload

Propiedad	Obligatorio	Descripción
name	true	Es el nombre que se asignara al espacio.
description	false	Es la descripción que tendra el espacio para los usuarios del backoffice.

Operaciones

Crear una operación.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>/subspaces' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "name": "Evento Principal - Puerto Varas",
  "description": "Convención latinoamericana de ventas Principal 2023",
  "initDate": "2023-03-26T06:30:26.830Z",
  "endDate": "2023-04-01T06:30:26.830Z",
  "transfer": false,
  "charge": false,
  "nominal": true,
  "image": "https://static.kutamma.com/6075b200-dc1f-4099-b12e-e1acb41f6a41"
}

Este endopint permite obtener un espacio a partir de su ID. Cada espacio representa un contexto donde poder emitir billeteras digitales y efectuar transacciones.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
ID	Representa el id del espacio seleccionado.

Payload

Propiedad	Obligatorio	Descripción
name	true	Es el nombre que se asignara al espacio.
description	false	Es la descripción que tendra el espacio para los usuarios del backoffice.
image	false	Es el ID temporal de la imagen del espacio.
initDate	false	Es la fecha de inicio donde sera valido y activo el evento para comenzar a efectuar transacciones.
endDate	false	Es la fecha de termino donde sera valido y activo el evento para comenzar a efectuar

Editar una operación.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>/subspaces' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "name": "Evento Principal - Puerto Varas",
  "description": "Convención latinoamericana de ventas Principal 2023",
  "initDate": "2023-03-26T06:30:26.830Z",
  "endDate": "2023-04-01T06:30:26.830Z",
  "transfer": false,
  "charge": false,
  "nominal": true,
  "image": "https://static.kutamma.com/6075b200-dc1f-4099-b12e-e1acb41f6a41"
}

Este endopint permite obtener un espacio a partir de su ID. Cada espacio representa un contexto donde poder emitir billeteras digitales y efectuar transacciones.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
ID	Representa el id del espacio seleccionado.

Agregar acción de operación.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>/subspaces' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "name": "Evento Principal - Puerto Varas",
  "description": "Convención latinoamericana de ventas Principal 2023",
  "initDate": "2023-03-26T06:30:26.830Z",
  "endDate": "2023-04-01T06:30:26.830Z",
  "transfer": false,
  "charge": false,
  "nominal": true,
  "image": "https://static.kutamma.com/6075b200-dc1f-4099-b12e-e1acb41f6a41"
}

Este endopint permite obtener un espacio a partir de su ID. Cada espacio representa un contexto donde poder emitir billeteras digitales y efectuar transacciones.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
ID	Representa el id del espacio seleccionado.

Eliminar acción de operación.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>/subspaces' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "name": "Evento Principal - Puerto Varas",
  "description": "Convención latinoamericana de ventas Principal 2023",
  "initDate": "2023-03-26T06:30:26.830Z",
  "endDate": "2023-04-01T06:30:26.830Z",
  "transfer": false,
  "charge": false,
  "nominal": true,
  "image": "https://static.kutamma.com/6075b200-dc1f-4099-b12e-e1acb41f6a41"
}

Este endopint permite obtener un espacio a partir de su ID. Cada espacio representa un contexto donde poder emitir billeteras digitales y efectuar transacciones.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
ID	Representa el id del espacio seleccionado.

Wallets

Obtener wallets.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json'

[
  {
    "id": "2835d403-9e6f-4a82-8b70-32a2080175c0",
    "created_at": "2023-03-31T12:20:25.274Z",
    "updated_at": "2023-03-31T12:20:25.274Z",
    "status": 1,
    "nominal": true,
    "secret": false,
    "expiration": "2023-04-05T07:45:18.337Z",
    "transfer": true,
    "charge": true,
    "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
    "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
    "template": "Nombre del template",
    "owner": "Nombre del owner",
    "money": null,
    "coupons": 5
  }
]

Este endopint permite obtener las billeteras emitidas en el espacio seleccionado. Las billeteras son la unidad basica dentro del ecosistema cashless y permiten a los usuarios efectuar transacciones de cualqueir tipo configuradas por el emisor. Cada billetera permite invocar una digital wallet a partir de su contenido.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.

Crear una wallet manual.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets/manual' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
  --data-raw '{"wallet":{"expiration":"2023-04-30T15:01:14.584Z","nominal":true,"transfer":false,"charge":true,"owner":{"name":"Nombre","lastname":"Apellido","email":"email@gmail.com","dni":"DNI","phone":"+1111111111","birthday":"1988-04-27T15:01:47.652Z"}},"load":[{"type":0,"money":7000}]}, "metadata": {"6c6fad6d-ec4d-4051-93c6-71ff2d9f3535": "Campo metadata"}' \

{
  "id": "a5cd6e0c-b6db-43f8-ba2b-62a0a8b4f558",
  "status": 1,
  "nominal": true,
  "expiration": "2023-04-30T15:01:14.584Z",
  "transfer": false,
  "charge": true,
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "owner": "d137dea7-1253-4762-ab62-767019664fbe",
  "secret": null,
  "createdAt": "2023-04-27T15:02:20.207Z",
  "updatedAt": "2023-04-27T15:02:20.207Z"
}

Este endopint permite crear una wallet manualmente. En la creación manual deben especificarse todos los campos y la carga inicial que tendra esta.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets/manual

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del producto seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
wallet	true	Wallet	Es el objeto que especifica las caracteristicas de la wallet.
load	true	Load	Es el objeto que especifica la carga inicial de la wallet.
metadata	false	Metadata	Es el objeto que contiene los campos de metadata de la wallet.

Wallet Object

Propiedad	Obligatorio	Tipo	Descripción
expiration	true	Date	Es la fecha en que la wallet deja de ser valida
nominal	true	Boolean	Establece si la wallet es nominal (Pide los datos de identficiacion del portador)
transfer	true	Boolean	Establecer si estan permitidas las transferencias entre usuarios.
charge	true	Boolean	Establecer si esta permitido cargar dinero.
owner	Depends nominal	Owner	Si la billetera se establece como nominal debe indicarse los datos del usuario.

Owner Object

Propiedad	Obligatorio	Tipo	Descripción
name	true	String	Especifica el nombre del usuario.
lastname	true	String	Especifica el apellido del usuario.
email	true	String	Especifica el email del usuario.
dni	true	String	Especifica el dni del usuario.
phone	false	String	Especifica el telefono del usuario.
birthday	false	Date	Especifica la fecha de nacimiento del usuario.

Load Object

Propiedad	Obligatorio	Tipo	Descripción
type	true	ENUM	0 = Si la carga es dinero, 1 = La carga es un cupon
money	Depends type 0	Number	Especifica la cantidad de dinero a cargar
coupon	Depends type 1	String	Especifica el ID del cupon a cargar
amount	Depends type 1	Number	Especifica la cantidad de cupones a cargar

Metadata Object

Propiedad	Obligatorio	Tipo	Descripción
{Metadata_UUID}*	false	string	Es un campo de metadata, basado en su UUID. Por cada metadata existe un UUID. Por cada campo de metadata que se quiere agregar a la wallet debe indicarse una fila, del tipo llave valor UUID - Value

Crear una wallet con template.

  curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets/template' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'Content-Type: application/json' \
  --data-raw '{"template":"82b46b92-ea33-45c8-b5af-975582f79d82","nominal":true,"owner":{"name":"Prueba","lastname":"Apellido","email":"test@gmail.com","dni":"11.111.111-1","phone":"+1111111111","birthday":"2023-04-26T03:49:03.567Z"}}' \

{
  "id": "85086b62-d052-4afb-9425-58cf9c435864",
  "status": 1,
  "nominal": true,
  "expiration": "2023-04-05T11:45:18.337Z",
  "transfer": true,
  "charge": true,
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "template": "82b46b92-ea33-45c8-b5af-975582f79d82",
  "owner": "08ad4484-63a6-409b-bfdc-18d761f71e99",
  "secret": null,
  "createdAt": "2023-04-28T07:49:06.025Z",
  "updatedAt": "2023-04-28T07:49:06.025Z"
}

Este endopint permite crear una wallet a partir de un template creado previamente. La creación con template puede asignar nominalmente un usuario con sus datos correspondientes.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets/template

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
template	true	String	Es el ID del template que se desea utilizar.
nominal	false	Boolean	Es el objeto que especifica la carga inicial de la wallet
owner	Depends nominal	Owner	Si la billetera se establece como nominal debe indicarse los datos del usuario.

Owner Object

Propiedad	Obligatorio	Tipo	Descripción
name	true	String	Especifica el nombre del usuario.
lastname	true	String	Especifica el apellido del usuario.
email	true	String	Especifica el email del usuario.
dni	true	String	Especifica el dni del usuario.
phone	false	String	Especifica el telefono del usuario.
birthday	false	Date	Especifica la fecha de nacimiento del usuario.

Crear una asociación.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/associations' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
  --data-raw '{"wallet":"82b46b92-ea33-45c8-b5af-975582f79d82","association":"82b46b92-ea55-45c8-b5af-975582f79d76"}' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "identifier": "82b46b92-ea55-45c8-b5af-975582f79d76",
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "wallet": "82b46b92-ea33-45c8-b5af-975582f79d82"
}

Este endopint permite crear una asociación entre la billetera un medio de identificación legible como un codigo de barras, QR, Tarjeta NFC o cualquier tipo de acceso que permita su lectura. Las asociaciones funcionan como accesos directos hacia la wallet misma, por lo que al leer las asociaciones durante los procesos de validación de transacciones, se entendera que la entiedad que finalmente ejecuta la transacción es la unidad a la que se encuentra asociada.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/associations

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
wallet	true	String	Es el ID de la wallet que se desea utilizar.
association	true	String	Es un String que sera asociada a la wallet como un acceso directo a esta

Crear una plantilla de correo.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/emails/templates' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
  --data-raw '{"name":"Nombre","subject":"Asunto del correo", "template": "Template formateado json", "html": "Html template a utilizar"}' \

{
  "id": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-03-28T06:30:33.008Z",
  "updatedAt": "2023-03-28T06:30:33.008Z",
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "name": "Nombre de prueba",
  "subject": "Asunto de prueba",
  "template": "PLANTILLA JSON",
  "html": "PLANTILLA HTML"
}

Este endopint permite crear un template de correo que luego puede ser usado en las plantillas para generar Wallets. Una plantilla de correo sera enviada inmediatamente durante la emisión de una wallet nominal basada en un template al usuario especificado.

HTTP Request

POST https://api.kutamma.com/v1//tenants/<TENANT>/workspaces/<WORKSPACE>/emails/templates

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
ID	Representa el id del espacio seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
name	true	String	Es el ID de la wallet que se desea utilizar.
subject	true	String	Es un String que sera asociada a la wallet como un acceso directo a esta
template	false	String	Planitlla en formato JSON, para el editor Unlayer
html	true	String	HTML puro de la plantilla HTML. La plantilla para reemplazar elementos usa mustache

Crear una plantilla de wallet.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/templates/wallets' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"Plantilla de prueba","description":"Esta es una plantilla de prueba.","expiration":"2023-04-29T04:21:38.148Z","transfer":false,"charge":true}'

{
  "id": "b5ac850e-6945-40dd-97a9-7577b9efa4cb",
  "name": "Plantilla de prueba",
  "description": "Esta es una plantilla de prueba.",
  "expiration": "2023-04-29T04:21:38.148Z",
  "transfer": false,
  "charge": true,
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "createdAt": "2023-04-28T08:21:49.120Z",
  "updatedAt": "2023-04-28T08:21:49.120Z"
}

Este endpoint permite crear plantillas de wallets que luego puede ser utilizas para enviarlas masiva o individualmente a los usuarios. Una plantilla no es una wallet, sino una receta con la cual se fabricara una wallet que sera asignada a un usuario.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/templates/wallets

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
name	true	String	Es el nombre del template de wallet.
description	false	Load	Es la descripción de la plantilla de wallet
expiration	false	Load	Es la fecha de expiración de las wallets emitidas
transfer	true	Boolean	Especifica si las wallets creadas pueden efectuar transferencias
charge	true	Boolean	Especifica si las wallets creadas pueden efectuar cargas de dinero

Agregar precarga a plantilla.

  curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/templates/wallets/<TEMPLATE>/loads' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \
  --data-raw '{"type":0,"money":7000}'

{
  "id": "82acb853-d8b8-421d-b72d-65af7461f24d",
  "type": 0,
  "money": 7000,
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "template": "82b46b92-ea33-45c8-b5af-975582f79d82",
  "amount": null,
  "createdAt": "2023-04-28T05:07:51.042Z",
  "updatedAt": "2023-04-28T05:07:51.042Z"
}

Este endopint permite agregar una carga por defecto a una plantilla de wallet. Se pueden agregar tantas precargas como se desee. Cada vez que una wallet sea creada, automaticamente sera cargada con los elementos que se hallan elegido como precarga.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/templates/wallets/<TEMPLATE>/loads

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.
TEMPLATE	Representa el ID del template seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
type	true	ENUM	0 = Si la carga es dinero, 1 = La carga es un cupon
money	Depends type 0	Number	Especifica la cantidad de dinero a cargar
coupon	Depends type 1	String	Especifica el ID del cupon a cargar
amount	Depends type 1	Number	Especifica la cantidad de cupones a cargar

Eliminar precarga de plantilla.

  curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/templates/wallets/<TEMPLATE>/loads/<PRELOAD>' \
  -X 'DELETE' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json'

Status Code: 204

Este endopint permite eliminar una carga por defecto de una plantilla de wallet. Cada vez que una wallet sea creada, automaticamente sera cargada con los elementos que se hallan elegido como precarga.

HTTP Request

DELETE https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/templates/wallets/<TEMPLATE>/loads/<PRELOAD>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.
TEMPLATE	Representa el ID del template seleccionado.
PRELOAD	Representa el ID de la precarga.

Agregar correo a plantilla.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/templates/wallets/<TEMPLATE>' \
  -X 'PATCH' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'Content-Type: application/json' \
  --data-raw '{"email":"c7d72371-1772-4862-a4e7-358e11f96117"}'

{
  "id": "b5ac850e-6945-40dd-97a9-7577b9efa4cb",
  "createdAt": "2023-04-28T08:21:49.120Z",
  "updatedAt": "2023-04-28T10:26:25.319Z",
  "name": "Plantilla de prueba",
  "description": "Esta es una plantilla de prueba.",
  "expiration": "2023-04-29T04:21:38.148Z",
  "transfer": false,
  "charge": true,
  "email": "c7d72371-1772-4862-a4e7-358e11f96117"
}

Este endopint permite agregar un correo a una plantilla de correo previamente creada. Las plantillas de correo daran origen a los correos que recibiran los usuarios cuando se creen, asignen o se les envien wallets.

HTTP Request

PATCH https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/templates/wallets/<TEMPLATE>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.
TEMPLATE	Representa el ID del template seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
email	true	String	Representa el ID de la platilla de correo

Enviar una Wallet individual.

curl --location 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets/sends/single' \
-H "X-API-Key: <DUCK-API-KEY>" \
-H "X-Secret: <DUCK-SECRET>" \
-H 'Content-Type: application/json' \
  --data-raw '{
  "owner": {
      "name": "Nombre",
      "lastname": "Apellido",
      "email": "prueba@gmail.com",
      "dni": "11.111.111-1",
      "phone": "+56954081153",
      "birthday": "2023-04-30T06:34:56.849Z"
  },
  "nominal": true,
  "template": "c0f7ae48-1139-43f1-8fc7-4767fc94a21d"
}'

{
  "id": "6b595354-7eb4-4a0e-b162-f487e1946c8b",
  "status": 1,
  "nominal": true,
  "expiration": "2023-04-05T11:45:41.638Z",
  "transfer": true,
  "charge": true,
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "template": "c0f7ae48-1139-43f1-8fc7-4767fc94a21d",
  "owner": "3af71ca1-d0c5-4721-b355-0a4093efbbeb",
  "secret": null,
  "createdAt": "2023-04-28T10:36:19.944Z",
  "updatedAt": "2023-04-28T10:36:19.944Z"
}

Este endopint permite crear y enviar una billetera nominal, creada a partir de un template. Este metodo es un simil de la creación de billeteras a partir de un template.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets/sends/single

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
template	true	String	Es el ID del template que se desea utilizar.
nominal	false	Boolean	Es el objeto que especifica la carga inicial de la wallet
owner	Depends nominal	Owner	Si la billetera se establece como nominal debe indicarse los datos del usuario.

Owner Object

Propiedad	Obligatorio	Tipo	Descripción
name	true	String	Especifica el nombre del usuario.
lastname	true	String	Especifica el apellido del usuario.
email	true	String	Especifica el email del usuario.
dni	true	String	Especifica el dni del usuario.
phone	false	String	Especifica el telefono del usuario.
birthday	false	Date	Especifica la fecha de nacimiento del usuario.

Enviar Wallets masivamente.

curl --location 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets/sends/single' \
-H "X-API-Key: <DUCK-API-KEY>" \
-H "X-Secret: <DUCK-SECRET>" \
-H 'Content-Type: application/json' \
  --data-raw '{
  "owner": {
      "name": "Nombre",
      "lastname": "Apellido",
      "email": "prueba@gmail.com",
      "dni": "11.111.111-1",
      "phone": "+56954081153",
      "birthday": "2023-04-30T06:34:56.849Z"
  },
  "nominal": true,
  "template": "c0f7ae48-1139-43f1-8fc7-4767fc94a21d"
}'

{
  "id": "6b595354-7eb4-4a0e-b162-f487e1946c8b",
  "status": 1,
  "nominal": true,
  "expiration": "2023-04-05T11:45:41.638Z",
  "transfer": true,
  "charge": true,
  "tenant": "e5dc2983-836b-4d19-8182-336c5d9b7b19",
  "workspace": "b8159dfa-5a14-4b47-be00-3d82c463450c",
  "template": "c0f7ae48-1139-43f1-8fc7-4767fc94a21d",
  "owner": "3af71ca1-d0c5-4721-b355-0a4093efbbeb",
  "secret": null,
  "createdAt": "2023-04-28T10:36:19.944Z",
  "updatedAt": "2023-04-28T10:36:19.944Z"
}

Este endopint permite crear y enviar una billetera nominal, creada a partir de un template. Este metodo es un simil de la creación de billeteras a partir de un template.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/wallets/sends/single

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
template	true	String	Es el ID del template que se desea utilizar.
nominal	false	Boolean	Es el objeto que especifica la carga inicial de la wallet
owner	Depends nominal	Owner	Si la billetera se establece como nominal debe indicarse los datos del usuario.

Owner Object

Propiedad	Obligatorio	Tipo	Descripción
name	true	String	Especifica el nombre del usuario.
lastname	true	String	Especifica el apellido del usuario.
email	true	String	Especifica el email del usuario.
dni	true	String	Especifica el dni del usuario.
phone	false	String	Especifica el telefono del usuario.
birthday	false	Date	Especifica la fecha de nacimiento del usuario.

Metadata

Crear metadata.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json'
  --data '{
    "name": "Campos de prueba 3",
    "description": "Es una campo agregado a la metadata",
    "type": "text",
    "mandatory": true
  }'

{
  "id": "45bda052-c366-4235-bd6f-f5d92ae94c6d",
  "createdAt": "2023-06-19T16:36:03.893Z",
  "updatedAt": "2023-06-19T16:36:03.893Z",
  "name": "Campo de prueba 3",
  "description": "Es una campo agregado a la metadata",
  "type": "text",
  "mandatory": true,
  "deleted": false
}

Este endpoint permite crear un campo de metadata para utilizar en las wallets. Los campos de metadata son campos extras que pueden ser agregados con cada wallet creada. Esta metadata puede ser utilizada para distintos tipos de operaciones.

HTTP Request

POST https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.

Payload

Propiedad	Obligatorio	Tipo	Descripción
name	true	string	Especifica el nombre del metadato.
description	false	string	Especifica una descripción para el metadato a modo de ayuda
type	string	string	Es el tipo de campo (text, number, email, select, checkbox).
mandatory	false	boolean	Determina si el campo es oblogatorio en las wallet.

Obtener metadata de un workspace.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \

[
  {
    "id": "0f8120a3-74ff-4764-af07-151bbbd01515",
    "createdAt": "2023-06-19T16:44:50.068Z",
    "updatedAt": "2023-06-19T16:44:50.068Z",
    "name": "Campos de prueba 3",
    "description": "Es una campo agregado a la metadata",
    "type": "text",
    "mandatory": true,
    "deleted": false
  },
  {
    "id": "6c6fad6d-ec4d-4051-93c6-71ff2d9f3535",
    "createdAt": "2023-06-19T16:45:43.450Z",
    "updatedAt": "2023-06-19T16:45:43.450Z",
    "name": "Campos de prueba 3",
    "description": "Es una campo agregado a la metadata",
    "type": "text",
    "mandatory": true,
    "deleted": false
  }
]

Este endpoint permite obtener los metadatos creados en un workspace.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del producto seleccionado.

Obtener metadata especifica.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas/<ID>' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'content-type: application/json' \

{
    "id": "6c6fad6d-ec4d-4051-93c6-71ff2d9f3535",
    "createdAt": "2023-06-19T16:45:43.450Z",
    "updatedAt": "2023-06-19T16:45:43.450Z",
    "name": "Campos de prueba 3",
    "description": "Es una campo agregado a la metadata",
    "type": "text",
    "mandatory": true,
    "deleted": false
  }

Este endpoint permite obtener un metadato a partir de su ID en el workspace especificado.

HTTP Request

GET https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del producto seleccionado.
ID	Representa el ID del metadato.

Editar metadata.

curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas/<ID>' \
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  --request PATCH
  -H 'content-type: application/json'
  --data '{
    "name": "Campos de prueba 3",
    "description": "Es una campo agregado a la metadata",
    "type": "text",
    "mandatory": true
  }'

{
  "id": "45bda052-c366-4235-bd6f-f5d92ae94c6d",
  "createdAt": "2023-06-19T16:36:03.893Z",
  "updatedAt": "2023-06-19T16:36:03.893Z",
  "name": "Campo de prueba 3",
  "description": "Es una campo agregado a la metadata",
  "type": "text",
  "mandatory": true,
  "deleted": false
}

Este endpoint permite editar un metadato previamente creado en el workspace, a partir de su ID.

HTTP Request

PATCH https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.
ID	Representa el ID del metadato.

Payload

Propiedad	Obligatorio	Tipo	Descripción
name	false	string	Especifica el nombre del metadato.
description	false	string	Especifica una descripción para el metadato a modo de ayuda
type	false	string	Es el tipo de campo (text, number, email, select, checkbox).
mandatory	false	boolean	Determina si el campo es oblogatorio en las wallet.

Eliminar metadata.

  curl 'https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas/<ID>' \
  --request DELETE
  -H "X-API-Key: <DUCK-API-KEY>" \
  -H "X-Secret: <DUCK-SECRET>" \
  -H 'Content-Type: application/json'

Status Code: 204

Elimina e inhabilita un campo de metadata desde el workspace indicado. El campo se elimina de forma logica, por lo que estara disponible en caso de que las wallets ya hallan cargados campos previamente en esta metadata.

HTTP Request

DELETE https://api.kutamma.com/v1/tenants/<TENANT>/workspaces/<WORKSPACE>/metadatas/<ID>

URL Parameters

Parametro	Descripción
TENANT	Representa el ID de la cuenta en la cual se desean efecuar transacciones.
WORKSPACE	Representa el ID del espacio seleccionado.
ID	Representa el ID del campo de metadata

Errors

This error section is stored in a separate file in includes/_errors.md. Slate allows you to optionally separate out your docs into many files...just save them to the includes folder and add them to the top of your index.md's frontmatter. Files are included in the order listed.

The Kittn API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The kitten requested is hidden for administrators only.
404	Not Found -- The specified kitten could not be found.
405	Method Not Allowed -- You tried to access a kitten with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The kitten requested has been removed from our servers.
418	I'm a teapot.
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.