webhook-debt-creation

Creación de deuda

Configura este endpoint para recibir notificaciones cuando se creen deudas. Incluye los tipos: CURRENT_CYCLE_CHARGES, REVOLVING, MANDATORY_REFINANCING y MANUAL_REFINANCING.

El contenido del payload depende del tipo de deuda: las deudas financiadas incluyen cuotas, tasas y composición; las de ciclo actual solo incluyen montos y fechas.

Configura tu endpoint en:

POST https://<tu-servidor>/debts

Si tienes dudas sobre cómo configurar un webhook, visita nuestra documentación.

Deberás respondernos un código HTTP 2xx para que no volvamos a enviar la notificación. Caso contrario, volveremos a enviarla infinitamente.

Parámetros disponibles

Header Parameters
X-Api-KeyString
X-SignatureString
X-TimestampString
X-EndpointString
Cuerpo de solicitud
application/json
event_idenum
idempotency_keystring
typeenum
idstring
versioninteger
payloadstring

Detalle de respuestas

2XX
Respuesta exitosa por parte del cliente.
4XX
Falló la respuesta. Volveremos a enviar el evento.
5XX
Falló la respuesta. Volveremos a enviar el evento.
Ejemplo de solicitud
{
  "event_id": "debt_registry",
  "idempotency_key": "CREATE_DEBT#debt-123#2025-06-15T10:30:00Z",
  "type": "CURRENT_CYCLE_CHARGES",
  "id": "debt-123",
  "version": 1,
  "payload": {
    "credit_line_id": "lcr-1yXQd6z6pQK6Q2wtYLJlxZanALc",
    "debt_state": "CREATED",
    "user": {
      "id": "usr-2zuyx57RAwtS1uxPkpqDKT9MSlA",
      "name": "Xavier",
      "surname": "Eldridge",
      "identification_type": "RG",
      "identification_value": "30381645185",
      "tax_identification_type": "CPF",
      "tax_identification_value": "75892533166",
      "tax_condition": "",
      "nationality": "BRA",
      "gender": "MALE",
      "legal_address": {
        "street_name": "Demo user",
        "street_number": "118",
        "neighborhood": "Jardim Vista Linda",
        "city": "São Paulo",
        "region": "SP",
        "zip_code": "05159-140",
        "additional_info": ""
      }
    },
    "total_amount": "10000.00",
    "issue_date": "2025-06-15",
    "due_date": "2025-06-20"
  }
}

Pomelo AI

Asistente de inteligencia artificial para consultas sobre la API de Pomelo
¡Hola!¿Cómo puedo ayudarte hoy?
Creación de deuda | Pomelo API Reference