Register payment

POST

https://api.gigstack.io/v2/payments/register

gigstack Connect: Register payments for other teams using the team parameter.

Automation Types

Control what happens automatically when registering a payment:

payment: Creates a PUE (Pago en Una sola Exhibición) invoice immediately

payment_and_complement: Creates a PPD invoice and payment complement

none: No automation, registers payment only

Payment Form

The payment_form field specifies the Mexican SAT payment form code:

Common codes include: 01 (cash), 02 (check), 03 (electronic transfer), 04 (credit card), etc.

The payment will be marked as 'succeeded' immediately upon registration.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200Correcto

application/json

Payment registered successfully

Body

🟠400Solicitud incorrecta

🟠401No autenticado

🔴500Error interno del servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.gigstack.io/v2/payments/register?team' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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 Example

200 - Éxito

{
    "message": "Payment registered successfully",
    "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": [
            "invoice_1234567890"
        ],
        "created_at": 1677651234,
        "succeeded_at": 1677651234,
        "payment_processor": "api",
        "livemode": true,
        "team": "team_1234567890",
        "owner": "user_1234567890"
    }
}

Modified at 2025-10-09 23:51:05

Request payment

Mark payment as paid

Register payment

Automation Types#

Payment Form#

Request

Responses

Automation Types

Payment Form