CredonixDocs
Abrir Credonix
Referencia de la APISaldo a favor

Reembolsar

Registra un reembolso que descuenta saldo a favor de un cliente.

Descripción general

Este endpoint registra un reembolso de saldo a favor: crea un movimiento refundAdjustment con monto negativo que descuenta el saldo del cliente en la moneda indicada. Solo registra el movimiento de saldo: no crea pagos ni CFDI.

El monto no puede superar el saldo a favor disponible en esa moneda, y notes es obligatorio para indicar el motivo o la referencia de la devolución. Una solicitud exitosa devuelve 201 con el movimiento creado. Para deshacer un reembolso, usa Revertir movimiento de saldo.

Requiere el permiso Administrar en Pagos.

Endpoint

POSThttps://app.credonix.mx/api/v1/customers/{customerId}/credit/refunds

Path param: customerId — ID del cliente.

Registra un reembolso

Descuenta 100.00 del saldo a favor en MXN del cliente. El movimiento responde con amount negativo.

{
  "currency": "MXN",
  "amount": "100",
  "notes": "Devolución por transferencia SPEI"
}

Reglas de los campos

CampoTipoRequeridoNotas
currencystringSíMXN o USD. Moneda del saldo a favor que se descuenta.
amountstringSíMayor a cero, máximo 2 decimales, por ejemplo "1234.50". No puede superar el saldo a favor disponible en currency.
notesstringSíMotivo o referencia de la devolución. Al menos un carácter.

Campos de la respuesta

Devuelve el movimiento creado con type: "refundAdjustment" y amount negativo. Los campos se describen en Listar movimientos de saldo.

Errores

400 — validación fallida

{
  "code": "VALIDATION_ERROR",
  "message": "La petición contiene datos inválidos. Revisa errors para ver el detalle de cada campo.",
  "errors": [
    {
      "field": "notes",
      "code": "invalid_type",
      "message": "Entrada inválida: se esperaba texto, recibido indefinido"
    }
  ],
  "request_id": "057e11c7-2965-49c8-babc-f36e1dda2cd4"
}
StatusCódigoCausa
400VALIDATION_ERRORCuerpo inválido: notes faltante o vacío, amount en cero o con más de 2 decimales, o campo desconocido.
401—API key ausente, inválida o revocada.
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Administrar en Pagos.
404CUSTOMER_NOT_FOUNDEl cliente no existe o no pertenece a la organización.
409INSUFFICIENT_CREDITEl monto a devolver excede el saldo a favor disponible.
Registrar anticipo POST
Página anterior
Revertir movimiento de saldo POST
Página siguiente
Abrir Credonix