Skip to main content
PATCH

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.

Path Parameters

id
string
required
provider
enum<string>
required
Available options:
stripe,
adyen,
paypal,
zettle,
conekta,
openpay,
clip,
clockpms,
pagoralia,
dlocal,
woocommerce,
mercadopago,
mercadolibre,
airtable,
shopify,
bank,
sheets,
netsuite,
whatsapp,
zapier,
whmcs,
hilos,
sat,
sat_download,
factus

Body

application/json

Settings accepted only for provider=stripe. Fields omitted from the request remain unchanged. Read the provider state after a write. Nullable text clears; boolean null is rejected.

automatic_invoicing
boolean
test_only
boolean
automatic_refunds
boolean
ppd_flow
boolean
use_provider_exchange_rate
boolean
convert_payments_to_currency
string | null
Pattern: ^[A-Z]{3}$
default_payment_method
string | null
Maximum string length: 2
Pattern: ^\d{2}$
customer_balance_payment_method
string | null
Maximum string length: 2
Pattern: ^\d{2}$
stripe_payment_method
string | null
Maximum string length: 2
Pattern: ^\d{2}$

Response

Stored integration state

success
boolean
required
data
object
required
timestamp
number
required