> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jupico.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a transaction receipt

> Returns the receipt data for a single transaction, ready to render or send to the cardholder. It combines the transaction, the sub-merchant's business details, and the payment method into one flat payload, so you do not have to assemble a receipt from several queries. Unlike the other Query endpoints this is a single-record lookup: it takes one `transactionId` and one `subMerchantId`, and does not accept sorting, paging, or filtering.



## OpenAPI

````yaml /openapi.json post /v1/query/transactions/receipt
openapi: 3.0.0
info:
  title: Jupico - OpenAPI 3.0
  description: >-
    The Jupico API lets Service Providers onboard merchants, process card and
    eCheck (ACH) payments, run hosted payment pages, manage recurring billing,
    send payouts, and query every resource. All endpoints use HTTPS with Basic
    authentication and accept and return JSON. Endpoints are grouped by
    workflow: onboard merchants first, then accept payments, then move funds and
    report.
  termsOfService: https://help.jupico.com/references-and-resources/legal
  contact:
    email: support@jupico.com
  license:
    name: Jupico License
    url: https://jupico.com
  version: 1.0.5
servers:
  - url: https://sandbox-platform.jupico.com
security:
  - basicAuth: []
tags:
  - name: Status
    description: Health check for the Jupico API.
  - name: Onboarding Invites
    description: >-
      Create and send invites that onboard merchants through the Jupico-hosted
      flow, with optional pre-filled identity, fees, and payout bank account
      data.
  - name: Provisioning
    description: >-
      Onboard merchants from your own UI. Collect onboarding data and submit it
      through the provisioning chain: applicant → application → submerchant.
  - name: Session
    description: >-
      Create browser authorization sessions for the Jupico web components, so
      card and bank account data is tokenized client-side and never touches your
      servers.
  - name: Tokenization
    description: >-
      Convert one-time tokens from the web components into permanent Jupico
      tokens, or tokenize raw card data if your systems are PCI DSS compliant.
  - name: Customer
    description: >-
      Create and manage customer records that payments, subscriptions,
      installments, and invoices link to.
  - name: Card Transactions
    description: >-
      Process credit and debit card transactions using tokenized card data:
      sale, authorization, capture, void, refund, and rollback.
  - name: eCheck Transactions
    description: >-
      Debit customer bank accounts via eCheck (ACH): sale, void, refund,
      rollback, and bank account tokenization.
  - name: Checkouts
    description: >-
      Hosted checkout sessions where customers complete payment on a
      Jupico-hosted page.
  - name: Payment Links
    description: >-
      Shareable links that open a Jupico-hosted payment page — no integration
      code needed at the point of sharing.
  - name: Invoices
    description: Create and email invoices that customers pay online.
  - name: Subscriptions
    description: >-
      Recurring billing. Plans define billing schedules and pricing models;
      subscriptions enroll customers against a stored payment token.
  - name: Installments
    description: Split a fixed total into scheduled payments with an optional deposit.
  - name: Payouts
    description: >-
      Send funds from a submerchant's available balance to a tokenized bank
      account with on-demand payout instructions.
  - name: Query
    description: >-
      Search and report across every resource: transactions, merchants,
      settlements, balances, disputes, fees, and more. All query endpoints
      accept the same filter, sort, and pagination envelope — see the Query
      Capabilities guide.
  - name: Currency Exchange API
    description: >-
      Query live exchange rates, convert amounts between currencies, and
      retrieve the list of supported currency codes.
paths:
  /v1/query/transactions/receipt:
    post:
      tags:
        - Query
      summary: Get a transaction receipt
      description: >-
        Returns the receipt data for a single transaction, ready to render or
        send to the cardholder. It combines the transaction, the sub-merchant's
        business details, and the payment method into one flat payload, so you
        do not have to assemble a receipt from several queries. Unlike the other
        Query endpoints this is a single-record lookup: it takes one
        `transactionId` and one `subMerchantId`, and does not accept sorting,
        paging, or filtering.
      operationId: transactionReceipt
      requestBody:
        $ref: '#/components/requestBodies/transactionReceipt'
      responses:
        '200':
          $ref: '#/components/responses/transactionReceipt'
      security:
        - basicAuth: []
components:
  requestBodies:
    transactionReceipt:
      description: >-
        Identify the transaction and the sub-merchant that owns it.
        `responseFormat` is optional and defaults to `json`.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/transactionReceipt'
          examples:
            transactionReceipt:
              $ref: '#/components/examples/transactionReceipt'
  responses:
    transactionReceipt:
      description: Receipt data for the transaction.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                description: Whether the request was processed successfully.
              status:
                type: string
                description: Result status of the request, such as `succeeded`.
              code:
                type: string
                description: Machine-readable result code. See the Error Codes reference.
              data:
                type: object
                properties:
                  transactionId:
                    type: string
                    description: Identifier of the transaction.
                  referenceId:
                    type: string
                    description: Your reference for the transaction, if one was sent.
                  invoiceNumber:
                    type: string
                    description: Invoice number recorded on the transaction.
                  approvalNumber:
                    type: string
                    description: Approval number returned by the processor.
                  status:
                    type: string
                    description: Status of the transaction, such as `succeeded`.
                  operation:
                    type: string
                    description: >-
                      Operation the receipt covers, such as `sale`, `refund`, or
                      `void`.
                  date:
                    type: string
                    format: date-time
                    description: Date and time the transaction was processed.
                  amount:
                    type: number
                    description: >-
                      Amount to show on the receipt. For an approved transaction
                      this is the remaining balance when the transaction tracks
                      one (for example, a sale that has been partially
                      refunded), otherwise the original amount. A declined
                      transaction always shows the original amount.
                  currency:
                    type: string
                    description: >-
                      Currency of the transaction. Defaults to `USD` when the
                      transaction does not record one.
                    example: USD
                  taxAmount:
                    type: number
                    description: Tax amount recorded on the transaction.
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        description:
                          type: string
                          description: Description of the line item.
                        quantity:
                          type: number
                          description: Number of units.
                        amount:
                          type: number
                          description: Price per unit.
                        taxRate:
                          type: number
                          description: Tax rate applied to this line item, as a percentage.
                    description: Line items recorded on the transaction.
                  merchant:
                    type: object
                    properties:
                      name:
                        type: string
                        description: Sub-merchant's DBA name.
                      address:
                        type: string
                        description: >-
                          Sub-merchant's business address as a single line:
                          street, city, state, postal code, and country.
                      phone:
                        type: string
                        description: Sub-merchant's business phone number.
                      website:
                        type: string
                        description: Sub-merchant's business website.
                    description: >-
                      Business details of the sub-merchant that took the
                      payment.
                  customer:
                    type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          Billing name, falling back to the cardholder or
                          account holder name when no billing name was sent.
                      email:
                        type: string
                        description: Billing email address.
                      phone:
                        type: string
                        description: Billing phone number.
                      address:
                        type: string
                        description: >-
                          Billing address as a single line: address, city,
                          state, ZIP code, and country.
                    description: >-
                      Customer details taken from the transaction's billing
                      information.
                  paymentMethod:
                    type: object
                    properties:
                      type:
                        type: string
                        description: Payment method used, such as `creditCard` or `eCheck`.
                      brand:
                        type: string
                        description: Card brand. Cards only.
                      last4:
                        type: string
                        description: >-
                          Last 4 digits of the card number or of the bank
                          account number.
                      cardHolderName:
                        type: string
                        description: Name on the card. Cards only.
                      accountType:
                        type: string
                        description: Bank account type, such as `checking`. eCheck only.
                    description: >-
                      How the transaction was paid. Brand and cardholder name
                      are present for cards; account type is present for eCheck.
                  description:
                    type: string
                    description: Description recorded on the transaction.
                description: >-
                  The receipt payload. A field is omitted when the transaction
                  does not carry a value for it.
              message:
                type: string
                description: Human-readable result message.
              error:
                type: object
                description: Error detail. Absent on a successful request.
  schemas:
    transactionReceipt:
      type: object
      properties:
        transactionId:
          type: string
          description: Identifier of the transaction to build the receipt for.
          example: b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e
        subMerchantId:
          type: string
          description: >-
            Sub-merchant that owns the transaction. Only one sub-merchant per
            request.
          example: jpt-sim-md-1
        responseFormat:
          type: string
          description: >-
            Format of the returned receipt. Defaults to `json`, which is
            currently the only supported value.
          enum:
            - json
          default: json
      required:
        - transactionId
        - subMerchantId
  examples:
    transactionReceipt:
      value:
        transactionId: b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e
        subMerchantId: jpt-sim-md-1
        responseFormat: json
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````