> ## 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 uma Virtual Account

Este endpoint permite criar múltiplas Virtual Accounts para receber transferências bancárias ACH locais. Ao atribuir essas contas a comerciantes ou usuários finais específicos, você pode simplificar o processo de conciliação e aprimorar o rastreamento de transações.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/virtual-account
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:
    post:
      summary: Criar uma Virtual Account
      operationId: create-virtual-account
      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 rotular e
                    rastrear Virtual Accounts dentro do seu sistema. Este ID
                    será a principal referência para todas as operações futuras
                    nesta conta (por exemplo, verificar o status, desativar,
                    excluir). Para garantir a exclusividade e evitar conflitos,
                    recomendamos fortemente o uso do formato UUID4.
                accountNumber:
                  type: string
                  description: Número da conta Localpayment.
                country:
                  type: string
                  enum:
                    - ARG
                    - BRA
                    - CHL
                    - COL
                    - MEX
                    - PER
                  description: '[País](/pt-br/reference/country-codes). ISO 3166-1 alfa-3.'
                beneficiary:
                  type: object
                  title: beneficiário
                  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:
                    entityId:
                      type: string
                      format: uuid
                      description: >-
                        O ID da entidade que representa este beneficiário,
                        retornado ao registrá-lo com `POST
                        /api/entity/v1/entities`. Obrigatório quando `country` é
                        `BRA`. Registre a entidade antes de criar a conta
                        virtual.
                      examples:
                        - 7c9e6679-7425-40de-944b-e07fc1f90ae7
                    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
                    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
                    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'
                    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:
                            - ARG
                        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
                    website:
                      type: string
                      description: Site do beneficiário.
                  required:
                    - type
                    - name
                    - document
                  examples:
                    - type: COMPANY
                      name: Acme
                      document:
                        type: RUC
                        id: '1791234561009'
              required:
                - externalId
                - accountNumber
                - country
                - beneficiary
              x-examples:
                Example 1:
                  externalId: '{{externalId}}'
                  accountNumber: '{{YourAccountNumber}}'
                  country: MEX
                  beneficiary:
                    document:
                      id: LEKF8111119Z5
                      type: RFC
                    name: BeneficiaryName
                    lastname: BeneficiaryLastname
                    type: INDIVIDUAL
                    address:
                      city: City
                      state: State
                      zipcode: zipcode
                      street: street
                      number: number
                      country: country
            examples:
              ARG-LOCAL COMPANY:
                value:
                  country: ARG
                  beneficiary:
                    type: COMPANY
                    document:
                      id: 30-71234567-9
                      type: CUIT
                    name: ACME INTERNATIONAL LTD
                    lastName: ''
                    address:
                      street: Av. Corrientes
                      number: '1234'
                      city: Buenos Aires
                      state: CABA
                      country: Argentina
                    website: https://yongxin.technology.com
                  externalId: de14bcf2-15ee-22e3-ab59-99c3fcba31e8
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              ARG-FOREIGN COMPANY:
                value:
                  country: ARG
                  beneficiary:
                    type: COMPANY
                    name: ACME INTERNATIONAL LTD
                    document:
                      type: TAX ID
                      id: '20342231111'
                    address:
                      street: Calle 34
                      number: '123'
                      city: Rio de Janeiro
                      state: Rio de Janeiro
                      country: Brazil
                    website: https://yongxin.technology.com
                  externalId: de14bcf2-15ee-22e3-ab59-99c3fcba31e8
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              ARG-FOREIGN INDIVIDUAL:
                value:
                  country: ARG
                  beneficiary:
                    type: INDIVIDUAL
                    document:
                      type: TAX ID
                      id: '20342231111'
                    name: Zhang
                    lastName: Wei
                    address:
                      street: Calle 34
                      number: '123'
                      city: Rio de Janeiro
                      state: Rio de Janeiro
                      country: Brazil
                    website: https://yongxin.technology.com
                  externalId: de14bcf2-15ee-22e3-ab59-99c3fcba31e8
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              BRA-COMPANY:
                value:
                  country: BRA
                  beneficiary:
                    entityId: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                    type: COMPANY
                    document:
                      id: '20342231111'
                      type: TAX ID
                    name: ACME INTERNATIONAL LTD
                    lastName: ''
                    address:
                      street: Calle 34
                      number: '123'
                      city: Rio de Janeiro
                      state: Rio de Janeiro
                      country: Brazil
                    website: https://yongxin.technology.com
                  externalId: 7ad8bd1f-7227-4de7-9683-ff1f8ad635c5
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              BRA-INDIVIDUAL:
                value:
                  country: BRA
                  beneficiary:
                    entityId: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                    type: INDIVIDUAL
                    document:
                      id: '20342231111'
                      type: TAX ID
                    name: Zhang
                    lastName: Wei
                    address:
                      street: Calle 34
                      number: '123'
                      city: Rio de Janeiro
                      state: Rio de Janeiro
                      country: Brazil
                    website: https://yongxin.technology.com
                  externalId: 7ad8bd1f-7227-4de7-9683-ff1f8ad635c5
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              MEX-SPEI/TEF-COMPANY:
                value:
                  country: MEX
                  beneficiary:
                    type: COMPANY
                    document:
                      id: '20342231111'
                      type: TAX ID
                    name: ACME INTERNATIONAL LTD
                    lastName: ''
                    address:
                      street: Calle 34
                      number: '123'
                      city: Guadalajara
                      state: Jalisco
                      country: Mexico
                    website: https://yongxin.technology.com
                  externalId: fb5c9683-cfac-40c9-b81d-ad99de86c0d2
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              MEX-SPEI/TEF-INDIVIDUAL:
                value:
                  country: MEX
                  beneficiary:
                    type: INDIVIDUAL
                    document:
                      id: '20342231111'
                      type: TAX ID
                    name: Zhang
                    lastName: Wei
                    address:
                      street: Calle 34
                      number: '123'
                      city: Guadalajara
                      state: Jalisco
                      country: Mexico
                    website: https://yongxin.technology.com
                  externalId: fb5c9683-cfac-40c9-b81d-ad99de86c0d2
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              MEX-SPID-COMPANY:
                value:
                  country: MEX
                  beneficiary:
                    type: COMPANY
                    document:
                      id: '20342231111'
                      type: TAX ID
                    name: ACME INTERNATIONAL LTD
                    lastName: ''
                    address:
                      street: Calle 34
                      number: '123'
                      city: Guadalajara
                      state: Jalisco
                      country: Mexico
                    website: https://yongxin.technology.com
                  externalId: 1f6b6f3a-3c3f-4e08-ba14-ac0d2a521ad5
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              PER-COMPANY:
                value:
                  country: PER
                  beneficiary:
                    type: COMPANY
                    document:
                      id: '20342231111'
                      type: TAX ID
                    name: John
                    lastName: Doe
                    address:
                      street: Av. Javier Prado Este
                      number: '456'
                      city: Lima
                      state: Lima
                      country: PER
                    website: https://yongxin.technology.com
                  externalId: d09ed2d5-7460-4ac8-8889-3644cbe29082
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              PER-INDIVIDUAL:
                value:
                  country: PER
                  beneficiary:
                    type: INDIVIDUAL
                    document:
                      id: '20342231111'
                      type: TAX ID
                    name: Zhang
                    lastName: Wei
                    address:
                      street: Av. Javier Prado Este
                      number: '456'
                      city: Lima
                      state: Lima
                      country: PER
                    website: https://yongxin.technology.com
                  externalId: d09ed2d5-7460-4ac8-8889-3644cbe29082
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              COL - COMPANY:
                value:
                  country: COL
                  beneficiary:
                    type: COMPANY
                    document:
                      type: NIT
                      id: '1111111111'
                    address:
                      street: cra 49
                      number: '108'
                      city: MEDELLIN
                      state: Antioquia
                      country: COL
                    name: ACME INTERNATIONAL LTD
                    lastName: ''
                    website: https://yongxin.technology.com
                  externalId: cf194632-7ec4-4a44-9b92-9bbacad5349e
                  accountNumber: '{{accountNumber}}'
              CRI - COMPANY:
                value:
                  country: CRI
                  beneficiary:
                    type: COMPANY
                    document:
                      type: CEJ
                      id: '3100000001'
                    name: Test Merchant S.A.
                    lastName: ''
                    address:
                      street: Av. Central
                      number: '100'
                      city: San José
                      state: San José
                      country: Costa Rica
                    website: https://testmerchant.com
                  externalId: de14bcf2-15ee-22e3-ab59-99c3fcba31e8
                  accountNumber: '{{accountNumber}}'
              CHL-INDIVIDUAL:
                value:
                  country: CHL
                  beneficiary:
                    type: INDIVIDUAL
                    document:
                      type: TAX ID
                      id: '20342231111'
                    name: Zhang
                    lastName: Wei
                    address:
                      street: Calle Merced
                      number: '812'
                      city: Santiago
                      state: Region Metropolitana
                      country: Chile
                    website: https://yongxin.technology.com
                  externalId: c4894e1a-b1a1-49fc-acb8-b48d30f19208
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
              CHL-COMPANY:
                value:
                  country: CHL
                  beneficiary:
                    type: COMPANY
                    document:
                      id: '20342231111'
                      type: TAX ID
                    name: ACME INTERNATIONAL LTD
                    lastName: ''
                    address:
                      street: Calle Merced
                      number: '812'
                      city: Santiago
                      state: Region Metropolitana
                      country: Chile
                    website: https://yongxin.technology.com
                  externalId: b367854e-3331-4ed4-ae8c-01f653809a27
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
      responses:
        '201':
          description: Criado
          content:
            application/json:
              schema:
                type: object
                properties:
                  currency:
                    type: string
                    enum:
                      - ARS
                      - BRL
                      - CLP
                      - COP
                      - USD
                      - MXN
                      - PEN
                    description: '[código da moeda](/pt-br/reference/currency-codes).'
                  externalId:
                    type: string
                    description: >-
                      O identificador único da Virtual Account. Esse é o mesmo
                      valor `externalId` fornecido na solicitação de criação,
                      confirmando que ela foi registrada com sucesso em nosso
                      sistema. Utilize este identificador exato para todas as
                      chamadas de API subsequentes relacionadas a esta conta.
                  internalId:
                    type: string
                    description: Identificador de transação da Localpayment.
                  accountNumber:
                    type: string
                    description: Número da conta Localpayment.
                  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.
                      lastName:
                        type: string
                        description: Sobrenome do beneficiário.
                      fullName:
                        type: string
                        description: Nome completo do beneficiário.
                      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'
                        examples:
                          - type: RUC
                            id: '1791234561009'
                      address:
                        type: object
                        description: >-
                          Endereço do beneficiário. Para respostas que incluem
                          um objeto de comerciante, o endereço do beneficiário é
                          fornecido nesse local.
                        properties:
                          street:
                            type: string
                            description: Nome da rua.
                          number:
                            type: string
                            description: Número da rua.
                          city:
                            type: string
                            description: Cidade.
                          state:
                            type: string
                            description: Estado
                          country:
                            type: string
                            description: País do endereço.
                          zipCode:
                            type: string
                            description: CEP.
                          comment:
                            type: string
                            description: Informações adicionais sobre o endereço.
                      merchant:
                        type: object
                        description: >-
                          O objeto do comerciante na resposta da API contém os
                          detalhes da sua empresa, que nosso sistema referencia
                          internamente. Isso garante que, embora sejamos o
                          titular legal da conta para fins de conformidade,
                          todas as transações e a própria conta sejam
                          corretamente atribuídas à sua empresa para fins de
                          relatórios e conciliação.
                        properties:
                          type:
                            type: string
                            enum:
                              - INDIVIDUAL
                              - COMPANY
                            description: Tipo de comerciante.
                          name:
                            type: string
                            description: Nome do comerciante.
                          lastName:
                            type: string
                            description: Sobrenome do comerciante.
                          fullName:
                            type: string
                            description: Nome completo do comerciante.
                          document:
                            type: object
                            description: Documento de identidade do comerciante.
                            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.
                              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.
                          address:
                            type: object
                            description: Endereço do beneficiário.
                            properties:
                              street:
                                type: string
                                description: Nome da rua.
                              number:
                                type: string
                                description: Número da rua.
                              city:
                                type: string
                                description: Cidade.
                              state:
                                type: string
                                description: Estado.
                              country:
                                type: string
                                description: País do endereço.
                              zipCode:
                                type: string
                                description: CEP.
                              comment:
                                type: string
                                description: Informações adicionais sobre o endereço.
                          website:
                            type: string
                            description: Site do beneficiário.
                      website:
                        type: string
                        description: >-
                          Site do beneficiário. Para respostas que incluem um
                          objeto de comerciante, o site do beneficiário é
                          fornecido ali.
                  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).
                        examples:
                          - '100'
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                        examples:
                          - INPROGRESS
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                        examples:
                          - Virtual account in progress
                  errors:
                    type: array
                    description: Informações adicionais sobre o erro.
                    items:
                      type: object
                      additionalProperties: false
                x-examples:
                  Example 1:
                    currency: MXN
                    externalId: '1735854597'
                    internalId: 0a8bb236-98ac-497e-983a-3ff8fc527d22
                    accountNumber: '{{accountNumber}}'
                    beneficiary:
                      type: INDIVIDUAL
                      name: FirtName
                      document:
                        type: RFC
                        id: EXTF900101NI1
                      fullName: FirtName LastName
                      lastName: LastName
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
              examples:
                100-ARG-LOCAL COMPANY:
                  value:
                    currency: ARS
                    externalId: de14bcf2-15ee-22e3-ab59-99c3fcba31e8
                    internalId: 5ba31ea0-669b-43f6-88a1-1601f3cade0a
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: COMPANY
                      name: ACME INTERNATIONAL LTD
                      fullName: ACME INTERNATIONAL LTD
                      document:
                        type: CUIT
                        id: 30-71234567-9
                      address:
                        street: Av. Corrientes
                        number: '1234'
                        city: Buenos Aires
                        state: CABA
                        country: Argentina
                      website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-ARG-FOREIGN COMPANY:
                  value:
                    currency: ARS
                    externalId: de14bcf2-15ee-22e3-ab59-99c3fcba31e8
                    internalId: 5ba31ea0-669b-43f6-88a1-1601f3cade0a
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: COMPANY
                      name: LOCALPAYMENT S.R.L.
                      fullName: LOCALPAYMENT S.R.L
                      document:
                        type: CUIT
                        id: 30-71234562-8
                      merchant:
                        type: COMPANY
                        name: ACME INTERNATIONAL LTD
                        fullName: ACME INTERNATIONAL LTD
                        document:
                          type: TAX ID
                          id: '20342231111'
                        address:
                          street: Calle 34
                          number: '123'
                          city: Rio de Janeiro
                          state: Rio de Janeiro
                          country: Brazil
                        website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-ARG-FOREIGN INDIVIDUAL:
                  value:
                    currency: ARS
                    externalId: de14bcf2-15ee-22e3-ab59-99c3fcba31e8
                    internalId: 5ba31ea0-669b-43f6-88a1-1601f3cade0a
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: COMPANY
                      name: LOCALPAYMENT S.R.L.
                      fullName: LOCALPAYMENT S.R.L
                      document:
                        type: CUIT
                        id: 30-71234562-8
                      merchant:
                        type: INDIVIDUAL
                        name: Zhang
                        lastName: Wei
                        fullName: Zhang Wei
                        document:
                          type: TAX ID
                          id: '20342231111'
                        address:
                          street: Calle 34
                          number: '123'
                          city: Rio de Janeiro
                          state: Rio de Janeiro
                          country: Brazil
                        website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-BRA-COMPANY:
                  value:
                    currency: BRL
                    externalId: 7ad8bd1f-7227-4de7-9683-ff1f8ad635c5
                    internalId: b8f9428f-3a68-42b7-a761-f2a7b689839c
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: COMPANY
                      name: LP DO BRASIL INSTITUICAO DE PAGAMENTOS LTDA
                      fullName: LP DO BRASIL INSTITUICAO DE PAGAMENTOS LTDA
                      document:
                        type: CNPJ
                        id: '34669130000133'
                      bank:
                        branch: {}
                        account:
                          type: ''
                          number: ''
                      merchant:
                        type: COMPANY
                        name: ACME INTERNATIONAL LTD
                        fullName: ACME INTERNATIONAL LTD
                        document:
                          type: TAX ID
                          id: '20342231111'
                        address:
                          street: Calle 34
                          number: '123'
                          city: Rio de Janeiro
                          state: Rio de Janeiro
                          country: Brazil
                        website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                    disabled: false
                100-BRA-INDIVIDUAL:
                  value:
                    currency: BRL
                    externalId: 7ad8bd1f-7227-4de7-9683-ff1f8ad635c5
                    internalId: f3a72b91-c4e5-4d8a-b7e2-9f1c3d6a5b8e
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: COMPANY
                      name: LP DO BRASIL INSTITUICAO DE PAGAMENTOS LTDA
                      fullName: LP DO BRASIL INSTITUICAO DE PAGAMENTOS LTDA
                      document:
                        type: CNPJ
                        id: '34669130000133'
                      bank:
                        branch: {}
                        account:
                          type: ''
                          number: ''
                      merchant:
                        type: INDIVIDUAL
                        name: Zhang
                        lastName: Wei
                        fullName: Zhang Wei
                        document:
                          type: TAX ID
                          id: '20342231111'
                        address:
                          street: Calle 34
                          number: '123'
                          city: Rio de Janeiro
                          state: Rio de Janeiro
                          country: Brazil
                        website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                    disabled: false
                100-MEX-SPEI/TEF-COMPANY:
                  value:
                    currency: MXN
                    externalId: fb5c9683-cfac-40c9-b81d-ad99de86c0d2
                    internalId: 9a8db65f-be31-42fb-8ebd-5fffd83bd6c6
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: COMPANY
                      name: ACME INTERNATIONAL LTD
                      fullName: ACME INTERNATIONAL LTD
                      lastName: ''
                      document:
                        type: TAX ID
                        id: '20342231111'
                      address:
                        street: Calle 34
                        number: '123'
                        city: Guadalajara
                        state: Jalisco
                        country: Mexico
                      website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-MEX-SPEI/TEF-INDIVIDUAL:
                  value:
                    currency: MXN
                    externalId: fb5c9683-cfac-40c9-b81d-ad99de86c0d2
                    internalId: 9a8db65f-be31-42fb-8ebd-5fffd83bd6c6
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: INDIVIDUAL
                      name: Zhang
                      fullName: Zhang Wei
                      lastName: Wei
                      document:
                        type: TAX ID
                        id: '20342231111'
                      address:
                        street: Calle 34
                        number: '123'
                        city: Guadalajara
                        state: Jalisco
                        country: Mexico
                      website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-MEX-SPID-COMPANY:
                  value:
                    currency: USD
                    externalId: 1f6b6f3a-3c3f-4e08-ba14-ac0d2a521ad5
                    internalId: 43aa5b5b-7566-4630-b86f-afb8486ccab4
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: COMPANY
                      name: ACME INTERNATIONAL LTD
                      fullName: ACME INTERNATIONAL LTD
                      lastName: ''
                      document:
                        type: TAX ID
                        id: '20342231111'
                      address:
                        street: Calle 34
                        number: '123'
                        city: Guadalajara
                        state: Jalisco
                        country: Mexico
                      website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                    disabled: false
                100-PER-COMPANY:
                  value:
                    externalId: d09ed2d5-7460-4ac8-8889-3644cbe29082
                    internalId: 5ba31ea0-669b-43f6-88a1-1601f3cade0a
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    country: PER
                    currency: PEN
                    beneficiary:
                      type: COMPANY
                      name: ACME INTERNATIONAL LTD
                      fullName: ACME INTERNATIONAL LTD
                      lastName: ''
                      document:
                        id: '20342231111'
                        type: TAX ID
                      address:
                        street: Av. Javier Prado Este
                        number: '456'
                        city: Lima
                        state: Lima
                        country: PER
                      website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-PER-INDIVIDUAL:
                  value:
                    externalId: d09ed2d5-7460-4ac8-8889-3644cbe29082
                    internalId: 5ba31ea0-669b-43f6-88a1-1601f3cade0a
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    country: PER
                    currency: PEN
                    beneficiary:
                      type: INDIVIDUAL
                      name: Zhang
                      fullName: Zhang Wei
                      lastName: Wei
                      document:
                        id: '20342231111'
                        type: TAX ID
                      address:
                        street: Av. Javier Prado Este
                        number: '456'
                        city: Lima
                        state: Lima
                        country: PER
                      website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-COL- FOREIGN COMPANY:
                  value:
                    currency: COP
                    externalId: cf194632-7ec4-4a44-9b92-9bbacad5349e
                    internalId: b406472d-e5df-4ca3-8829-3e3df0948b3d
                    accountNumber: '{{accountNumber}}'
                    beneficiary:
                      type: COMPANY
                      name: ACME INTERNATIONAL LTD
                      fullName: ACME INTERNATIONAL LTD
                      document:
                        type: DNI
                        id: '12487201'
                      address:
                        street: Shennan Boulevard
                        number: '1234'
                        city: Shenzhen
                        state: Guangdong
                        country: China
                        zipCode: '518000'
                        comment: Center Area
                      website: contact@acme-international.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-CRI - COMPANY:
                  value:
                    currency: CRC
                    externalId: de14bcf2-15ee-22e3-ab59-99c3fcba31e8
                    internalId: 6884af9b-f844-42b7-9488-293e8052931c
                    accountNumber: '{{accountNumber}}'
                    country: CRI
                    beneficiary:
                      type: COMPANY
                      name: Test Merchant S.A.
                      fullName: Test Merchant S.A.
                      lastName: ''
                      document:
                        type: CEJ
                        id: '3100000001'
                      address:
                        street: Av. Central
                        number: '100'
                        city: San José
                        state: San José
                        country: Costa Rica
                    wireInstructions:
                      beneficiary:
                        bank:
                          account:
                            number: CR99000000000000000001
                      referenceCode: 6884af9b-f844-42b7-9488-293e8052931c
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-CHL-INDIVIDUAL:
                  value:
                    externalId: c4894e1a-b1a1-49fc-acb8-b48d30f19208
                    internalId: dcf62e96-b753-41b1-8064-6254c7e0abc1
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    country: CHL
                    currency: CLP
                    beneficiary:
                      type: INDIVIDUAL
                      name: Zhang
                      fullName: Zhang Wei
                      lastName: Wei
                      document:
                        type: TAX ID
                        id: '20342231111'
                      address:
                        street: Calle Merced
                        number: '812'
                        city: Santiago
                        state: Region Metropolitana
                        country: Chile
                      website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
                100-CHL-COMPANY:
                  value:
                    currency: CLP
                    externalId: b367854e-3331-4ed4-ae8c-01f653809a27
                    internalId: 921792b6-5aac-4e41-a79b-ab080ad7f649
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: COMPANY
                      name: ACME INTERNATIONAL LTD
                      fullName: ACME INTERNATIONAL LTD
                      lastName: ''
                      document:
                        id: '20342231111'
                        type: TAX ID
                      address:
                        street: Calle Merced
                        number: '812'
                        city: Santiago
                        state: Region Metropolitana
                        country: Chile
                      website: https://yongxin.technology.com
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Virtual account in progress
                    errors: []
        '400':
          description: Solicitação inválida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  externalId:
                    type: string
                    description: >-
                      O identificador único da Virtual Account. Esse é o mesmo
                      valor `externalId` fornecido na solicitação de criação,
                      confirmando que ela foi registrada com sucesso em nosso
                      sistema. Utilize este identificador exato para todas as
                      chamadas de API subsequentes relacionadas a esta conta.
                  internalId:
                    type: string
                    description: Identificador de transação da 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:
                          - REJECTED
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                  errors:
                    type: array
                    description: Lista de erros que ocorreram durante a transação.
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: Código de erro.
                        detail:
                          type: string
                          description: Detalhes do erro.
                x-examples:
                  Example 1:
                    externalId: '1735854339'
                    internalId: f2c1d9b0-090d-4692-b8d6-728b0bb67e80
                    status:
                      code: '300'
                      description: REJECTED
                      detail: Invalid param + [document.id] + verification failed
                    errors:
                      - code: '300'
                        detail: Invalid param + [document.id] + verification failed
              examples:
                300 - Invalid param.:
                  value:
                    externalId: '1234567890'
                    internalId: f2d9d9b0-093d-469b-c8d6-728b0cc67e80
                    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: '1735858911'
                    internalId: 9442ab1b-cf3e-445b-9469-cef6340f145a
                    status:
                      code: '501'
                      description: REJECTED
                      detail: Country not found
                    errors:
                      - code: '501'
                        detail: Country not found
                812 - External Id already used - duplication.:
                  value:
                    externalId: '1735858911'
                    internalId: f5c4529e-67c1-43e0-bc2a-97250e736c98
                    status:
                      code: '812'
                      description: REJECTED
                      detail: External Id already used - duplication
                    errors:
                      - code: '812'
                        detail: External Id already used - duplication
                822 - Invalid relationship between provider and payment method.:
                  value:
                    externalId: 1b3e1fe0-2c1e-41cb-832b-20d90653aebc
                    internalId: 00a918d1-6217-4afa-a36f-4ad9d369754a
                    status:
                      code: '822'
                      description: REJECTED
                      detail: Invalid relationship between provider and payment method
                    errors:
                      - code: '822'
                        detail: >-
                          Invalid relationship between provider and payment
                          method
        '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
        '403':
          description: Proibido
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Informações adicionais sobre a resposta.
                x-examples:
                  Example 1:
                    detail: You do not have permission to perform this action.
              examples:
                403 - You do not have permission to perform this action.:
                  value:
                    detail: You do not have permission to perform this action.
      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.