Integrations

Connect a store.
Issue a key. Test it first.

Everything on this page is something you can go and check: the connection catalog as the platform declares it, the scopes a key can carry, the objects the sandbox will return you, and the formats the reporting surface writes.

Read the API docs Developer platform

How a key reads

The environment is part of the credential, not a setting next to it.

sk_live_· · · · · · · ·

pk / skPublishable or secret.

live / testWhich environment the request runs against.

A sandbox call made with a live key is rejected rather than quietly run.

Catalog8 connections

EnvironmentsLive and test

Sandbox5 object kinds

ExportCSV, XLSX, PDF

The catalog

What connects, and how.

Eight entries, each with the authorization method it uses. A connection is held per environment, so a test connection and a live connection to the same platform are separate records with separate credentials.

IntegrationCategoryHow it connects

ShopifyE-commerceOAuth authorization

WooCommerceE-commerceAPI credentials

Magento 2E-commerceAPI credentials

WixE-commerceEmbed

SquarespaceE-commerceEmbed

ZapierAutomationWebhook subscription

MakeAutomationWebhook subscription

Headless / CustomCustomDirect API

Access

A key is a scope set, not a password.

What a key may do is decided when it is issued, and checked on every request.

Rules on every request

EnvironmentRead from the key prefix, never from a stored flag — a test key cannot be flipped live.

At restOnly a SHA-256 hash is stored. The plaintext is shown once, at creation.

ScopeEvery key carries an explicit scope set. A missing scope is a 403, not a partial result.

NetworkAn optional IP allowlist. A request from outside it is refused before anything else runs.

LifetimeStatus and expiry are checked on every request; a revoked key stops working immediately.

RateA per-key request window throttles an abnormally high call rate.

Scopes a key can carry

payments:readList and retrieve payment links.

payments:writeCreate and cancel payment links.

payouts:readList and retrieve payout history.

payouts:writeRequest new payouts.

refunds:readList and retrieve refunds.

refunds:writeCreate refunds.

webhooks:manageRegister, update and delete the webhook endpoint.

analytics:readDashboard data and transaction exports.

keys:readList your own keys — never their secrets.

keys:manageRotate and revoke your own keys.

Sandbox

Ask for the object before you build against it.

The sandbox returns a deterministic object of the kind you name, recorded against your session so you can see what you asked for and when.

transactionA completed transaction at the amount and currency you pass.

webhookAn event envelope of the type you name, with its data block.

settlementA settled batch with gross and net, so the spread is visible.

payoutA completed payout at the amount and currency you pass.

fraud_eventA scored decision with the reasons that produced it.

Export

Getting the data out is its own path.

Reporting writes CSV, XLSX and PDF, on demand or on a schedule. This is an export surface and it is named as one — it moves a file, it does not maintain a connection to a system on the other side.

CSVEscaped to the standard, so a field containing a comma or a quote survives the round trip.

XLSXA real workbook rather than a renamed CSV, for finance teams who open it in a spreadsheet.

PDFFor the reports that get filed or attached rather than re-imported.

ScheduledThe same report on a recurring run, instead of somebody remembering to pull it.

Be clear about what a connection is today: authorizing a platform establishes and stores that authorization, per environment, with credentials encrypted at rest. It is not a running data synchronisation, and this page does not describe one. For moving data in and out right now, the supported paths are the API with a scoped key and the export formats above. Accounting and warehouse destinations are not connected — where you have seen those names attached to BINK before, they were not backed by anything that transmits.

Elsewhere

Next, depending on what you are doing.