Paquetes

Base URL: https://integracionapi.finalitix.com

Un paquete agrupa un conjunto de transacciones SPEI que se autorizan y procesan juntas.

Crear paquete

POST /service/v1/batch/

Body (JSON):

Campo	Tipo	Requerido	Descripción
`nombre`	`string`	Sí	Nombre descriptivo del paquete
`cantidad_operaciones`	`integer`	No	Número estimado de operaciones

Ejemplo con cURL:

curl -X POST https://integracionapi.finalitix.com/service/v1/batch/ \
  -H "x-api-key: TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nombre": "Nómina Enero",
    "cantidad_operaciones": 25
  }'

Ejemplo con Node.js (axios):

const axios = require("axios");

const { data } = await axios({
  method: "post",
  url: "https://integracionapi.finalitix.com/service/v1/batch/",
  headers: {
    "x-api-key": "TU_API_KEY",
    "Content-Type": "application/json",
  },
  data: JSON.stringify({
    nombre: "Nómina Enero",
    cantidad_operaciones: 25,
  }),
});

Respuesta exitosa 200:

{
  "success": true,
  "message": "Paquete creado correctamente",
  "result": {
    "name": "Nómina Enero",
    "paquete_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Respuesta de error 400:

{
  "success": false,
  "message": "El campo 'nombre' es requerido."
}

Editar paquete

PUT /service/v1/batch/

Body (JSON):

Campo	Tipo	Requerido	Descripción
`paquete_id`	`string (UUID)`	Sí	ID del paquete a editar
`cantidad_operaciones`	`integer`	Sí	Nuevo número de operaciones

Ejemplo con cURL:

curl -X PUT https://integracionapi.finalitix.com/service/v1/batch/ \
  -H "x-api-key: TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "paquete_id": "550e8400-e29b-41d4-a716-446655440000",
    "cantidad_operaciones": 30
  }'

Ejemplo con Node.js (axios):

const { data } = await axios({
  method: "put",
  url: "https://integracionapi.finalitix.com/service/v1/batch/",
  headers: {
    "x-api-key": "TU_API_KEY",
    "Content-Type": "application/json",
  },
  data: JSON.stringify({
    paquete_id: "550e8400-e29b-41d4-a716-446655440000",
    cantidad_operaciones: 30,
  }),
});

Respuesta exitosa 200:

{
  "success": true,
  "message": "Paquete actualizado correctamente",
  "result": {
    "paquete_id": "550e8400-e29b-41d4-a716-446655440000",
    "cantidad_operaciones": 30
  }
}

Eliminar paquete

DELETE /service/v1/batch/delete-package

Body (JSON):

Campo	Tipo	Requerido	Descripción
`paquete_id`	`string (UUID)`	Sí	ID del paquete a eliminar

Ejemplo con cURL:

curl -X DELETE https://integracionapi.finalitix.com/service/v1/batch/delete-package \
  -H "x-api-key: TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "paquete_id": "550e8400-e29b-41d4-a716-446655440000"
  }'

Ejemplo con Node.js (axios):

const { data } = await axios({
  method: "delete",
  url: "https://integracionapi.finalitix.com/service/v1/batch/delete-package",
  headers: {
    "x-api-key": "TU_API_KEY",
    "Content-Type": "application/json",
  },
  data: JSON.stringify({
    paquete_id: "550e8400-e29b-41d4-a716-446655440000",
  }),
});

Respuesta exitosa 200:

{
  "success": true,
  "message": "Paquete eliminado correctamente"
}