Ir al contenido

Transacciones

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

Una transacción (operación) representa una transferencia SPEI individual dentro de un paquete.


POST /service/v1/batch/add-operation

Body (JSON):

CampoTipoRequeridoDescripción
nombre_beneficiariostringNombre completo del beneficiario
clabestringCLABE interbancaria (18 dígitos)
importenumberMonto a transferir (MXN)
paquete_idstring (UUID)ID del paquete al que pertenece
descripcionstringDescripción de de la transacción

Ejemplo con cURL:

Ventana de terminal
curl -X POST https://integracionapi.finalitix.com/service/v1/batch/add-operation \
-H "x-api-key: TU_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"nombre_beneficiario": "Juan García López",
"clabe": "012345678901234567",
"importe": 5000.00,
"paquete_id": "550e8400-e29b-41d4-a716-446655440000"
"descripcion": "Pago para Juan"
}'

Ejemplo con Node.js (axios):

const axios = require("axios");
const { data } = await axios({
method: "post",
url: "https://integracionapi.finalitix.com/service/v1/batch/add-operation",
headers: {
"x-api-key": "TU_API_KEY",
"Content-Type": "application/json",
},
data: JSON.stringify({
nombre_beneficiario: "Juan García López",
clabe: "012345678901234567",
importe: 5000.0,
paquete_id: "550e8400-e29b-41d4-a716-446655440000",
descripcion: "Pago para Juan",
}),
});

Respuesta exitosa 200:

{
"success": true,
"message": "Operación agregada correctamente",
"result": {
"paquete_id": "550e8400-e29b-41d4-a716-446655440000",
"operacion_id": "op_abc123",
"transaction_estatus": "draft"
}
}

Respuesta de error 400:

{
"success": false,
"message": "La CLABE debe tener exactamente 18 dígitos."
}

POST /service/v1/batch/edit-operation

Body (JSON):

CampoTipoRequeridoDescripción
operacion_idstringID de la operación a editar
importenumberNuevo monto a transferir (MXN)
paquete_idstring (UUID)ID del paquete al que pertenece

Ejemplo con cURL:

Ventana de terminal
curl -X POST https://integracionapi.finalitix.com/service/v1/batch/edit-operation \
-H "x-api-key: TU_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operacion_id": "op_abc123",
"importe": 6500.00,
"paquete_id": "550e8400-e29b-41d4-a716-446655440000"
}'

Ejemplo con Node.js (axios):

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

Respuesta exitosa 200:

{
"success": true,
"message": "Operación actualizada correctamente",
"result": {
"paquete_id": "550e8400-e29b-41d4-a716-446655440000",
"operacion_id": "op_abc123",
"updated": true
}
}

POST /service/v1/batch/delete-operation

Body (JSON):

CampoTipoRequeridoDescripción
operacion_idstringID de la operación a eliminar
paquete_idstring (UUID)ID del paquete al que pertenece

Ejemplo con cURL:

Ventana de terminal
curl -X POST https://integracionapi.finalitix.com/service/v1/batch/delete-operation \
-H "x-api-key: TU_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operacion_id": "op_abc123",
"paquete_id": "550e8400-e29b-41d4-a716-446655440000"
}'

Ejemplo con Node.js (axios):

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

Respuesta exitosa 200:

{
"success": true,
"message": "Operación eliminada correctamente",
"result": {
"paquete_id": "550e8400-e29b-41d4-a716-446655440000",
"operacion_id": "op_abc123",
"deleted": true
}
}

POST /service/v1/batch/list-operations

Body (JSON):

CampoTipoRequeridoDescripción
paquete_idstring (UUID)ID del paquete

Ejemplo con cURL:

Ventana de terminal
curl -X POST https://integracionapi.finalitix.com/service/v1/batch/list-operations \
-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: "post",
url: "https://integracionapi.finalitix.com/service/v1/batch/list-operations",
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": "Operaciones obtenidas correctamente",
"result": {
"paquete_id": "550e8400-e29b-41d4-a716-446655440000",
"operations": [
{
"operacion_id": "op_abc123",
"nombre_beneficiario": "Juan García López",
"clabe": "012345678901234567",
"importe": 5000.0
},
{
"operacion_id": "op_def456",
"nombre_beneficiario": "María Martínez",
"clabe": "098765432109876543",
"importe": 3200.0
}
]
}
}