API Reference 

The Ommnium API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the Ommnium API in test mode, which doesn’t affect your live data or interact with the banking networks. The API key you use to authenticate the request determines whether the request is live mode or test mode.

The Ommnium API doesn’t support bulk updates. You can work on only one object per request.

The Ommnium API differs for every account as we release new versions and tailor functionality. Log in to see docs with your test key and data.

Just getting started?

Check out our profile on layntr for a guide.

Not a developer?

Use Ommnium’s no-code options or apps from our partners to get started with Ommnium and to do more with your Ommnium account—no code required.

Base URL
https://api.ommnium.com
Client Libraries (SOON)

Ommnium API Platform demonstrate using curl to interact with the API over HTTP/HTTPS. But you can select one of our official client libraries to see examples in code.

Authentication 

The Ommnium API uses API keys to authenticate requests. You can view and manage your API keys in the Ommnium Dashboard.

API requests are authenticated using Bearer Authentication. To make a request, include your API key in the `Authorization` header, formatted as follows: Authorization: Bearer YOUR_API_KEY.

Your API keys carry significant privileges, so ensure they remain secure. Avoid sharing your keys in publicly accessible areas such as Layntr, GitHub or Discord or client-side code.

All API requests must be made over HTTPS. Unauthenticated or non-secure (HTTP) requests will be rejected.

Authenticated Request
curl https://api.stripe.com/v1/charges \
  -u sk_test_z6Wgj3W...E900vpjOnFhPsk_test_z6Wgj3W5n3eYSLEKPRJ4OrE900vpjOnFhP:
# The colon prevents curl from asking for a password.
Your API Key

A sample test API key is included in all the examples here, so you can test any example right away. Do not submit any personally identifiable information in requests made with this key.

To test requests using your account, replace the sample API key with your actual API key or sign in.

Users 

This is an object representing a user account in Ommnium. You can retrieve it to view properties such as the account's current status, assigned roles, or enabled services.

For accounts where role_collection administrator, the properties below include extended permissions and management capabilities.

For standard users, the returned data includes basic account details and usage metrics. Additional features can be accessed by generating an Account Link or logging in through a Session Token. Learn more about the account roles and permissions.

Errors 

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.

For accounts where controller.requirement_collection application, which includes Custom accounts, the properties below are always

For accounts where controller.requirement_collection stripe, which includes Standard and Express accounts, some properties are only returned Account Link or Account Session differences between accounts.

HTTP Status Code Summary
200 OK Everything worked as expected.
400 Bad Request The request was unacceptable, often due to missing a required parameter.
401 Unauthorized No valid API key provided.
402 Request Failed The parameters were valid but the request failed.
403 Forbidden The API key doesn’t have permissions to perform the request.
404 Not Found The requested resource doesn’t exist.
409 Conflict The request conflicts with another request (perhaps due to using the same idempotent key).
429 Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 Server Errors Something went wrong on Stripe’s end. (These are rare.)
Error Types
api_error API errors cover any other type of problem (e.g., a temporary problem with Stripe’s servers), and are extremely uncommon.
card_error Card errors are the most common type of error you should expect to handle. They result when the user enters a card that can’t be charged for some reason.
idempotency_error Idempotency errors occur when an Idempotency-Key is re-used on a request that does not match the first request’s API endpoint and parameters.
invalid_request_error Invalid request errors arise when your request has invalid parameters.

Services 

Some top-level API resource have support for retrieval via “search” API methods. For example, you can search charges, search customers, and search subscriptions.

Stripe’s search API methods utilize cursor-based pagination via the page request parameter and next_page response parameter. For example, if you make a search request and receive "next_page": "pagination_key" in the response, your subsequent call can include page=pagination_key to fetch the next page of results.

Our client libraries offer auto-pagination helpers to easily traverse all pages of a search result.

Search request format

  • queryrequired

    The search query string. See search query language.

  • limitoptional

    A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

  • pageoptional

    A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Search response format

  • objectstring, value is "search_result"

    A string describing the object type returned.

  • urlstring

    The URL for accessing this list.

  • has_moreboolean

    Whether or not there are more elements available after this set. If false, this set comprises the end of the list.

  • dataarray

    An array containing the actual response elements, paginated by any request parameters.

  • next_pagestring

    A cursor for use in pagination. If has_more is true, you can pass the value of next_page to a subsequent call to fetch the next page of results.

  • total_countoptional positive integer or zero

    The total number of objects that match the query, only accurate up to 10,000. This field isn’t included by default. To include it in the response, expand the total_count field.

Response
{
  "object": "search_result",
  "url": "/v1/customers/search",
  "has_more": false,
  "data": [
    {
      "id": "cus_4QFJOjw2pOmAGJ",
      "object": "customer",
      "address": null,
      "balance": 0,
      "created": 1405641735,
      "currency": "usd",
      "default_source": "card_14HOpG2eZvKYlo2Cz4u5AJG5",
      "delinquent": false,
      "description": "someone@example.com for Coderwall",
      "discount": null,
      "email": null,
      "invoice_prefix": "7D11B54",
      "invoice_settings": {
        "custom_fields": null,
        "default_payment_method": null,
        "footer": null,
        "rendering_options": null
      },
      "livemode": false,
      "metadata": {
        "foo": "bar"
      },
      "name": "fakename",
      "next_invoice_sequence": 25,
      "phone": null,
      "preferred_locales": [],
      "shipping": null,
      "tax_exempt": "none",
      "test_clock": null
    }
  ]
}