Guides

Quickstart

Quickstart

This guide gets you up and running with the Synapto API: verify your credentials and make your first API call.

All amounts are in the smallest currency unit (e.g. pence for GBP, cents for USD).

Prerequisites

  • A Synapto account — sign up at dashboard.synaptopay.com (or dashboard.synapto.construction for sandbox)
  • An API key — create one in Settings > Developer (see Authentication)
  • A publishable key — find it in Settings > Developer (needed for client-side integrations)
  • Your account ID — found in Settings > Account in the Dashboard (e.g. acct_RwDJsJd8z0exhtfX2570Q)

Resource names

The Synapto API uses resource names to identify objects. Rather than passing bare IDs, you pass the full resource path:

accounts/acct_RwDJsJd8z0exhtfX2570Q/customers/cus_oRlM8p6VQ57xxmRhQ9sQc

These resource names are returned in the name field of every API response, and you pass them back to the API when referencing that resource.

Make your first API call

Verify your API key works by retrieving your account:

curl https://api.synaptopay.com/v1/accounts/acct_YOUR_ACCOUNT \
  -H "Authorization: Api-Key sk_live_YOUR_API_KEY"

If you see your account details in the response, you're ready to go.

Choose your product

Synapto offers two products that can be used independently or together:

Synapto Collect

Synapto Collect is for accepting payments from your customers. Take card payments, host checkout pages, send invoices, save cards, manage customers, handle refunds, and set up subscriptions for recurring billing.

See the Synapto Collect Overview to get started.

Synapto Flow

Synapto Flow is for platforms that need to move money between multiple parties. Track balances, split payment proceeds across sub-accounts, and pay out to bank accounts. Flow builds on top of Collect — charges generate balance, which Flow lets you distribute and pay out.

See the Flow Overview to get started.

Next steps

Support

If you need any help, reach out to [email protected], mention you are an engineer and someone technical will get back to you.

Before go-live, escalation paths (e-mail, phone, etc.) are shared.

Updated about 2 months ago