Skip to main content
POST
Request a massive download

Authorizations

Authorization
string
header
required

API key: Authorization: Bearer sk_test_... or sk_live_....

Headers

Invoice-Version
string

Pin a dated API release (Stripe-style). Omit to use the current version. An unknown value returns 400 request.invalid_version. Echoed back on every response.

Example:

"2026-07-10"

Invoice-Account
string

Connect: act on behalf of one of your connected accounts (its acct_…/org_… id). Omit to act as your own organization. Not honored on /v1/api_keys.

Example:

"org_2P9connectedacct"

Idempotency-Key
string

Safely retry any POST. The first response is stored for 24h and replayed byte-for-byte for identical retries (the replay adds an idempotent-replayed: true header). Reusing the key with a different body is 409 idempotency.key_reuse; an in-flight duplicate is 409 idempotency.key_processing. This makes retrying a 502/429 safe — no duplicate stamp.

Example:

"a1b2c3d4-e5f6-4789-8abc-1234567890ab"

Body

application/json
fiscal_profile_id
string
required

Id of the fiscal profile whose FIEL authorizes the download, e.g. "fp_2P9K3sample".

Minimum string length: 1
side
enum<string>
required

Which CFDIs to pull: "issued" (emitidos by this RFC) or "received" (recibidos).

Available options:
issued,
received
type
enum<string>
required

Package contents: "cfdi" (full XML files) or "metadata" (a summary index only).

Available options:
cfdi,
metadata
date_from
string
required

Start of the range, ISO date (YYYY-MM-DD) or datetime; a bare date covers from 00:00:00.

date_to
string
required

End of the range, ISO date (YYYY-MM-DD) or datetime; a bare date covers to 23:59:59.

status_filter
enum<string>

Advisory SAT estatus filter: "active" (vigentes) or "cancelled" (cancelados). Metadata-only per Prodigia.

Available options:
active,
cancelled

Response

Default Response

object
enum<string>
required

Always "download".

Available options:
download
id
string
required

Download id, e.g. "dl_2P9K3sample".

fiscal_profile_id
string
required

Id of the fiscal profile whose FIEL authorized this download.

livemode
boolean
required

True if created with a live-mode key.

side
enum<string>
required

"issued" (emitidos) or "received" (recibidos).

Available options:
issued,
received
type
enum<string>
required

"cfdi" (full XML) or "metadata" (summary index).

Available options:
cfdi,
metadata
date_from
string
required

Start of the requested range (SAT format yyyy-MM-ddTHH:mm:ss).

date_to
string
required

End of the requested range (SAT format yyyy-MM-ddTHH:mm:ss).

status
enum<string>
required

Lifecycle status: "requested", "processing", "ready" (packages available), "no_data", or "failed".

Available options:
requested,
processing,
ready,
no_data,
failed
sat_request_id
string | null
required

SAT solicitud id (IdSolicitud), or null until registered.

package_count
integer
required

Number of downloadable packages once ready.

Required range: -9007199254740991 <= x <= 9007199254740991
error
any | null
required

Failure detail (problem+json shape) when status is "failed", else null.

created_at
string
required

Creation timestamp, ISO-8601 UTC.

updated_at
string
required

Last-update timestamp, ISO-8601 UTC.

metadata
object
required

Request-time advisory metadata.