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

# Retrieve a single automation

> Retrieve full details for a single automation on an account, including its status, destination, and configuration.

Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.


## OpenAPI

````yaml GET /accounts/{account_id}/automations/{id}
openapi: 3.0.3
info:
  title: Brale Issuance and Orchestration API
  version: 2.3.1
  description: >
    Brale supports stablecoin issuance and orchestration, enabling businesses
    and

    ecosystems to create their own stablecoins and convert between fiat and
    stablecoins

    seamlessly. From stablecoin onramps, offramps, and swaps to custody and
    payouts, the

    Brale API makes it easy to build stablecoin-enabled products.


    NOTE: All resource IDs (including account_id, address_id,
    financial_institution_id,

    and automation_id) are KSUIDs—27-character alphanumeric strings that are
    sortable

    by time. Examples showing UUIDs are incorrect.



    **What's new in 2.3.1**

    - Unified **Addresses** model for on-chain and off-chain endpoints
      - `Transfers` now accepts **address_id only** (no financial_institution_id)
      - Optional `brand` object to control bank statement presentation (`branding` still accepted as legacy alias)
    - Added off-chain rails: `ach_credit`, `same_day_ach_credit`, `ach_debit`,
    `same_day_ach_debit`, `rtp-credit`

    - Plaid endpoints moved to `/accounts/{account_id}/plaid/*`

    - `Financial Institutions` marked **deprecated** (migration path to
    **Addresses**)

    - Create Account now uses `CreateManagedAccountRequest` with
    `beneficial_owners`, `business_controller`, and `EndUserTosAttestation`.

    - Transfers now accept `brand` (replaces `branding`, still aliased in docs).

    - Plaid endpoints updated to return `address_id` and accept
    `transfer_types`.

    - Off-chain Address creation uses `CreateExternalAddressRequest` oneOf with
    bank + blockchain variants.

    - FI endpoints kept but marked deprecated; use Addresses instead.

    - `rtp_credit` is the canonical RTP rail name.



    **FedNow**

    - Added the `fednow_credit` rail. Outbound: create a Transfer with
      `destination.transfer_type: fednow_credit` to a bank Address that lists
      `fednow_credit` in `transfer_types`. Inbound: payers send FedNow credits to an
      active Automation's `source.funding_instructions`; Brale creates the Transfer
      automatically with `source.transfer_type: fednow_credit`.
    - Simulate a testnet FedNow deposit with `transfer_type: fednow` on
      `POST /accounts/{account_id}/automations/{automation_id}/simulations/deposits`.
    - `bank_address` and `beneficiary_address` are required only when an
    external
      bank Address requests `wire`.
    - FedNow availability depends on account enablement.
servers:
  - url: https://api.brale.xyz
    description: Production server
security:
  - BearerAuth: []
tags:
  - name: Accounts
    description: Endpoints related to managing customer accounts (KYB, details, etc.)
  - name: Transfers
    description: >-
      Endpoints for creating and retrieving transfers (fiat to stablecoins,
      etc.)
  - name: Addresses
    description: >-
      On-chain and off-chain endpoints (custodial or external) represented by a
      single Addresses resource
  - name: Financial Institutions
    description: Legacy (deprecated) bank endpoints. Use Addresses instead.
  - name: Automations
    description: Automated deposit addresses or onramps
  - name: Plaid
    description: Bank linking and ACH debit via Plaid.
  - name: Orders
    description: Legacy tag used for transfers in older specs.
paths:
  /accounts/{account_id}/automations/{id}:
    get:
      tags:
        - Automations
      summary: Retrieve a single automation
      description: Returns details for a specific automation.
      operationId: getAutomations
      parameters:
        - name: account_id
          in: path
          required: true
          description: The ID of the account
          schema:
            $ref: '#/components/schemas/Ksuid'
        - name: id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Ksuid'
          description: The ID of the automation
      responses:
        '200':
          description: A single automation object
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Automation'
components:
  schemas:
    Ksuid:
      title: Kusid
      type: string
      format: ksuid
      pattern: ^[a-zA-Z0-9]{27}$
      example: 2VcUIIsgARwVbEGlIYbhg6fGG57
    Automation:
      title: Automation
      type: object
      properties:
        id:
          $ref: '#/components/schemas/Ksuid'
        name:
          type: string
          example: XYZ Onramp
        status:
          type: string
          description: The current lifecycle state of the automation.
          enum:
            - pending
            - active
            - disabled
            - archived
          example: active
        source:
          $ref: '#/components/schemas/AutomationSource'
        destination:
          $ref: '#/components/schemas/AutomationDestination'
        created_at:
          type: string
          format: date-time
          example: '2024-01-15T12:34:56Z'
        updated_at:
          type: string
          format: date-time
          example: '2024-01-15T12:34:56Z'
        brand:
          $ref: '#/components/schemas/AutomationBrand'
    AutomationSource:
      title: AutomationSource
      type: object
      description: >-
        The funding source for the automation. Set `value_type: USD` to accept
        fiat deposits. You do not need to select a deposit rail: a USD
        Automation's virtual account accepts the inbound rails enabled for your
        account (wire, ACH, and FedNow where enabled). When the automation
        becomes active, `funding_instructions` is populated with the virtual
        account details to share with the payer. This is Automation
        configuration. The rail of each deposit is reported on the resulting
        Transfer's `source.transfer_type` (for example, `fednow_credit`), not
        here.
      properties:
        value_type:
          type: string
          description: The fiat value type accepted by the automation (e.g. `USD`).
          example: USD
        transfer_type:
          type: string
          nullable: true
          description: >-
            Optional. Omit this field to accept every inbound rail enabled for
            the virtual account. Responses may return `null`. Do not set it to
            restrict deposits to FedNow. A null value does not mean FedNow is
            unavailable.
          example: null
        funding_instructions:
          $ref: '#/components/schemas/FundingInstructions'
      required:
        - value_type
    AutomationDestination:
      title: AutomationDestination
      type: object
      description: >-
        The destination wallet that receives minted stablecoins when the
        automation is funded.
      properties:
        address_id:
          $ref: '#/components/schemas/Ksuid'
        value_type:
          type: string
          description: The stablecoin value type minted to the destination (e.g. `SBC`).
          example: SBC
        transfer_type:
          type: string
          description: The destination chain or rail (e.g. `solana`).
          example: solana
      required:
        - address_id
        - value_type
        - transfer_type
    AutomationBrand:
      title: AutomationBrand
      type: object
      description: >-
        Optional. Selects the verified identity shown as the beneficiary on the
        automation's funding instructions. Pass the account_id of your own
        account or a managed account (business or individual). Both custodial
        and transactional accounts can be used, subject to applicable
        verification and program eligibility. The automation is still created
        under the account in the request path; `brand.account_id` only controls
        the identity rendered on the funding instructions. If omitted, Brale is
        the default beneficiary.
      properties:
        account_id:
          $ref: '#/components/schemas/Ksuid'
          description: >-
            The account whose verified identity appears as the beneficiary on
            wire and ACH funding instructions. For a business account, this is
            the business name and address. For an individual account, this is
            the individual's legal name and address.
      required:
        - account_id
    FundingInstructions:
      title: FundingInstructions
      type: object
      description: >-
        Bank details for the virtual account that funds the automation.
        Populated by Brale once the automation becomes active. Share these
        coordinates with the payer to fund the automation.
      properties:
        beneficiary_name:
          type: string
          example: Jane Business
        bank_name:
          type: string
          example: Example Bank
        bank_address:
          type: string
          example: 456 Commerce St., Des Moines, IA 50309
        beneficiary_address:
          type: string
          example: 612 Commerce St., Des Moines, IA 50309
        account_number:
          type: string
          description: >-
            Bank account number to fund the automation. On testnet, this field
            contains the automation's alphanumeric ID as a placeholder, not a
            numeric bank account number. This applies to both branded and
            unbranded automations.
          example: '123456789'
        routing_number:
          type: string
          example: '063108680'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Use the Bearer token returned from the Auth endpoint via OAuth2
        client_credentials flow. Include the token in the "Authorization: Bearer
        <token>" header.

````