Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Imprint Transaction Intents API

The Transaction Intents API from Imprint — 2 operation(s) for transaction intents.

Imprint Transaction Intents API is one of 14 APIs that Imprint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transaction Intents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://dev.sbx.imprint.co.

4 operations 2 paths 6 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://dev.imprint.co
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Imprint Transaction Intents API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Transaction Intents 4
POST
/v2/transaction_intents
Create a transaction intent
createTransactionIntent body → 200400
GET
/v2/transaction_intents
List transaction intents
searchTransactionIntents 3 params → 200
GET
/v2/transaction_intents/{intent_id}
Retrieve a transaction intent
getTransactionIntent 1 param → 200404
POST
/v2/transaction_intents/{intent_id}
Update a transaction intent
updateTransactionIntent 1 param body → 200400

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TransactionIntent (11 properties), Address (6 properties), InvalidRequestError (5 properties), TransactionIntentFoundError (3 properties). Each schema is shown below with its type and property counts.

TransactionIntentFoundError
object
3 properties 2 required
InvalidRequestError
object
5 properties
TransactionIntent
object
11 properties 6 required
TransactionCurrency
string
The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")
TransactionIntentStatus
string
Address
object
Mailing address information
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

imprint-transaction-intents-api-openapi.yml Raw ↑

Other APIs Imprint publishes across the network.

Imprint Customer Links API
Imprint Customer Sessions API
Imprint Customers API
Imprint Keys API
Imprint Offers API
Imprint Order Events API
Imprint Orders API
Imprint Payment Methods API
Imprint Rewards API
Imprint Simulate Reward API
Imprint Simulate Statement Reward API
Imprint Simulate Transaction Event API