S-Interio Payout API

La API de Payouts te permite crear y gestionar pagos programáticamente. Soporta múltiples monedas y métodos de pago en Latinoamérica.

Segura

Autenticación via API Key con HTTPS obligatorio

Multi-región

Colombia, Argentina, México, Costa Rica y Brasil

Simple

REST API con respuestas JSON claras

Base URL

https://dashboard-payouts.s-interio.com/api/v1

Autenticación

Todas las llamadas a la API requieren autenticación mediante una API Key. Puedes obtener tu API Key desde el panel de administración en la sección de Merchants.

Métodos de Autenticación

Puedes enviar tu API Key de dos formas:

Header X-API-Key (Recomendado)

X-API-Key: pk_live_xxxxxxxxxxxxxxxx

Header Authorization

Authorization: Bearer pk_live_xxxxxxxxxxxxxxxx
Importante: Mantén tu API Key segura. No la compartas ni la incluyas en código del lado del cliente.

Manejo de Errores

La API utiliza códigos de estado HTTP estándar para indicar el resultado de las solicitudes.

Código Descripción
200 Solicitud exitosa
201 Recurso creado exitosamente
400 Error de validación - revisa los parámetros enviados
401 API Key inválida o no proporcionada
403 No autorizado para acceder al recurso
404 Recurso no encontrado
500 Error interno del servidor

Formato de Error

Respuesta de Error 
{
  "success": false,
  "error": "Descripción del error"
}
POST

Crear Payout

Crea una nueva solicitud de payout.

POST /api/v1/payouts

Parámetros del Body

Parámetro Tipo Requerido Descripción
amount number Sí Monto a pagar (debe ser mayor a 0)
currency string Sí Código de moneda: COP, ARS, MXN, CRC, BRL
reference string No Referencia externa (ej: order-123)
bankDetails object Sí Datos bancarios del beneficiario

Ejemplo - Colombia (COP)

Request 
curl -X POST https://dashboard-payouts.s-interio.com/api/v1/payouts \
  -H "X-API-Key: pk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 500000,
    "currency": "COP",
    "reference": "order-12345",
    "bankDetails": {
      "firstName": "Juan",
      "lastName": "Pérez",
      "email": "juan@email.com",
      "idType": "cc",
      "idNumber": "1234567890",
      "bankName": "Bancolombia",
      "accountType": "savings",
      "accountNumber": "12345678901"
    }
  }'

Ejemplo - Argentina (ARS)

Request 
curl -X POST https://dashboard-payouts.s-interio.com/api/v1/payouts \
  -H "X-API-Key: pk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 50000,
    "currency": "ARS",
    "reference": "order-12345",
    "bankDetails": {
      "firstName": "María",
      "lastName": "González",
      "cvuCbu": "0000003100000000000001",
      "cuitCuil": "20-12345678-9"
    }
  }'

Ejemplo - México (MXN)

Request 
curl -X POST https://dashboard-payouts.s-interio.com/api/v1/payouts \
  -H "X-API-Key: pk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 10000,
    "currency": "MXN",
    "reference": "order-12345",
    "bankDetails": {
      "firstName": "Carlos",
      "lastName": "Rodríguez",
      "idNumber": "RODC850101HDFRRL09",
      "bankName": "BBVA",
      "accountType": "checking",
      "accountNumber": "012345678901234567"
    }
  }'

Ejemplo - Costa Rica (CRC)

Request 
curl -X POST https://dashboard-payouts.s-interio.com/api/v1/payouts \
  -H "X-API-Key: pk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100000,
    "currency": "CRC",
    "reference": "order-12345",
    "bankDetails": {
      "firstName": "Ana",
      "lastName": "Mora",
      "cedula": "123456789",
      "iban": "CR12345678901234567890",
      "bankName": "Banco Nacional",
      "accountType": "savings"
    }
  }'

Ejemplo - Brasil (BRL) - Solo PIX

Request 
curl -X POST https://dashboard-payouts.s-interio.com/api/v1/payouts \
  -H "X-API-Key: pk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1000,
    "currency": "BRL",
    "reference": "order-12345",
    "bankDetails": {
      "firstName": "Pedro",
      "lastName": "Silva",
      "cpf": "123.456.789-00",
      "pixKeyType": "email",
      "pixKey": "pedro@email.com"
    }
  }'

Respuesta Exitosa

Response - 201 Created 
{
  "success": true,
  "data": {
    "payoutId": "abc123xyz",
    "status": "pending",
    "amount": 500000,
    "currency": "COP",
    "reference": "order-12345",
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}
GET

Listar Payouts

Obtiene la lista de payouts creados por tu merchant.

GET /api/v1/payouts

Parámetros de Query

Parámetro Tipo Default Descripción
status string - Filtrar por estado: pending, approved, completed, rejected
reference string - Filtrar por referencia externa
limit number 50 Número máximo de resultados (máx: 100)

Ejemplo

Request 
curl -X GET "https://dashboard-payouts.s-interio.com/api/v1/payouts?status=pending&limit=10" \
  -H "X-API-Key: pk_live_xxxxxxxx"

Respuesta

Response - 200 OK 
{
  "success": true,
  "data": [
    {
      "payoutId": "abc123xyz",
      "status": "pending",
      "amount": 500000,
      "currency": "COP",
      "reference": "order-12345",
      "beneficiary": {
        "firstName": "Juan",
        "lastName": "Pérez"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "processedAt": null
    }
  ],
  "count": 1
}
GET

Obtener Payout

Obtiene los detalles de un payout específico.

GET /api/v1/payouts/{payoutId}

Parámetros de URL

Parámetro Tipo Descripción
payoutId string ID del payout a consultar

Ejemplo

Request 
curl -X GET https://dashboard-payouts.s-interio.com/api/v1/payouts/abc123xyz \
  -H "X-API-Key: pk_live_xxxxxxxx"

Respuesta

Response - 200 OK 
{
  "success": true,
  "data": {
    "payoutId": "abc123xyz",
    "status": "completed",
    "amount": 500000,
    "currency": "COP",
    "reference": "order-12345",
    "beneficiary": {
      "firstName": "Juan",
      "lastName": "Pérez"
    },
    "bankDetails": {
      "bankName": "Bancolombia",
      "accountType": "savings",
      "accountNumberLast4": "8901"
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T12:00:00.000Z",
    "processedAt": "2024-01-15T12:00:00.000Z"
  }
}

Monedas Soportadas

Código País Moneda Método de Pago
COP Colombia Peso Colombiano Transferencia bancaria
ARS Argentina Peso Argentino CVU/CBU
MXN México Peso Mexicano Transferencia bancaria
CRC Costa Rica Colón Costarricense IBAN
BRL Brasil Real Brasileño PIX

Estados del Payout

Estado Descripción
pending El payout ha sido creado y está pendiente de revisión
approved El payout ha sido aprobado y está siendo procesado
completed El payout ha sido completado y el dinero transferido
rejected El payout ha sido rechazado

Datos Bancarios por País

Colombia (COP)

Campo Tipo Requerido Descripción
firstName string Sí Nombre del beneficiario
lastName string Sí Apellido del beneficiario
idType string Sí Tipo de documento: cc, ce, nit, passport, ti
idNumber string Sí Número de documento
bankName string Sí Nombre del banco
accountType string Sí Tipo de cuenta: savings, checking
accountNumber string Sí Número de cuenta bancaria
email string No Email del beneficiario

Argentina (ARS)

Campo Tipo Requerido Descripción
firstName string Sí Nombre del beneficiario
lastName string Sí Apellido del beneficiario
cvuCbu string Sí CVU o CBU (22 dígitos)
cuitCuil string Sí CUIT o CUIL

México (MXN)

Campo Tipo Requerido Descripción
firstName string Sí Nombre del beneficiario
lastName string Sí Apellido del beneficiario
idNumber string Sí CURP o RFC
bankName string Sí Nombre del banco
accountType string Sí Tipo de cuenta: savings, checking
accountNumber string Sí CLABE interbancaria (18 dígitos)

Costa Rica (CRC)

Campo Tipo Requerido Descripción
firstName string Sí Nombre del beneficiario
lastName string Sí Apellido del beneficiario
cedula string Sí Número de cédula
iban string Sí IBAN costarricense
bankName string Sí Nombre del banco
accountType string Sí Tipo de cuenta: savings, checking

Brasil (BRL) - Solo PIX

Campo Tipo Requerido Descripción
firstName string Sí Nombre del beneficiario
lastName string Sí Apellido del beneficiario
cpf string Sí CPF del beneficiario
pixKeyType string Sí Tipo de clave PIX: cpf, email, phone, random
pixKey string Sí Clave PIX