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

# Tokenize a bank account

> Tokenizes a customer's bank account details. Use the returned token in place of raw account data for eCheck sales and recurring payments.



## OpenAPI

````yaml /openapi.json post /v1/transactions/echeck/tokenize
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/echeck/tokenize:
    post:
      tags:
        - eCheck Transactions
      summary: Tokenize a bank account
      description: >-
        Tokenizes a customer's bank account details. Use the returned token in
        place of raw account data for eCheck sales and recurring payments.
      operationId: eCheckTokenize
      requestBody:
        $ref: '#/components/requestBodies/eCheckTokenize'
      responses:
        '200':
          $ref: '#/components/responses/eCheckTokenize'
      security:
        - basicAuth: []
components:
  requestBodies:
    eCheckTokenize:
      description: >-
        API support various types of use. Required fields are defined by the
        most basic call. For other uses be sure to send the required information
        defined in the schema and examples.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/eCheckTokenize'
          examples:
            eCheckSale:
              $ref: '#/components/examples/eCheckTokenize'
  responses:
    eCheckTokenize:
      description: Successful eCheck operation
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                description: >-
                  Whether the request was processed successfully. Declines
                  return HTTP 200 with `success: false`.
              code:
                type: string
                description: Machine-readable result code. See the Error Codes reference.
              data:
                type: object
                properties:
                  paymentToken:
                    type: object
                    properties:
                      type:
                        type: string
                        description: Type of token supplied.
                      token:
                        type: object
                        properties:
                          provider:
                            type: string
                            description: >-
                              Payment provider that issued the token (for
                              example, `jupico`).
                          token:
                            type: string
                            description: The token value.
                          accountType:
                            type: string
                            description: Bank account type, such as `checking`.
                          routingLast4Digits:
                            type: string
                            description: Last 4 digits of the routing number.
                          accountLast4Digits:
                            type: string
                            description: Last 4 digits of the bank account number.
                          accountHolderName:
                            type: string
                            description: Name on the bank account.
                        description: Token payload returned by tokenization.
                    description: >-
                      The payment credential to charge: a one-time token from
                      the web component or a stored Jupico token.
                description: The response payload.
              message:
                type: string
                description: Human-readable result message.
  schemas:
    eCheckTokenize:
      type: object
      properties:
        alias:
          type: string
          description: Optional friendly name for the stored bank account.
        accountHolderName:
          type: string
          description: Name on the bank account.
        checkType:
          type: string
          description: Type of check used for the debit.
        accountType:
          type: string
          description: Bank account type, such as `checking`.
        accountNumber:
          type: string
          description: Bank account number.
        routingNumber:
          type: string
          description: 9-digit ABA routing number.
      required:
        - accountType
        - accountHolderName
        - accountNumber
        - routingNumber
  examples:
    eCheckTokenize:
      summary: Example request
      value:
        accountHolderName: John Doe
        accountType: savings
        accountNumber: '12312311'
        routingNumber: '122187238'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````