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

# Create an auto-ramp account

> Creates a new auto-ramp account for the authenticated user. The account is a virtual bank account that automatically converts fiat deposits to crypto. The address must be valid for the specified network, and the network/token combination must be supported for your region.



## OpenAPI

````yaml https://platform.spritz.finance/openapi.json post /v1/auto-ramp-accounts/
openapi: 3.0.3
info:
  title: Spritz Finance API
  version: 1.0.0
  description: API for the Spritz Finance platform with RFC 9457 error handling
servers:
  - url: https://platform.spritz.finance
    description: Production
  - url: https://sandbox.spritz.finance
    description: Sandbox
security: []
tags:
  - name: Users
    description: User management endpoints
  - name: Bank Accounts
    description: Manage bank accounts for off-ramp destinations
  - name: Bills
    description: Manage bill pay accounts
  - name: Cards
    description: Spritz-issued debit cards
  - name: Auto-Ramp Accounts
    description: Virtual bank accounts that automatically convert fiat deposits to crypto
  - name: Spritz App
    description: >-
      Endpoints used by the Spritz app and internal SDKs. Excluded from the
      public partner spec.
paths:
  /v1/auto-ramp-accounts/:
    post:
      tags:
        - Auto-Ramp Accounts
      summary: Create an auto-ramp account
      description: >-
        Creates a new auto-ramp account for the authenticated user. The account
        is a virtual bank account that automatically converts fiat deposits to
        crypto. The address must be valid for the specified network, and the
        network/token combination must be supported for your region.
      operationId: postV1Auto-ramp-accounts
      requestBody:
        description: >-
          Request body for creating a new auto-ramp account. The address format
          must be valid for the specified network, and the network/token
          combination must be supported for your region.
        required: true
        content:
          application/json:
            schema:
              description: >-
                Request body for creating a new auto-ramp account. The address
                format must be valid for the specified network, and the
                network/token combination must be supported for your region.
              type: object
              properties:
                address:
                  description: Destination wallet address for crypto payouts
                  type: string
                  example: '0x742d35Cc6634C0532925a3b844Bc9e7595f2a3b8'
                network:
                  type: string
                  enum:
                    - ethereum
                    - polygon
                    - base
                    - arbitrum
                    - avalanche
                    - optimism
                    - solana
                    - tron
                    - bitcoin
                token:
                  description: Token to receive (must be valid for network)
                  type: string
                  example: USDC
              required:
                - address
                - network
                - token
              additionalProperties: false
          application/x-www-form-urlencoded:
            schema:
              description: >-
                Request body for creating a new auto-ramp account. The address
                format must be valid for the specified network, and the
                network/token combination must be supported for your region.
              type: object
              properties:
                address:
                  description: Destination wallet address for crypto payouts
                  type: string
                  example: '0x742d35Cc6634C0532925a3b844Bc9e7595f2a3b8'
                network:
                  type: string
                  enum:
                    - ethereum
                    - polygon
                    - base
                    - arbitrum
                    - avalanche
                    - optimism
                    - solana
                    - tron
                    - bitcoin
                token:
                  description: Token to receive (must be valid for network)
                  type: string
                  example: USDC
              required:
                - address
                - network
                - token
              additionalProperties: false
          multipart/form-data:
            schema:
              description: >-
                Request body for creating a new auto-ramp account. The address
                format must be valid for the specified network, and the
                network/token combination must be supported for your region.
              type: object
              properties:
                address:
                  description: Destination wallet address for crypto payouts
                  type: string
                  example: '0x742d35Cc6634C0532925a3b844Bc9e7595f2a3b8'
                network:
                  type: string
                  enum:
                    - ethereum
                    - polygon
                    - base
                    - arbitrum
                    - avalanche
                    - optimism
                    - solana
                    - tron
                    - bitcoin
                token:
                  description: Token to receive (must be valid for network)
                  type: string
                  example: USDC
              required:
                - address
                - network
                - token
              additionalProperties: false
      responses:
        '201':
          description: >-
            A virtual bank account that automatically converts fiat deposits to
            crypto. The account is opened in the user's name - funds deposited
            are converted to the specified token and sent to the destination
            wallet address. Important: Always confirm the account status is
            'active' before initiating a deposit.
          content:
            application/json:
              schema:
                description: >-
                  A virtual bank account that automatically converts fiat
                  deposits to crypto. The account is opened in the user's name -
                  funds deposited are converted to the specified token and sent
                  to the destination wallet address. Important: Always confirm
                  the account status is 'active' before initiating a deposit.
                type: object
                properties:
                  id:
                    description: Unique identifier for this auto-ramp account
                    type: string
                    example: 507f1f77bcf86cd799439011
                  depositInstructions:
                    description: >-
                      Deposit instructions for the virtual account. The `type`
                      field indicates the account format: `us` for ACH/wire
                      (routing + account number) or `iban` for SEPA (IBAN +
                      BIC).
                    anyOf:
                      - description: >-
                          US bank deposit instructions. Use these details to
                          initiate ACH or wire transfers.
                        type: object
                        properties:
                          bankName:
                            description: Name of the bank holding the virtual account
                            type: string
                            example: Lead Bank
                          bankAddress:
                            description: Physical address of the bank
                            type: string
                            example: 1801 Main St, Kansas City, MO 64108
                          paymentRails:
                            description: Supported payment rails for depositing funds
                            type: array
                            items:
                              type: string
                            example:
                              - ach
                              - wire
                          type:
                            description: US deposit instructions (ACH/wire)
                            type: string
                            enum:
                              - us
                          bankRoutingNumber:
                            description: 9-digit ABA routing number
                            type: string
                            example: '101019644'
                          bankAccountNumber:
                            description: Bank account number for deposits
                            type: string
                            example: '1234567890'
                        required:
                          - bankName
                          - bankAddress
                          - paymentRails
                          - type
                          - bankRoutingNumber
                          - bankAccountNumber
                      - description: >-
                          IBAN/SEPA deposit instructions. Use these details to
                          initiate SEPA transfers.
                        type: object
                        properties:
                          bankName:
                            description: Name of the bank holding the virtual account
                            type: string
                            example: Lead Bank
                          bankAddress:
                            description: Physical address of the bank
                            type: string
                            example: 1801 Main St, Kansas City, MO 64108
                          paymentRails:
                            description: Supported payment rails for depositing funds
                            type: array
                            items:
                              type: string
                            example:
                              - ach
                              - wire
                          type:
                            description: IBAN deposit instructions (SEPA)
                            type: string
                            enum:
                              - iban
                          iban:
                            description: International Bank Account Number for deposits
                            type: string
                            example: DE89370400440532013000
                          bic:
                            description: Bank Identifier Code (SWIFT)
                            type: string
                            example: COBADEFFXXX
                        required:
                          - bankName
                          - bankAddress
                          - paymentRails
                          - type
                          - iban
                  network:
                    description: >-
                      Blockchain network where converted crypto will be sent.
                      Lowercase network identifier.
                    type: string
                    example: ethereum
                  address:
                    description: >-
                      Destination wallet address. Fiat deposits are converted
                      and sent to this address.
                    type: string
                    example: '0x1234567890abcdef1234567890abcdef12345678'
                  token:
                    description: Token that fiat deposits will be converted to
                    type: string
                    example: USDC
                  currency:
                    description: Fiat currency accepted for deposits
                    type: string
                    example: USD
                  status:
                    type: string
                    enum:
                      - active
                      - inactive
                  createdAt:
                    description: >-
                      Timestamp when this auto-ramp account was created (ISO
                      8601)
                    format: date-time
                    type: string
                    example: '2025-01-15T10:30:00.000Z'
                required:
                  - id
                  - depositInstructions
                  - network
                  - address
                  - token
                  - currency
                  - status
                  - createdAt
                additionalProperties: false
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 401
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                    example: Bearer token required
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                  realm:
                    description: The authentication realm
                    type: string
                    example: API
                  scope:
                    description: The required scope for this resource
                    type: string
                    example: read:users
                required:
                  - title
                  - status
                additionalProperties: false
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                  status:
                    description: The HTTP status code
                    type: number
                    example: 404
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                  resourceType:
                    description: The type of resource that was not found
                    type: string
                    example: user
                  resourceId:
                    description: The identifier of the resource that was not found
                    type: string
                required:
                  - title
                  - status
                  - resourceType
                  - resourceId
                additionalProperties: false
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 400
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                    example: /errors/1234567890
                  code:
                    description: >-
                      Machine-readable cause, present when exactly one thing
                      failed. Branch on this, never on `detail`, which is
                      human-facing copy and may change. For deposit limits the
                      vocabulary matches the `reason` values the limits API
                      returns pre-flight.
                    type: string
                    example: transaction_limit
                  field:
                    description: The offending request field, present alongside `code`.
                    type: string
                    example: amountUsd
                  retryable:
                    description: >-
                      Whether retrying the same request later may succeed
                      without changing its inputs.
                    type: boolean
                    example: true
                required:
                  - title
                  - status
                additionalProperties: false
      security:
        - bearerAuth: []
        - integratorJwt: []
        - hmacAuth: []
          integratorKey: []
          timestamp: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cognito JWT token for regular user authentication
    integratorJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Integrator JWT token (prefix: spr_) for frontend integrator
        authentication. Obtained via token exchange endpoint.
    hmacAuth:
      type: apiKey
      in: header
      name: X-Signature
      description: >-
        HMAC signature authentication for backend integrators.


        **Required Headers:**

        - X-Integrator-Key: Integrator API key (format: int_...)

        - X-Signature: HMAC signature (format: sha256={hex})

        - X-Timestamp: Unix timestamp in milliseconds

        - Authorization: Bearer {user-api-key}


        **Signature Algorithm:** HMAC-SHA256


        **Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash}

        - timestamp: Unix timestamp in milliseconds

        - METHOD: HTTP method in UPPERCASE (GET, POST, etc.)

        - path: Request path (e.g., /v1/transactions)

        - bodyHash: SHA256 hex digest of request body (empty string if no body)


        **Timestamp Tolerance:** ±5 minutes (300 seconds)


        **Example:**

        For POST /v1/transactions with body {"amount":100} and timestamp
        1234567890000:

        Payload: 1234567890000.POST./v1/transactions.{sha256(body)}

        Signature: sha256=abc123...
    integratorKey:
      type: apiKey
      in: header
      name: X-Integrator-Key
      description: 'Integrator API key (format: int_...) used with HMAC authentication'
    timestamp:
      type: apiKey
      in: header
      name: X-Timestamp
      description: >-
        Unix timestamp in milliseconds for replay attack prevention. Must be
        within 5 minutes of server time.

````