Request payment

POST

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

Create a payment request that creates a payment in 'requires_payment_method' status.

gigstack Connect: Create payment requests for other teams using the team parameter.

Payment Request Flow

This endpoint creates a payment request that customers can complete using various payment methods.
The payment will be created with status 'requires_payment_method'.

Allowed Payment Methods

Control which payment methods are available to the customer:

card: Credit/debit card payments

spei: Mexican bank transfer (SPEI)

oxxo: OXXO convenience store payments

stripe-spei: Customer balance payments

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200Correcto

application/json

Payment request created successfully

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.gigstack.io/v2/payments/request?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,
    "allowed_payment_methods": [
        "card",
        "bank",
        "oxxo"
    ],
    "items": [
        {
            "id": "service_1234567890",
            "quantity": 1,
            "unit_price": 1000
        }
    ],
    "send_email": true,
    "emails": [
        "customer@example.com"
    ]
}'

Response Example

{
    "message": "Payment request created successfully",
    "data": {
        "id": "payment_1234567890",
        "client": {
            "id": "client_1234567890",
            "name": "Juan Pérez García",
            "email": "juan.perez@ejemplo.com",
            "tax_id": "PEGJ800101ABC"
        },
        "status": "requires_payment_method",
        "currency": "MXN",
        "exchange_rate": 1,
        "allowed_payment_methods": [
            "card",
            "bank",
            "oxxo"
        ],
        "short_url": "https://pay.gigstack.io/p/abc123",
        "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"
            }
        ],
        "emails": [
            "customer@example.com"
        ],
        "created_at": 1677651234,
        "payment_processor": "api",
        "livemode": true,
        "team": "team_1234567890",
        "owner": "user_1234567890"
    }
}

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

Get payment

Request payment

Payment Request Flow#

Allowed Payment Methods#

Request

Responses

Payment Request Flow

Allowed Payment Methods