> ## 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.

# Capture an authorization

> A capture confirms a previous authorization and initiates settlement, charging the customer. The capture amount may exceed the authorized amount up to an allowable excess limit determined by the issuing bank.



## OpenAPI

````yaml /openapi.json post /v1/transactions/creditcard/capture
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.
paths:
  /v1/transactions/creditcard/capture:
    post:
      tags:
        - Card Transactions
      summary: Capture an authorization
      description: >-
        A capture confirms a previous authorization and initiates settlement,
        charging the customer. The capture amount may exceed the authorized
        amount up to an allowable excess limit determined by the issuing bank.
      operationId: ccCapture
      requestBody:
        $ref: '#/components/requestBodies/ccCapture'
      responses:
        '200':
          $ref: '#/components/responses/ccCapture'
      security:
        - basicAuth: []
components:
  requestBodies:
    ccCapture:
      description: >-
        ***To test this endpoint you need to make an AUTHORIZATION request
        first***
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ccCapture'
          examples:
            Capture:
              $ref: '#/components/examples/ccCapture'
  responses:
    ccCapture:
      description: Successful fund capture
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                properties:
                  status:
                    type: string
                    description: Current status.
                  approvalNumber:
                    type: string
                    description: Approval code returned by the issuing bank.
                  transactionId:
                    type: string
                    description: Identifier of the authorization to capture.
                  operation:
                    type: string
                    description: >-
                      Transaction operation type (for example, sale,
                      authorization, refund).
                  subMerchantId:
                    type: string
                    description: Unique identifier of the submerchant.
                  amount:
                    type: number
                    description: The amount of the transaction.
                  txDate:
                    type: string
                    description: Date and time of the transaction (ISO 8601).
                  referenceNumber:
                    type: string
                    description: Processor reference number for the transaction.
                  description:
                    type: string
                    description: Free-text description.
                  billing:
                    type: object
                    properties:
                      address:
                        type: string
                        description: Street address, including number.
                      city:
                        type: string
                        description: City name.
                      zipCode:
                        type: string
                        description: ZIP or postal code.
                      state:
                        type: string
                        description: Two-letter US state code.
                      name:
                        type: string
                        description: Full name of the payer.
                    description: Billing contact and address details for the payer.
                  paymentMethod:
                    type: object
                    properties:
                      type:
                        type: string
                        description: The type.
                      eCheck:
                        type: object
                        description: eCheck (ACH) acceptance settings.
                      cc:
                        type: object
                        properties:
                          card:
                            type: object
                            properties:
                              last4Digits:
                                type: string
                                description: Last 4 digits of the card number.
                              expirationYear:
                                type: string
                                description: Two-digit expiration year.
                              expirationMonth:
                                type: string
                                description: Two-digit expiration month (01-12).
                              logo:
                                type: string
                                description: Card brand logo identifier.
                            description: Card details.
                          token:
                            type: string
                            description: The token value.
                          cardHolderInitiated:
                            type: boolean
                            description: >-
                              True when the cardholder actively initiates the
                              payment; false for merchant-initiated transactions
                              such as recurring charges.
                        description: Card payment method details.
                    description: Details of the payment method used.
                  balanceAmount:
                    type: number
                    description: >-
                      Remaining balance on the transaction after captures,
                      refunds, and voids.
                description: The response payload.
              success:
                type: boolean
                description: >-
                  Whether the request was processed successfully. Declines
                  return HTTP 200 with `success: false`.
              message:
                type: string
                description: Human-readable result message.
              code:
                type: string
                description: Machine-readable result code. See the Error Codes reference.
  schemas:
    ccCapture:
      type: object
      properties:
        subMerchantId:
          type: string
          description: Unique identifier of the submerchant.
        amount:
          type: number
          description: >-
            The amount to capture. May exceed the authorized amount up to the
            issuer's allowable excess limit.
        transactionId:
          type: string
          description: Identifier of the authorization to capture.
        description:
          type: string
          description: Free-text description.
        taxAmount:
          type: number
          description: |
            The total amount of sales tax must be between:
            Visa percentage: 0.1% - 18%
            MasterCard percentage: 0.1% - 23%
            Default percentage: 0.1% - 50%
          nullable: true
        taxWithHold:
          type: boolean
          description: >-
            When true, the sales tax portion is withheld from the merchant's
            settlement until released.
        referenceId:
          type: string
          description: >-
            Your own reference for this transaction. Returned in responses and
            query results for reconciliation.
        dynamicFee:
          type: object
          properties:
            fixed:
              type: number
              description: Fixed portion of the dynamic fee.
            discountRatePerc:
              type: number
              description: >-
                Percentage portion of the dynamic fee, applied to the
                transaction amount.
          description: >-
            Fee added to the transaction at processing time and itemized
            separately.
        metadata:
          $ref: '#/components/schemas/metadata'
        billingDescriptor:
          type: object
          properties:
            name:
              type: string
              maxLength: 25
              example: test
              description: >-
                The text that appears on the cardholder's statement, overriding
                the default business name.
          description: Overrides the descriptor that appears on the cardholder's statement.
      required:
        - subMerchantId
        - amount
        - transactionId
    metadata:
      type: object
      description: >-
        metadata is an object that can host as much as 50 key-value pairs, where
        the keys can be at most 40 char length and can’t include the characters
        “[“ or “]”, and the values must be strings and cannot exceed 500 chars
        [Learn more about metadata](https://docs.jupico.com/docs/metadata#/)
      additionalProperties:
        type: string
        maxLength: 500
      x-key-max-length: 40
  examples:
    ccCapture:
      summary: Example request
      value:
        subMerchantId: jpt-sim-md-1
        amount: 50
        description: CC Capture
        transactionId: >-
          You need to change *this* with transactionId from AUTHORIZATION
          operation
        taxAmount: 4.5
        taxWithHold: false
        metadata:
          test: test
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````