Imprint Transactions API

openapi: 3.2.0
info:
  title: Public Imprint Transactions API
  version: '2.0'
servers:
- url: https://dev.sbx.imprint.co
  description: Imprint public api sandbox
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Transactions
paths:
  /v2/transactions/{transaction_id}:
    get:
      tags:
      - Transactions
      summary: Retrieve a transaction
      description: Retrieves the details of an existing transaction by `id`
      operationId: getTransaction
      parameters:
      - name: transaction_id
        in: path
        required: true
        description: The unique identifier for the transaction
        schema:
          type: string
          example: 4E6FE207-53E5-4EC0-BF51-5923BE5CEE2F
      - name: expand
        $ref: '#/components/parameters/transactionExpandParam'
      responses:
        '200':
          description: Transaction retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transaction'
        '400':
          description: Unsupported expand value
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
        '404':
          description: Transaction not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionNotFoundError'
components:
  schemas:
    Transaction:
      type: object
      required:
      - id
      - customer_id
      - payment_method_id
      - amount
      - currency
      - status
      - network_transaction_id
      - created_at
      properties:
        id:
          type: string
          example: E777214A-2D11-4CAD-9E8F-E1BD71D9FE67
        intent_id:
          type: string
          description: Reference to the original transaction intent
          example: 5B30532B-5B5B-4826-8DE2-429C57B705FD
        customer_id:
          type: string
          description: The imprint customer ID for the transaction
          example: 9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4
        authorization_code:
          type: string
          description: Code authorizing the transaction.
          example: ABCD
        payment_method_id:
          type: string
          description: Identifies the payment method used for the transaction
          example: DCBFC736-2286-42DD-897D-160DCA80AED2
        purchase_method:
          $ref: '#/components/schemas/PurchaseMethod'
        amount:
          type: integer
          description: Transaction amount in min units.
        currency:
          $ref: '#/components/schemas/TransactionCurrency'
        status:
          $ref: '#/components/schemas/TransactionStatus'
        network_transaction_id:
          type: string
          description: The network's unique identifier for the transaction. Examples include Visa Transaction ID, Mastercard Trace ID, and American Express Network Reference ID
        partner_transaction_id:
          type: string
          description: The partner's unique transaction id
        created_at:
          type: string
          description: the RFC-3339 timestamp when the transaction was created
          example: 2025-02-13 19:08:07+00:00
        updated_at:
          type: string
          description: the RFC-3339 timestamp when the transaction was last updated
          example: 2025-02-13 19:08:07+00:00
        merchant:
          $ref: '#/components/schemas/Merchant'
        metadata:
          type: object
          additionalProperties: true
          example:
            platform_version: 2.1.0
        events:
          type: array
          description: Events in the transaction's lifecycle, oldest first. Present only when requested with `expand=events`.
          items:
            $ref: '#/components/schemas/TransactionLifecycleEvent'
    TransactionLifecycleEvent:
      type: object
      description: One step in a transaction's lifecycle, e.g. the authorization, a capture, a refund or a confirmed dispute.
      required:
      - event_id
      - status
      - amount
      - created_at
      properties:
        event_id:
          type: string
          description: Unique identifier of this event. Matches the `event_id` in the Transaction Event Notification and the `transaction_event_id` on a Reward.
          example: B2D4A1C9-7F3E-4C8A-9E61-2A5B8D0F4C17
        status:
          $ref: '#/components/schemas/TransactionStatus'
        amount:
          type: integer
          description: Amount of this event in min units, e.g. the captured or refunded amount. Always non-negative.
          example: 5000
        created_at:
          type: string
          description: The RFC-3339 timestamp when the event was created
          example: 2025-02-13 19:08:07+00:00
        reward:
          allOf:
          - $ref: '#/components/schemas/Reward'
          nullable: true
          x-go-type: nullable.Nullable[Reward]
          x-go-type-import:
            path: github.com/oapi-codegen/nullable
          x-go-type-skip-optional-pointer: true
          description: The reward earned or deducted by this event, as returned by `GET /v2/rewards`. Present only when requested with `expand=events.reward`. Null when the event has no reward.
    RewardCurrency:
      type: string
      description: The 3-character currency code of the amount in ISO 4217 format (e.g., "USD") or a reward unit (e.g., "POINTS")
      example: POINTS
    PurchaseMethod:
      type: string
      enum:
      - CHIP
      - CONTACTLESS
      - KEYEDIN
      - ONLINE
      - SWIPE
      - QRCODE
      - OCR
      - UNKNOWN
      nullable: true
      description: How the purchase was completed.
      example: CHIP
    RewardStatus:
      type: string
      enum:
      - PENDING
      - AVAILABLE
      - PENDING_DEDUCTION
      - DEDUCTED
      example: PENDING
    RewardType:
      type: string
      enum:
      - OFFER
      - TRANSACTION
      - ONE_TIME
      - STATEMENT
      - REFERRAL
      example: TRANSACTION
    Address:
      type: object
      description: Mailing address information
      properties:
        street_line1:
          type: string
          description: Primary street address
          example: 123 Main St
        street_line2:
          type: string
          description: Secondary street address (apartment, suite, etc.)
          example: Apt 4B
        city:
          type: string
          description: City name
          example: San Francisco
        state:
          type: string
          description: State or province
          example: CA
        postal_code:
          type: string
          examples:
          - '94105'
          - 94105-1234
        country:
          type: string
          description: ISO-3166-1 alpha-3 Country Code
          example: USA
    TransactionStatus:
      type: string
      enum:
      - APPROVED
      - UPDATED
      - VOIDED
      - CAPTURED
      - REFUNDED
      example: APPROVED
    Reward:
      type: object
      required:
      - id
      - customer_id
      - amount
      - status
      - type
      - created_at
      properties:
        id:
          type: string
          example: 2EE24580-B97B-4949-A65C-929CCB9B9B8D
        customer_id:
          type: string
          example: 9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4
        transaction_event_id:
          type: string
          description: transaction that generated this reward, if applicable.
          example: E777214A-2D11-4CAD-9E8F-E1BD71D9FE67
        amount:
          type: integer
          description: reward amount in min units.
        type:
          $ref: '#/components/schemas/RewardType'
        currency:
          $ref: '#/components/schemas/RewardCurrency'
        status:
          $ref: '#/components/schemas/RewardStatus'
        created_at:
          type: string
          description: the RFC-3339 timestamp when the reward was created
          example: 2025-02-13 19:08:07+00:00
        updated_at:
          type: string
          description: the RFC-3339 timestamp when the reward was last updated
          example: 2025-02-13 19:08:07+00:00
        metadata:
          type: object
          additionalProperties: true
          example:
            platform_version: 2.1.0
    TransactionCurrency:
      type: string
      description: The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")
      example: USD
    TransactionNotFoundError:
      type: object
      required:
      - type
      - message
      properties:
        type:
          type: string
          description: The category of error being returned.
          example: TRANSACTION_FOUND_ERROR
        message:
          type: string
          description: A message describing the cause of the error.
          example: 'Transaction intent not found for provided ID: txn_123'
        param:
          type: string
          description: The param causing the error.
          example: transaction_id
    Merchant:
      type: object
      properties:
        network_id:
          type: string
          description: Unique identifier of the merchant assigned by the payment network.
          example: '234923454545'
        name:
          type: string
          description: Name of the merchant where the transaction occurred.
          example: Target
        category:
          type: string
          nullable: true
          description: Name of the merchant category.
          example: Grocery Stores
        category_code:
          type: string
          nullable: true
          description: Code associated with the merchant category.
          example: '5411'
        address:
          $ref: '#/components/schemas/Address'
          type: object
    InvalidRequestError:
      type: object
      properties:
        path:
          type: string
          description: The path of the endpoint returning the error
          example: /v2/customers
        details:
          type: array
          items:
            type: string
          description: The details of the error being returned
          example:
          - 'email: must be a well-formed email address'
        error:
          type: string
          description: The category of error being returned
          example: Bad Request
        status:
          type: integer
          description: The HTTP status code of the error
          example: 400
        timestamp:
          type: string
          description: The timestamp that the error occurred
          example: '2025-01-20T18:18:22.923+00:00'
    TransactionExpand:
      type: string
      description: Related data that can be included on a transaction with the `expand` query parameter. `events` adds the transaction's lifecycle events; `events.reward` adds the events and, on each event, the reward it earned or deducted.
      enum:
      - events
      - events.reward
      example: events
  parameters:
    transactionExpandParam:
      name: expand
      in: query
      required: false
      style: form
      explode: false
      description: 'Related data to include on each transaction, as a comma-separated list. Supported values:

        `events` — the transaction''s lifecycle events (authorization, captures, refunds, confirmed disputes),

        each with the same `event_id` delivered in the Transaction Event Notification;

        `events.reward` — the events, each with the `reward` it earned or deducted (implies `events`).

        Omit to receive the transaction without events. Unknown values return 400. See

        [Retrieve a transaction''s events](https://docs.imprint.co/guide-event-notifications#retrieve-a-transactions-events).

        '
      schema:
        type: array
        items:
          $ref: '#/components/schemas/TransactionExpand'
      example:
      - events
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>'
    bearerAuth:
      bearerFormat: auth-scheme
      description: 'Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>'
      scheme: bearer
      type: http
x-provenance:
  method: harvested
  publisher: Imprint
  source: https://docs.imprint.co/api-reference/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)