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

# Obtenha o status de Virtual Accounts em lote

Este endpoint recupera o status e os detalhes de um lote de contas virtuais que você criou anteriormente usando o endpoint [Criar Contas Virtuais em Lote](https://docs.localpayment.com/pt-br/reference/request-batch.md). Isso permite que você acompanhe de forma eficiente o progresso da criação de várias contas e verifique o status de ativação delas.


## OpenAPI

````yaml openapi/pt-br/localpayment.json GET /api/virtual-account-batch/{externalId}
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/virtual-account-batch/{externalId}:
    get:
      summary: Obtenha o status de Virtual Accounts em lote.
      operationId: get-virtual-account-status-batch
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token).
          required: true
          schema:
            type: string
        - name: externalId
          in: path
          description: >-
            O identificador único do processo em lote que você deseja consultar.
            Este deve ser exatamente o mesmo valor de externalId que você
            forneceu para o lote ao criá-lo por meio do endpoint de criação de
            lotes.
          required: true
          schema:
            type: string
            pattern: '[a-zA-Z0-9\- ]+'
            examples:
              - 53025bf4-4c87-4b4f-8fea-b47004440f37
      requestBody:
        content: {}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  externalId:
                    type: string
                    description: >-
                      O identificador único para este processo em lote. Este é o
                      mesmo externalId que você forneceu em sua solicitação,
                      confirmando a operação em lote que você está consultando.
                  internalId:
                    type: string
                    description: Identificador de transação da Localpayment.
                  accountNumber:
                    type: string
                    description: Número da conta Localpayment.
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                        examples:
                          - COMPLETED
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                        examples:
                          - Batch Process Virtual Account completed
                  errors:
                    type: array
                    description: Informações adicionais sobre o erro.
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: Código de erro.
                        detail:
                          type: string
                          description: Detalhes do erro.
                  comment:
                    type: string
                    description: Informações adicionais.
                  csvFormatResponse:
                    type: string
                    description: >-
                      Cadeia de caracteres em formato CSV contendo os resultados
                      do processo em lote. Cada linha representa uma conta
                      criada, com colunas para `internal_id`, `external_id` e
                      `bank_account`.
                x-examples:
                  Example 1:
                    externalId: 0fa6b758-6ada-49d1-9170-7f4ac00c7359
                    internalId: dbc8503a-0c48-4ea9-86fd-d186244bf56e
                    accountNumber: '{{YourAccountNumber}}'
                    status:
                      code: '801'
                      description: REJECTED
                      detail: Batch Process Virtual Account has been rejected
                    errors:
                      - code: '825'
                        detail: System error to generate payin
                    comment: >-
                      The batch process for Virtual Account Creation has been
                      rejected due to errors - The process started at =
                      2025-01-03 22:40:49.99 - Total accounts requested = 12 -
                      Total accounts created = 0 - The process was rejected at =
                      2025-01-03 22:40:50.039 - 
                    csvFormatResponse: |
                      internal_id,external_id,bank_account
              examples:
                200 - Batch Process Virtual Account completed.:
                  value:
                    externalId: ba671d03-b3bc-4312-8841-5c65a67713ca
                    internalId: 91c0de90-9d70-44a6-b9c6-600f835802b6
                    accountNumber: '{{accountNumber}}'
                    status:
                      code: '200'
                      description: COMPLETED
                      detail: Batch Process Virtual Account completed
                    comment: >-
                      The batch process is done - The process started at =
                      2025-01-03 22:59:14.355 - Total accounts requested = 12 -
                      Total accounts created = 12 - The process finished at =
                      2025-01-03 22:59:17.716 - 
                    csvFormatResponse: >
                      internal_id,external_id,bank_account

                      e68208a1-3197-4b1e-82f6-76525a734e56,1111111111-1,646011319800023500

                      80dcc234-1010-427b-b256-3fff18325baf,1111111111-2,646011319800023501

                      d779c2ab-2505-43b8-874c-fcb97a2e5fb7,1111111111-3,646011319800023502

                      afd67163-fd79-4b2c-b288-c4d253bcec57,1111111111-4,646011319800023503

                      01e1d1bb-c89c-4d41-849d-bd1d8e5c3785,1111111111-5,646011319800023504

                      0ba88114-ae62-407b-9f03-8f863000c163,1111111111-6,646011319800023505

                      0184a17a-5c38-4c43-b10a-15079662e518,1111111111-7,646011319800023506

                      b80991f5-396d-485a-b480-fdfb8635bef3,1111111111-8,646011319800023507

                      cd0f6180-c3ad-4a69-815f-25d6f053aee2,1111111111-9,646011319800023608

                      95ea6157-2d17-459c-969a-708ca31cfc13,1111111111-10,646011319800023609

                      cf50e4d2-ac34-48f4-a60f-b2ee8b152f6a,1111111111-11,646011319800023610

                      70d1f0be-3db0-48fd-8493-b712038ea48e,1111111111-12,646011319800023611
                801 - Batch Process Virtual Account has been rejected.:
                  value:
                    externalId: bbeb7535-601c-4671-9966-13146e94cc65
                    internalId: 1f9662f5-bf16-4f65-8229-c09b3b41fc26
                    accountNumber: '{{accountNumber}}'
                    status:
                      code: '801'
                      description: REJECTED
                      detail: Batch Process Virtual Account has been rejected
                    errors:
                      - code: '812'
                        detail: External Id already used - duplication
                    comment: >-
                      The batch process for Virtual Account Creation has been
                      rejected due to errors - The process started at =
                      2025-01-03 23:10:03.715 - Total accounts requested = 12 -
                      Total accounts created = 0 - The process was rejected at =
                      2025-01-03 23:10:03.757 - 
                    csvFormatResponse: |
                      internal_id,external_id,bank_account
        '400':
          description: Solicitação inválida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    description: Tempo de execução do serviço.
                  status:
                    type: integer
                    description: Código de status do erro.
                  error:
                    type: string
                    description: Descrição do erro.
                  message:
                    type: string
                    description: Mensagem com informações adicionais.
                  path:
                    type: string
                    description: Caminho do serviço.
                x-examples:
                  Example 1:
                    timestamp: '2025-01-03T23:11:24.655+00:00'
                    status: 400
                    error: Bad Request.
                    message: >-
                      Batch external id not found:
                      bbeb7535-607c-4671-9966-13146e94cc6511
                    path: >-
                      /virtual-account/batch/bbeb7535-607c-4671-9966-13146e94cc6511
              examples:
                400 - Batch external id not found.:
                  value:
                    timestamp: '2025-01-03T23:11:24.655+00:00'
                    status: 400
                    error: Bad Request.
                    message: >-
                      Batch external id not found:
                      bbe17535-607c-4621-9966-13146494cc6511
                    path: >-
                      /virtual-account/batch/bbe17535-607c-4621-9966-13146494cc6511
        '401':
          description: Não autorizado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Informações adicionais sobre a resposta.
                  code:
                    type: string
                    description: Código de status.
                  messages:
                    type: array
                    description: Lista de mensagens.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Classe Token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensagem com informações adicionais.
                x-examples:
                  Example 1:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
              examples:
                401 - Token is invalid or expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.