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

# Criar Virtual Accounts em lote

Este endpoint permite criar várias contas virtuais simultaneamente, agilizando o processo de criação de contas quando se lida com um grande número de contas. É possível criar entre 10 e 5000 contas virtuais através de um array.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/virtual-account-batch
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:
    post:
      summary: Criar Virtual Accounts em lote
      operationId: request-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
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                externalId:
                  type: string
                  description: >-
                    Um identificador único que você fornece para todo este
                    processo em lote. Este ID será usado para rastrear e
                    referenciar a operação em lote como um todo.
                accountNumber:
                  type: string
                  description: Número da conta Localpayment.
                country:
                  type: string
                  enum:
                    - ARG
                    - BRA
                    - CHL
                    - MEX
                  description: '[País](/pt-br/reference/country-codes). ISO 3166-1 alfa-3.'
                name:
                  type: string
                accounts:
                  type: array
                  items:
                    type: object
                    properties:
                      externalId:
                        type: string
                        description: >-
                          Um identificador único que você fornece para Virtual
                          Accounts específicas dentro do lote. Este ID será a
                          principal referência para esta conta individual em
                          todas as operações futuras (por exemplo, verificar o
                          status, desativar).
                      beneficiary:
                        type: object
                        description: >-
                          A pessoa física ou jurídica que receberá os fundos
                          depositados nesta Virtual Account. O beneficiário é o
                          destinatário final do dinheiro e não é necessariamente
                          o proprietário ou titular legal da própria Virtual
                          Account.
                        properties:
                          type:
                            type: string
                            enum:
                              - COMPANY
                              - INDIVIDUAL
                            description: Tipo de beneficiário.
                          name:
                            type: string
                            description: >-
                              Nome do beneficiário. Os caracteres permitidos
                              dependem do campo `type`: para `individual`,
                              letras (incluindo caracteres acentuados), espaços
                              e pontos (`.`); para `company`, o mesmo conjunto
                              mais dígitos, sublinhado (`_`) e hífen (`-`).
                            minLength: 2
                            maxLength: 255
                          document:
                            type: object
                            description: Documentação do beneficiário.
                            properties:
                              type:
                                type: string
                                description: >-
                                  O tipo de [documento de
                                  identidade](/pt-br/reference/identity-document-types),
                                  como Número de Identidade Nacional, Número de
                                  Seguro Social ou Carteira de Motorista,
                                  dependendo do país de emissão.
                                examples:
                                  - RUC
                              id:
                                type: string
                                description: >-
                                  Número do documento de identidade (geralmente
                                  um número). Este número deve ser válido de
                                  acordo com as regras para o tipo específico de
                                  documento.
                                examples:
                                  - '1791234561009'
                            required:
                              - type
                              - id
                            examples:
                              - type: RUC
                                id: '1791234561009'
                          lastName:
                            type: string
                            description: >-
                              Sobrenome do beneficiário. Obrigatório quando
                              `type` é `individual` e ignorado quando `type` é
                              `company`. Os caracteres permitidos dependem de
                              `type`: para `individual`, letras (incluindo
                              caracteres acentuados), espaços e pontos (`.`);
                              para `company`, o mesmo conjunto mais dígitos,
                              sublinhado (`_`) e hífen (`-`).
                            minLength: 2
                            maxLength: 255
                          address:
                            type: object
                            description: Endereço do beneficiário.
                            properties:
                              street:
                                type: string
                                description: Nome da rua.
                                examples:
                                  - Independencia
                              number:
                                type: string
                                description: Número da rua.
                                examples:
                                  - '123'
                              city:
                                type: string
                                description: Cidade.
                                examples:
                                  - Cordoba
                              state:
                                type: string
                                description: Estado.
                                examples:
                                  - Cordoba
                              country:
                                type: string
                                description: País do endereço.
                                examples:
                                  - Argentina
                              zipCode:
                                type: string
                                description: CEP.
                                examples:
                                  - X5000IUO
                              comment:
                                type: string
                                description: Informações adicionais sobre o endereço.
                                examples:
                                  - Sucursal 123
                            examples:
                              - street: Independencia
                                number: '123'
                                city: Cordoba
                                state: Cordoba
                                country: ARG
                                zipCode: X5000IUO
                                comment: Sucursal 123
                        required:
                          - type
                          - name
                          - document
                        examples:
                          - type: INDIVIDUAL
                            name: John
                            document:
                              type: RUC
                              id: '1791234561009'
                            lastName: Doe
                            address:
                              street: Independencia
                              number: '123'
                              city: Cordoba
                              state: Cordoba
                              country: ARG
                              zipCode: X5000IUO
                              comment: Sucursal 123
                    required:
                      - beneficiary
              required:
                - externalId
                - accountNumber
                - country
                - accounts
              x-examples:
                Example 1:
                  externalId: '{{$guid}}'
                  accountNumber: '{{YourAccountNumber}}'
                  country: MEX
                  name: Virtual Account
                  accounts:
                    - externalId: 1111111111-1
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                        address:
                          city: city
                          state: state
                          zipcode: zipcode
                          street: street
                          number: number
                          country: country
                    - externalId: 1111111111-2
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                    - externalId: 1111111111-3
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                        address:
                          city: city
                          state: state
                          zipcode: zipcode
                          street: street
                          number: number
                          country: country
                    - externalId: 1111111111-4
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                    - externalId: 1111111111-5
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                        address:
                          city: city
                          state: state
                          zipcode: zipcode
                          street: street
                          number: number
                          country: country
                    - externalId: 1111111111-6
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                    - externalId: 1111111111-7
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          type: RFC
                          id: EXTF900101NI1
                        address:
                          city: city
                          state: state
                          zipcode: zipcode
                          street: street
                          number: number
                          country: country
                    - externalId: 1111111111-8
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                    - externalId: 1111111111-9
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                        address:
                          city: city
                          state: state
                          zipcode: zipcode
                          street: street
                          number: number
                          country: country
                    - externalId: 1111111111-10
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                    - externalId: 1111111111-11
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                        address:
                          city: city
                          state: state
                          zipcode: zipcode
                          street: street
                          number: number
                          country: country
                    - externalId: 1111111111-12
                      beneficiary:
                        type: INDIVIDUAL
                        name: BeneficiaryName
                        lastname: BeneficiaryLastname
                        document:
                          id: EXTF900101NI1
                          type: RFC
                        address:
                          city: city
                          state: state
                          zipcode: zipcode
                          street: street
                          number: number
                          country: country
            examples:
              100 - Batch Process Virtual Account in progress.:
                value:
                  externalId: de14bcf2-45ee-22e3-ab59-99c3fcba31e8
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
                  country: MEX
                  name: Virtual Account
                  accounts:
                    - externalId: 9210b519-5c29-4419-8d28-04f7543a914f
                      beneficiary:
                        type: INDIVIDUAL
                        name: Zhang
                        lastname: Wei
                        document:
                          id: EXTF900101NI1
                          type: RFC
                    - externalId: e4914217-41bc-49a5-b2f8-df950bf9bae7
                      beneficiary:
                        type: INDIVIDUAL
                        name: John
                        lastname: Doe
                        document:
                          id: EXTF900101NI2
                          type: RFC
              300 - Invalid params.:
                value:
                  externalId: de14bcf2-45ee-22e3-ab59-99c3fcba31e8
                  accountNumber: '{{accountNumber}}'
                  country: MEX
                  name: Virtual Account
                  accounts:
                    - externalId: 9210b519-5c29-4419-8d28-04f7543a914f
                    - externalId: e4914217-41bc-49a5-b2f8-df950bf9bae7
                      beneficiary:
                        type: INDIVIDUAL
                        name: John
                        lastname: Doe
                        document:
                          id: EXTF900101NI2
                          type: RFC
      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 na 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:
                    $ref: '#/components/schemas/status'
                  comment:
                    type: string
                    description: Informações adicionais.
                  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.
                x-examples:
                  Example 1:
                    externalId: 7facbbbf-d279-4ab5-9aeb-7583fa3f35ec
                    internalId: 1748f8f8-dcac-45d7-b1fc-7d6569245d84
                    accountNumber: '{{YourAccountNumber}}'
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Batch Process Virtual Account in progress
                    comment: >-
                      For obtaining the asynchronous response, kindly submit a
                      request to the service after a brief interval. GET
                      {api_environment_url}/api/virtual-account-batch/7facbbbf-d279-4ab5-9aeb-7583fa3f35ec
              examples:
                100 - Batch Process Virtual Account in progress.:
                  value:
                    externalId: 7facbc4f-4c79-4a15-caeb-75833a3f35ec
                    internalId: 1748f8f8-dcac-4547-b3fb-7d6529245d84
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Batch Process Virtual Account in progress
                    comment: >-
                      For obtaining the asynchronous response, kindly submit a
                      request to the service after a brief interval. GET
                      {api_environment_url}/api/virtual-account-batch/7facbbbf-d279-4ab5-9aeb-7583fa3f35ec
                300 - Invalid params.:
                  value:
                    externalId: 2f3cb0ac-1c4b-471d-a43f-1af10867d716
                    status:
                      code: '300'
                      description: REJECTED
                      detail: Invalid param + [document.id] + verification failed
                    errors:
                      - code: '300'
                        detail: Invalid param + [document.id] + verification failed
                501 - Country not found.:
                  value:
                    externalId: 75743a87-6d5e-42c4-a2ff-c596a6a27182
                    status:
                      code: '501'
                      description: REJECTED
                      detail: Country not found
                    errors:
                      - code: '501'
                        detail: Country not found
        '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-03T14:52:43.271+00:00'
                    status: 400
                    error: Bad Request.
                    message: Count can not be blank
                    path: /virtual-account/batch
              examples:
                400 - Count can not be blank.:
                  value:
                    timestamp: '2025-01-03T14:52:43.271+00:00'
                    status: 400
                    error: Bad Request.
                    message: Count can not be blank
                    path: /virtual-account/batch
                400 - External ID already used - Duplication.:
                  value:
                    timestamp: '2025-01-03T22:03:39.657+00:00'
                    status: 400
                    error: Bad Request.
                    message: External ID already used - Duplication
                    path: /virtual-account/batch
        '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
        '500':
          description: Erro do Servidor Interno
          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-03T22:02:09.745+00:00'
                    status: 500
                    error: Internal Server Error
                    message: >-
                      query did not return a unique result: 12; nested exception
                      is javax.persistence.NonUniqueResultException: query did
                      not return a unique result: 12
                    path: /virtual-account/batch
              examples:
                500 - Query did not return a unique result.:
                  value:
                    timestamp: '2025-01-03T22:02:09.745+00:00'
                    status: 500
                    error: Internal Server Error
                    message: >-
                      query did not return a unique result: 12; nested exception
                      is javax.persistence.NonUniqueResultException: query did
                      not return a unique result: 12
                    path: /virtual-account/batch
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  schemas:
    status:
      type: object
      title: status
      description: Status da operação.
      properties:
        code:
          type: string
          description: Código de status.
        description:
          type: string
          description: Descrição do status.
        detail:
          type: string
          description: Informações adicionais sobre o status.
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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