Referencia de la APIComplementos de pago
Descargar archivos
Obtiene la URL de descarga del PDF, XML o ZIP de un complemento de pago.
Descripción general
Este endpoint devuelve una URL de descarga temporal para un archivo de un complemento de pago, real o de prueba. La URL vence a las 24 horas (expires_in_seconds: 86400) y descarga el archivo con el nombre <complementId>.<fileType>.
Para complementos canceled, pdf y xml devuelven el acuse de cancelación si está disponible y, si no, el archivo original. zip siempre devuelve el archivo original.
Requiere el permiso Leer en Pagos.
Endpoint
GET
https://app.credonix.mx/api/v1/payments/{paymentId}/complements/{complementId}/files/{fileType}Path params:
paymentId— el ID del pago.complementId— el ID del complemento de pago.fileType—pdf,xmlozip.
Descarga el PDF
Sin cuerpo. Descarga el archivo desde download_url antes de que venza.
Campos de la respuesta
| Campo | Tipo | Descripcion |
|---|---|---|
download_url | string | URL firmada para descargar el archivo. |
expires_in_seconds | integer | Segundos de vigencia de la URL. Siempre 86400. |
Tipo de archivo inválido
Un fileType distinto de pdf, xml o zip responde 404 con NOT_FOUND. Esta validación ocurre antes de buscar el pago y el complemento.
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 tipo de archivo debe ser pdf, xml o zip." — fileType inválido. |
404 | NOT_FOUND | "El pago no fue encontrado." — el pago no existe en tu organización. |
404 | NOT_FOUND | "Complemento de pago no encontrado." — el complemento no pertenece al pago. |
404 | NOT_FOUND | "El archivo del complemento de pago no está disponible." — el archivo no está guardado. |