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

# Generate a Pix BR code for an autoramp

> Generates a static Pix BR code (copy-and-paste payload) for a BRL
autoramp, tagged with your `reference` and optionally a fixed amount.
The reference is returned with the resulting deposit. Calling again with
the same parameters returns the same code.




## OpenAPI

````yaml https://api.sandbox.iron.xyz/spec/2026-08-01 post /autoramps/{autoramp_id}/br-code
openapi: 3.1.0
info:
  description: The Stablecoin Payment Network
  title: Iron API - Sandbox
  version: '2026-08-01'
servers:
  - url: https://api.sandbox.iron.xyz/api
security: []
tags:
  - description: >-
      Wallet and bank account registration


      Every wallet address that interacts with Iron must be registered (linked)
      to a customer **before** it can be used in any flow — onramp, offramp, or
      swap. This is a regulatory requirement under the **Travel Rule**, which
      obliges Virtual Asset Service Providers to exchange originator and
      beneficiary information for crypto transfers.


      Iron supports two wallet types:


      - **Self-hosted wallets** — the customer controls the private key.
      Registration requires a signed proof-of-ownership message.

      - **Hosted wallets** — the wallet is custodied by another VASP (e.g.
      Coinbase, Kraken). Registration requires the VASP's DID so Iron can
      exchange travel-rule data with the custodian.


      Similarly, fiat bank accounts must be registered before they can receive
      offramp payouts.
    name: Addresses
  - description: Operations on Autoramp
    name: Autoramp
  - description: Operations on Chronicle collateral
    name: ChronicleCollateral
  - description: Operations on Currencies
    name: Currencies
  - description: Operations on Customers
    name: Customer
  - description: Operations on Exchange Rate
    name: ExchangeRate
  - description: Operations on Fee Profiles
    name: FeeProfiles
  - description: Operations for Sandbox Testing
    name: Sandbox
  - description: Operations on SSE
    name: Sse
  - description: Operations on Terms and Conditions
    name: TermsAndConditions
  - description: Operations on Webhooks
    name: Webhooks
paths:
  /autoramps/{autoramp_id}/br-code:
    post:
      tags:
        - Autoramp
      summary: Generate a Pix BR code for an autoramp
      description: |
        Generates a static Pix BR code (copy-and-paste payload) for a BRL
        autoramp, tagged with your `reference` and optionally a fixed amount.
        The reference is returned with the resulting deposit. Calling again with
        the same parameters returns the same code.
      operationId: createAutorampBrCode
      parameters:
        - deprecated: false
          description: a UUID ensuring an Autoramp operation is only processed once
          explode: true
          in: header
          name: IDEMPOTENCY-KEY
          required: true
          schema:
            type: string
        - deprecated: false
          description: The autoramp ID
          explode: false
          in: path
          name: autoramp_id
          required: true
          schema:
            format: uuid
            type: string
        - $ref: '#/components/parameters/XApiVersion'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/CreateAutorampBrCodeRequest'
        required: true
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ApiAutorampBrCode'
          description: BR code generated
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: Bad Request
        '401':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: Unauthorized
        '404':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: Not Found
        '500':
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Internal Error
        '503':
          content:
            application/json; charset=utf-8:
              schema:
                type: string
          description: Pix provider temporarily unavailable
      security:
        - ApiKeyAuth: []
components:
  parameters:
    XApiVersion:
      description: >-
        Selects the API version for this request, as an ISO date (`YYYY-MM-DD`).
        Omit to use the default version (`2025-03-13`). Supported versions:
        2025-03-13, 2026-07-01, 2026-08-01, 2026-10-01, 2026-10-15.
      in: header
      name: X-API-Version
      required: false
      schema:
        type: string
        x-default: '2026-08-01'
  schemas:
    CreateAutorampBrCodeRequest:
      description: Parameters for generating a Pix BR code for an autoramp
      properties:
        amount:
          description: |-
            Fixed amount to request, in BRL, minimum 0.01 and at most 2 decimal
            places. Omit to let the payer choose the amount.
          format: decimal
          type: string
        reference:
          description: >-
            Your reference for the payment, 1 to 19 alphanumeric characters. It
            is

            returned to us with the payment and shown as the transaction's

            inbound payment reference.
          maxLength: 19
          minLength: 1
          pattern: ^[a-zA-Z0-9]+$
          type: string
      required:
        - reference
      title: CreateAutorampBrCodeRequest
      type: object
    ApiAutorampBrCode:
      description: A Pix BR code for an autoramp
      properties:
        br_code:
          description: The Pix copy-and-paste (EMV) payload to pay
          type: string
      required:
        - br_code
      title: ApiAutorampBrCode
      type: object
    ApiError:
      description: |-
        Standard error response returned to API clients for server errors.
        Includes a trace_id that clients can reference when reporting issues.
      properties:
        message:
          description: Human-readable error message
          type: string
        trace_id:
          description: Trace ID that can be used to look up request details in logs
          type: string
      required:
        - message
        - trace_id
      title: ApiError
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: API Key
      in: header
      name: X-API-Key
      type: apiKey

````