Skip to main content
POST
Create payment complement (complemento de pago)

Authorizations

Authorization
string
header
required

Authentication Method: HTTP Bearer token.

The runtime requires the literal Bearer prefix — a bare token in the Authorization header is rejected with 401 unauthorized.

Header Format: Authorization: Bearer YOUR_API_KEY

Your API key is a JWT. Live keys operate on live data (livemode: true); test keys operate on isolated test data (livemode: false).

Get your key at: app.gigstack.pro/settings?tab=api

Errors: credential failures are answered by the authentication layer with a raw { "message": … } body, not the standardized envelope — 401 for a missing, malformed or expired token, 403 for a revoked key or a plan without API access. See the Unauthorized and AuthForbidden responses.

Query Parameters

team
string

gigstack Connect: Target team ID for multi-team access.

Requires gigstack Connect enabled on your team and shared billing account.

Also requires the multipleIssuerAccounts feature on your plan. Requests targeting a team other than the one your API key belongs to return 403 without it.

Only API keys can use it: an OAuth access token sent with another team's id is rejected with 403 Team mismatch with OAuth token.

Optional — omit it entirely unless you are acting on another team. It deliberately carries no example value so generated snippets do not emit ?team=undefined; when the parameter is absent, the team is derived from your API key.

Example: ?team=team_xyz789

Body

application/json
client
object
required
complements
object[]
required

Payment complement groups. Normally a single entry with type 'payment'.

Minimum array length: 1
date
number

Comprobante date in epoch milliseconds. Defaults to now.

Example:

1784915988000

return_files
boolean

When true, includes base64 XML + PDF in the response.

currency
string
exchange_rate
number
folio_number
number

Optional custom folio. When set, stamps with that exact folio.

series
string

Override the series. Defaults to the team's payments series (invoice_serie_payments).

idempotency_key
string | null
use
string
exports
enum<string> | null
Available options:
01,
02,
03,
04,
null

Optional CFDI relations (CfdiRelacionados) at the comprobante level.

invoice_pdf_notes
string
addenda
string | null
send_email
boolean
ignore_emails
boolean | null
emails
string<email>[]
metadata
object

Response

Payment complement created successfully

message
string
Example:

"Payment complement created"

data
object