/gateways

Adds a gateway configuration. The name is unique per tenant and can change; the id never does.

Server URLhttps://pay.contagorda.com/api/v1
POST/gateways

Authorization

Bearer token: an app key from Apps (sk_app_live_… or sk_app_test_…), or the tenant key from Settings (sk_live_… or sk_test_…). The key picks the mode: a live key only sees live data, a test key only sandbox data.

Request Body

application/json, required

namestringoptional

Unique per tenant, e.g. stripe-br.

providerstringoptional
One of stripe, asaas, abacatepay, pagarme, cielo
priorityintegeroptional

Lower runs first.

Min 1
activebooleanoptional
sandboxbooleanoptional
credentialsobjectoptional

The provider's keys (for Stripe secret_key and webhook_secret). Stored encrypted.

Response Body

201Gateway created.
idstringoptional
Format uuid
namestringoptional
providerstringoptional
priorityintegeroptional
activebooleanoptional
sandboxbooleanoptional
has_credentialsbooleanoptional

Credentials are never returned, only whether they are set.

created_atstringoptional
Format date-time
updated_atstringoptional
Format date-time
401Missing or invalid secret key.
errorstringoptional

What went wrong.

422The configuration is invalid.
errorsstring[]optional

Full validation messages.

Are you sure?

Keyboard shortcuts

⌘ KSearch and navigate⌘ JOpen and close the Workbenchg hHomeg pPaymentsg cCustomersg sSubscriptionsg aAppsg gGateways?This listEscClose