Referencia de la APIComplementos de pago
Listar
Obtiene los complementos de pago de un pago.
Descripción general
Este endpoint devuelve todos los complementos de pago de un pago: reales y de prueba, en cualquier estatus, ordenados por created_at descendente. Los complementos de prueba llegan con "test": true.
La respuesta no está paginada: results trae todos los complementos del pago.
Requiere el permiso Leer en Pagos.
Endpoint
GET
https://app.credonix.mx/api/v1/payments/{paymentId}/complementsPath param: paymentId — el ID del pago.
Consulta los complementos de un pago
Sin cuerpo. En este ejemplo el pago tiene un complemento de prueba emitido al registrar el pago.
Campos de la respuesta
| Campo | Tipo | Descripcion |
|---|---|---|
id | string | ID del complemento de pago. |
payment_id | string | Pago al que pertenece. |
test | boolean | true para complementos de prueba, sin validez fiscal. |
uuid | string | UUID fiscal del complemento. |
status | string | pending, emitted, canceled, not_required o rejected. |
payment_form | string | Clave SAT de la forma de pago. |
issue_date | string | Fecha de emisión del complemento. |
currency | MXN | USD | Moneda del CFDI relacionado. |
verification_url | string | URL de verificación del SAT. |
created_at | string (fecha) | Momento de creación. |
updated_at | string (fecha) | Última actualización. |
Errores
| Status | Código | Causa |
|---|---|---|
401 | MISSING_API_KEY | INVALID_API_KEY | API_KEY_REVOKED | API key ausente, inválida o revocada. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Leer en Pagos. |
404 | NOT_FOUND | El pago no existe en tu organización. |