Requests and responses

Base URL

https://api.ionicfi.com

API reference paths include /v1 unless explicitly documented as buyer routes.

JSON

Authenticated API requests use JSON request bodies.

Content-Type: application/json
Authorization: Bearer sk_v1_test_...

Common response fields

Most resource responses include:

Field	Meaning
`id`	Prefixed object ID.
`object`	Resource type string.
`merchant_id`	Merchant owner, when the resource is merchant-scoped.
`livemode`	Whether the object belongs to live mode.
`metadata`	Merchant-defined key-value strings, when supported.
`created_at`	Unix timestamp in seconds.
`updated_at`	Unix timestamp in seconds.

List responses

Most list responses use a wrapper:

{
  "data": [
    {
      "id": "prod_00000000000001",
      "object": "product"
    }
  ],
  "has_more": false
}

Some list endpoints use offset pagination only and omit has_more. Customer list responses include a next_cursor object when cursor data is available.

Request IDs

Every response includes X-Request-ID. You can send this header yourself, or the server generates one.

import { Ionic } from "@ionicfi/sdk";

const ionic = new Ionic({ token: process.env.IONIC_SECRET_KEY });

const products = await ionic.catalog.products.list(
  {},
  { headers: { "X-Request-ID": "order-sync-1001" } },
);

curl https://api.ionicfi.com/v1/products \
  -H "Authorization: Bearer sk_v1_test_..." \
  -H "X-Request-ID: order-sync-1001"

Client-provided IDs are sanitized to [a-zA-Z0-9_.-] and capped at 128 characters.

Start here

Checkout

Commerce

Checkout endpoints

Payment link endpoints

Catalog endpoints

Payments

Terminal locations

Terminal management

Terminal testing

Terminal payments

Invoices

Subscriptions

Setup intents

Credit notes

Webhook endpoints

Customer endpoints

API key endpoints

Payment method endpoints

Requests and responses

Base URL

JSON

Common response fields

List responses

Request IDs

​Base URL

​JSON

​Common response fields

​List responses

​Request IDs

Base URL

JSON

Common response fields

List responses

Request IDs