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 Payment Methods API

The Payment Methods API from Imprint — 2 operation(s) for payment methods.

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

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

This API exposes 3 operations across 2 paths, and defines 7 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.

3 operations 2 paths 7 schemas 2 GET1 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 Payment Methods 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 3

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

Payment Methods 3
GET
/v2/payment_methods
List payment methods
searchPaymentMethods 4 params → 200
POST
/v2/payment_methods
List payment methods
searchPaymentMethodsPost body → 200400
GET
/v2/payment_methods/{payment_method_id}
Retrieve a payment method
getPaymentMethod 1 param → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PaymentMethod (10 properties), PaymentMethodToken (5 properties), InvalidRequestError (5 properties), PaymentMethodNotFoundError (3 properties). Each schema is shown below with its type and property counts.

CardDesignID
string
Imprint ID for the graphic design printed on the card
CardType
string
The type of card
InvalidRequestError
object
5 properties
PaymentMethod
object
10 properties 6 required
PaymentMethodToken
object
5 properties 4 required
TransactionCurrency
string
The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")
PaymentMethodNotFoundError
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

imprint-payment-methods-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 Rewards API
Imprint Simulate Reward API
Imprint Simulate Statement Reward API
Imprint Simulate Transaction Event API
Imprint Transaction Intents API