Register payment
POST
https://api.gigstack.io/v2/payments/register
team parameter.Automation Types
pue_invoice: Creates a PUE (Pago en Una sola Exhibición) invoice immediatelynone: No automation, registers payment onlyPPD Invoice Linking
ppd_invoice_id field.When set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice.
The referenced invoice must have
payment_method='PPD' and status='valid'.Payment Form
payment_form field specifies the Mexican SAT payment form code:01 (cash), 02 (check), 03 (electronic transfer), 04 (credit card), etc.Required fields
client, currency, items (at least one), payment_form and automation_typeare required.
automation_type has no default — omitting it fails validation.Allowed values:
pue_invoice, ppd_invoice_and_complement, none.date
Luxon.now().toMillis(); a future value returns 400.transfer_data — all-or-nothing
transfer_data is optional, but when it is present all four of master, connect,master_to and connect_to are required; omitting any one fails validation.| field | type | constraint |
|---|---|---|
master | number | required, 0 ≤ master ≤ 100 (percentage retained by the master team) |
connect | string | required, non-empty — RFC of the connected team |
master_to | enum | required — client or connect |
connect_to | enum | required — client or master |
connect_custom_config | object | optional; every field inside it is optional except type, rate and withholding on each taxes[] entry |
invoice_config
| field | type | meaning |
|---|---|---|
serie | string | invoice series |
folio | number | invoice folio number |
date | number | invoice issue date, Unix epoch milliseconds |
global.year | number | fiscal year of the global (EOM) invoice, e.g. 2026 |
global.months | string | SAT c_Meses code, e.g. 01 for January or 13 for Jan–Feb |
global.periodicity | string | SAT c_Periodicidad code — 01 daily, 02 weekly, 03 fortnightly, 04 monthly, 05 bimonthly |
validUntil | number | expiry of the self-invoicing window, Unix epoch milliseconds |
Email suppression
ignore_emails: true suppresses notification emails. On this endpoint send_email isaccepted but has no effect — only
ignore_emails is persisted onto the payment.Unknown fields
400 validation_failed / unexpected_key.Request
Query Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.gigstack.io/v2/payments/register?team=undefined' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"client": {
"id": "client_1234567890"
},
"automation_type": "pue_invoice",
"currency": "MXN",
"exchange_rate": 1,
"payment_form": "03",
"items": [
{
"id": "service_1234567890",
"quantity": 1,
"unit_price": 1000
}
]
}'Response Response Example
201 - Standard payment response
{
"success": true,
"message": "Payment registered successfully",
"timestamp": 1767225600000,
"data": {
"id": "payment_1234567890",
"client": {
"id": "client_1234567890",
"name": "Juan Pérez García",
"email": "juan.perez@ejemplo.com",
"tax_id": "PEGJ800101ABC"
},
"status": "succeeded",
"currency": "MXN",
"exchange_rate": 1,
"payment_form": "03",
"total": 1160,
"subtotal": 1000,
"taxes": 160,
"discount": 0,
"items": [
{
"id": "service_1234567890",
"description": "Professional consulting services",
"quantity": 1,
"unit_price": 1000,
"product_key": "80141503",
"unit_key": "E48"
}
],
"invoices": [
"B0C3E4F2-1A2B-4C5D-9E8F-0123456789AB"
],
"created_at": 1677651234,
"succeeded_at": 1677651234,
"payment_processor": "api",
"livemode": true,
"team": "team_1234567890",
"owner": "user_1234567890"
}
}Modified at 2026-09-08 19:42:08