gigstack API

Create a payment

Develop Env

https://api.gigstack.io/v2

POST

/payments

Payments

Creates a new payment

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.gigstack.io/v2/payments' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "clientId": "string",
    "client": {
        "id": "string",
        "billingAccount": "string",
        "metadata": {
            "internalId": "string",
            "reference": "string",
            "stringitems": "string",
            "property1": "string",
            "property2": "string"
        },
        "owner": "string",
        "email": "user@example.com",
        "from": "string",
        "team": "string",
        "name": "string",
        "rfc": "string",
        "legal_name": "string",
        "timestamp": 0,
        "livemode": true,
        "tax_system": "string",
        "address": {
            "street": "string",
            "city": "string",
            "state": "string",
            "zip": "string",
            "country": "string"
        },
        "phone": "string",
        "use": "string"
    },
    "email": "user@example.com",
    "items": [
        {
            "name": "string",
            "description": "string",
            "quantity": 0,
            "total": 0,
            "product_key": "string",
            "unit_key": "string",
            "unit_name": "string",
            "taxes": [
                {
                    "type": "string",
                    "rate": 0,
                    "factor": "string"
                }
            ],
            "discount": 0,
            "currency": "string"
        }
    ],
    "currency": "MXN",
    "exchange": 0,
    "paymentMethod": "01",
    "paid": false,
    "date": "2019-08-24T14:15:22Z",
    "livemode": false,
    "avoidEmail": false,
    "automaticInvoice": false,
    "automateInvoiceOnComplete": false,
    "automateIncomeInvoiceAndComplement": false,
    "forceReceipt": false,
    "invoiceConfig": {
        "folio": "string",
        "series": "string",
        "type": "string"
    },
    "from": "api",
    "team": "string",
    "metadata": {
        "internalId": "string",
        "reference": "string",
        "stringitems": "string",
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

200 - Example 1

{
    "data": {
        "id": "string",
        "fid": "string",
        "v": 0,
        "team": "string",
        "owner": "string",
        "billingAccount": "string",
        "amount": 0,
        "currency": "MXN",
        "status": "requires_payment_method",
        "internalStatus": "string",
        "client": {
            "id": "string",
            "billingAccount": "string",
            "metadata": {
                "internalId": "string",
                "reference": "string",
                "stringitems": "string",
                "property1": "string",
                "property2": "string"
            },
            "owner": "string",
            "email": "user@example.com",
            "from": "string",
            "team": "string",
            "name": "string",
            "rfc": "string",
            "legal_name": "string",
            "timestamp": 0,
            "livemode": true,
            "tax_system": "string",
            "address": {
                "street": "string",
                "city": "string",
                "state": "string",
                "zip": "string",
                "country": "string"
            },
            "phone": "string",
            "use": "string"
        },
        "clientId": "string",
        "items": [
            {
                "id": "string",
                "name": "string",
                "description": "string",
                "quantity": 0,
                "total": 0,
                "unitPrice": 0,
                "product_key": "string",
                "unit_key": "string",
                "unit_name": "string",
                "taxes": [
                    {
                        "type": "string",
                        "rate": 0,
                        "factor": "Tasa",
                        "base": 0,
                        "amount": 0,
                        "retained": true
                    }
                ],
                "discount": 0,
                "currency": "MXN",
                "paymentType": {
                    "label": "string",
                    "value": "fixed"
                },
                "serviceId": "string",
                "category": "string",
                "subcategory": "string"
            }
        ],
        "internalItems": [
            {
                "id": "string",
                "name": "string",
                "description": "string",
                "quantity": 0,
                "total": 0,
                "unitPrice": 0,
                "product_key": "string",
                "unit_key": "string",
                "unit_name": "string",
                "taxes": [
                    {
                        "type": "string",
                        "rate": 0,
                        "factor": "Tasa",
                        "base": 0,
                        "amount": 0,
                        "retained": true
                    }
                ],
                "discount": 0,
                "currency": "MXN",
                "paymentType": {
                    "label": "string",
                    "value": "fixed"
                },
                "serviceId": "string",
                "category": "string",
                "subcategory": "string"
            }
        ],
        "discount": 0,
        "exchange": 0,
        "exchangeRate": 0,
        "exchange_rate": 0,
        "exchangeRateDate": "2019-08-24T14:15:22Z",
        "payment_form": "string",
        "paidId": "string",
        "paidIn": "string",
        "processor": "string",
        "custom_method_types": [
            {
                "name": "string",
                "id": "string",
                "logo": "http://example.com",
                "details": "string",
                "manualConfirmation": true,
                "requiredKey": "string"
            }
        ],
        "automations": [
            {
                "action": "string",
                "ref": "string",
                "type": "string",
                "from": "string"
            }
        ],
        "invoices": [
            "string"
        ],
        "payments": [
            "string"
        ],
        "relatedTo": "string",
        "recurringEventNumber": 0,
        "skc": true,
        "avoidEmail": true,
        "forceReceipt": true,
        "invoiceConfig": {},
        "conceptReference": "string",
        "binnacle": "string",
        "event": {},
        "user": {
            "uid": "string",
            "email": "string"
        },
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "from": "string",
        "date": 0,
        "timestamp": 0,
        "created": 0,
        "succeededTimestamp": 0,
        "livemode": true,
        "shortURL": "http://example.com",
        "shortUrl": "http://example.com",
        "token": "string",
        "hasStripe": true,
        "paymentIntent": "string",
        "client_secret": "string",
        "stripeGenerated": true,
        "payment_method_options": {
            "card": {
                "installments": {},
                "mandate_options": {},
                "network": "string",
                "request_three_d_secure": "string"
            },
            "oxxo": {
                "expires_after_days": 0
            }
        },
        "transfer_data": {
            "destination": "string",
            "split": 0,
            "splitType": {
                "master": "client",
                "connect": "client"
            }
        }
    },
    "message": "string",
    "next": "string",
    "totalResults": 0,
    "hasMore": true
}

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Body Params application/json

Payment creation request. Item amounts should be specified in regular currency units (e.g., 1500 = $15.00). The API converts these to cents for internal processing.

clientId

string

optional

Client identifier (required if client object not provided)

client

object

optional

Client information object (alternative to clientId). For creation, only subset of fields are required: name, email, rfc, legal_name, tax_system, address, use

string

optional

Unique client identifier

billingAccount

string

optional

Associated billing account ID

metadata

object

optional

Additional client metadata

owner

string

optional

Owner user ID

string <email>

optional

Client email address

from

string

optional

Client creation source (e.g., 'api', 'dashboard')

team

string

optional

Associated team ID

name

string

optional

Client display name

rfc

string

optional

Mexican tax ID (RFC)

legal_name

string

optional

Legal business name

timestamp

number

optional

Client creation timestamp

livemode

boolean

optional

Whether client is in live mode

tax_system

string

optional

Tax system code (SAT catalog)

address

object

Address

optional

phone

string

optional

Client phone number

use

string

optional

CFDI use code

string <email>

optional

Client email address (alternative to client.email)

items

array [object {10}]

required

Array of payment items

name

string

required

Item name

description

string

required

Item description

quantity

number

required

Item quantity

total

number

required

Item total amount in regular currency units (not cents)

product_key

string

required

SAT product catalog key

unit_key

string

required

SAT unit catalog key

unit_name

string

required

Unit name

taxes

array [object {3}]

optional

Applied taxes

discount

number

optional

Item discount amount

currency

string

optional

Item currency

currency

enum<string>

optional

Currency code

Allowed values:

MXNUSDEUR

Default:

MXN

exchange

number

optional

Exchange rate (auto-calculated if not provided)

paymentMethod

enum<string>

optional

Payment method identifier (required if paid is true)

Allowed values:

01020304050608121314151723242526272829303199

paid

boolean

optional

Whether the payment is already paid

Default:

false

date

string <date-time>

optional

Payment date (defaults to current date)

livemode

boolean

optional

Whether payment is in live mode

Default:

false

avoidEmail

boolean

optional

Whether to avoid sending email notifications

Default:

false

automaticInvoice

boolean

optional

Whether to automatically create an invoice

Default:

false

automateInvoiceOnComplete

boolean

optional

Whether to create invoice when payment is completed

Default:

false

automateIncomeInvoiceAndComplement

boolean

optional

Whether to automate income invoice and payment complement

Default:

false

forceReceipt

boolean

optional

Whether to force receipt creation

Default:

false

invoiceConfig

object

optional

Invoice configuration

folio

string

optional

Invoice folio number

series

string

optional

Invoice series

type

string

optional

Invoice type

from

string

optional

Payment source identifier

Default:

api

team

string

optional

Target team ID (for master teams only - creates payment for specified team)

metadata

object

optional

Additional payment metadata

internalId

string

optional

Internal reference ID (must be unique)

reference

string

optional

External reference

stringitems

string

optional

JSON string of items (alternative to items array)

Additional properties

string

optional

Examples

Responses

🟢200OK

application/json

Payment created successfully

Body

data

object

Payment

optional

string

required

Unique payment identifier

fid

string

optional

Functional ID

number

optional

Version number

team

string

optional

Team identifier

owner

string

optional

Owner user ID

billingAccount

string

optional

Billing account identifier

amount

number

required

Payment amount in cents

currency

string

optional

Payment currency code

Default:

MXN

status

enum<string>

required

Current payment status

Allowed values:

requires_payment_methodrequires_confirmationrequires_actionprocessingrequires_capturecanceledsucceeded

internalStatus

string

optional

Internal payment status

client

object

Client

optional

Unified client schema used across all API endpoints

clientId

string

optional

Associated client ID

items

array[object (PaymentItem) {16}]

optional

Array of payment items

internalItems

array[object (PaymentItem) {16}]

optional

Processed internal items array

discount

number

optional

Total discount amount

exchange

number

optional

Exchange rate

exchangeRate

number

optional

Exchange rate (alias)

exchange_rate

number

optional

Exchange rate (alternate field)

exchangeRateDate

string <date-time>

optional

Exchange rate date

payment_form

string

optional

Payment form code

paidId

string

optional

Payment method label

paidIn

string

optional

Payment method used

processor

string

optional

Payment processor

custom_method_types

array[object (PaymentMethod) {6}]

optional

Available payment methods

automations

array [object {4}]

optional

Automation configurations

invoices

array[string] | null

optional

Associated invoice IDs

payments

array[string] | null

optional

Related payment IDs

relatedTo

string | null

optional

Related resource ID

recurringEventNumber

number

optional

Recurring event number

skc

boolean

optional

Skip charge flag

avoidEmail

boolean

optional

Whether to avoid sending email notifications

forceReceipt

boolean

optional

Whether to force receipt creation

invoiceConfig

object

optional

Invoice configuration

conceptReference

string

optional

Payment concept reference

binnacle

string

optional

Payment audit log

event

object

optional

Associated event data

user

object

optional

User information

metadata

object

optional

Additional payment metadata

from

string

optional

Payment source

date

number

optional

Payment date timestamp

timestamp

number

required

Payment creation timestamp

created

number

optional

Creation timestamp

succeededTimestamp

number | null

optional

Success timestamp

livemode

boolean

optional

Whether payment is in live mode

shortURL

string <uri>

optional

Shareable payment link

shortUrl

string <uri>

optional

Shareable payment link (alias)

token

string

optional

JWT token for payment access

hasStripe

boolean

optional

Whether Stripe integration is available

paymentIntent

string

optional

Stripe payment intent ID

client_secret

string

optional

Stripe client secret

stripeGenerated

boolean

optional

Whether Stripe payment intent was generated

payment_method_options

object

optional

Stripe payment method options

transfer_data

object

optional

Split billing transfer information

message

string

optional

string | null

optional

totalResults

integer

optional

hasMore

boolean

optional

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-16 03:36:47

Payments

List payments