Vista previa de un complemento de pago en PDF
POSThttps://api.cfdi.express/v1/payments/preview/pdfAPI key
Desde la v1.54.0, la vista previa del complemento de pago en PDF: plantilla del REP timbrado, marca de agua PREVIEW y sin UUID, sellos ni QR. No timbra ni cobra.
Mismo cuerpo y mismas validaciones que POST /v1/payments/preview.
Con delivery=file (el default) responde el PDF con Content-Type: application/pdf, Cache-Control: no-store y Content-Disposition: attachment. El archivo se llama Vista previa complemento de pago CP {folio}.pdf, por ejemplo Vista previa complemento de pago CP 55.pdf.
Con delivery=url sube el PDF y responde JSON con una liga firmada que vence en 15 minutos. Es el único caso en que se guarda algo: el PDF temporal de la liga.
Autenticación
Authorization: Bearer sk_test_... | sk_live_...El header x-account-id indica la cuenta. Si no eres miembro, la respuesta es 403.
Parámetros
Query string
| Campo | Tipo | Descripción |
|---|---|---|
| delivery | string | file (default): el PDF. url: JSON con una liga temporal de descarga. |
Ejemplos
cURL — guardar el PDF
curl -X POST "https://api.cfdi.express/v1/payments/preview/pdf" \
-H "Authorization: Bearer sk_test_..." \
-H "Content-Type: application/json" \
-d @pago.json \
-o "vista-previa-rep.pdf"Respuesta
200 OK (delivery=url)
{
"object": "payment_preview_pdf",
"filename": "Vista previa complemento de pago CP 55.pdf",
"url": "https://files.cfdi.express/previews/...pdf?X-Amz-Expires=900&...",
"expiresAt": "2026-11-18T18:20:00.000Z"
}Errores
| Status | code | Cuándo aparece |
|---|---|---|
| 400 | validation_error | El mismo cuerpo lo rechazaría POST /v1/payments (o la factura no tiene el CFDI guardado), o delivery no es file ni url. |
| 401 | unauthorized | Falta el header Authorization o la llave es inválida. |
| 403 | forbidden | No eres miembro de la cuenta del header x-account-id. |
| 404 | not_found | Alguna factura de documents no existe en tu cuenta. |
| 429 | rate_limited | Excediste el límite de requests por minuto de tu cuenta (300 por default). La respuesta incluye Retry-After. |
| 503 | pdf_unavailable | El generador de PDF no está disponible, o el almacenamiento no está disponible con delivery=url (usa delivery=file). Reintenta en unos momentos. |
Notas
- El PDF lleva la leyenda «VISTA PREVIA — SIN VALIDEZ FISCAL» y la marca de agua PREVIEW en cada página. En lugar del UUID dice «Se asigna al timbrar».
- Por MCP es la herramienta
download_payment_preview_pdf, que solo puede llamar la tarjeta de vista previa (botón «Descargar PDF»), no el modelo.
