> ## 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 Plano de Parcelamento

Este endpoint cria um plano de parcelamento para uma transação de Payin, permitindo que você ofereça aos clientes a flexibilidade de pagar suas compras em parcelas. Você pode especificar o número de parcelas, o valor da parcela e outros detalhes relevantes. A resposta incluirá os detalhes do plano de parcelamento, como o valor total a ser pago e as datas de vencimento de cada parcela.

> **Expiração do token**
>
> O token fornecido na resposta é válido por **10 minutos** a partir do momento em que é gerado. Após esse período, o token expirará e não poderá mais ser usado para processar planos de parcelamento.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/payin/installments-plan
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/payin/installments-plan:
    post:
      summary: Criar Plano de Parcelamento
      operationId: installments
      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:
                paymentMethod:
                  type: object
                  properties:
                    code:
                      type: string
                      description: >-
                        [Código do método de
                        pagamento](/pt-br/reference/get-available-payment-methods).
                  required:
                    - code
                country:
                  type: string
                  description: '[País](/pt-br/reference/country-codes). ISO 3166-1 alfa-3.'
                currency:
                  type: string
                  description: '[código da moeda](/pt-br/reference/currency-codes).'
                amount:
                  type: number
                  description: Valor total.
                accountNumber:
                  type: string
                  description: Número da conta Localpayment.
              required:
                - paymentMethod
                - country
                - currency
                - amount
                - accountNumber
              x-examples:
                Example 1:
                  paymentMethod:
                    code: '1000'
                  country: ARG
                  currency: ARS
                  amount: 2000
                  accountNumber: '{{accountNumber}}'
            examples:
              200 - Installment Plan:
                value:
                  paymentMethod:
                    code: '1000'
                  country: ARG
                  currency: ARS
                  amount: 1000
                  accountNumber: '{{accountNumber}}'
      responses:
        '201':
          description: Criado
          content:
            application/json:
              schema:
                type: object
                properties:
                  installmentsToken:
                    type: string
                    description: >-
                      Identificador único do plano de parcelamento. Este token é
                      usado para referenciar as opções de parcelamento
                      específicas geradas para uma transação.
                  creationDate:
                    type: string
                    description: >-
                      Data e hora em que o plano de parcelamento foi criado. O
                      registro de data e hora segue o formato ISO 8601.
                  expirationDate:
                    type: string
                    description: >-
                      Data e hora em que o plano de parcelamento expira. Após
                      esse período, o plano não poderá mais ser utilizado. O
                      registro de data e hora segue o formato ISO 8601.
                  currency:
                    type: string
                    description: '[Códigos de moeda](/pt-br/reference/currency-codes).'
                  amount:
                    type: number
                    description: >-
                      Valor total da transação para a qual o plano de
                      parcelamento foi gerado.
                  installments:
                    type: array
                    description: >-
                      Matriz de objetos que representam as diferentes opções de
                      parcelamento disponíveis para a transação.
                    items:
                      type: object
                      properties:
                        installments:
                          type: integer
                          description: Número de parcelas disponíveis para esta opção.
                        installmentAmount:
                          type: number
                          description: Valor a ser pago em cada parcela.
                        totalPaymentAmount:
                          type: number
                          description: >-
                            Valor total a ser pago em todas as parcelas,
                            incluindo quaisquer taxas de financiamento.
                        amountWithInternalFee:
                          type: number
                          description: >-
                            Valor total, incluindo as tarifas internas (se
                            aplicável).
                        financingFee:
                          type: number
                          description: >-
                            Taxa adicional cobrada pelo financiamento da
                            transação no número de parcelas selecionado.
                x-examples:
                  Example 1:
                    installmentsToken: b71a6973-ffdc-427b-b014-e03eb4462e82
                    creationDate: '2022-03-29T23:53:52.7150456+00:00'
                    expirationDate: '2022-03-30T00:03:52.71509+00:00'
                    currency: ARS
                    amount: 2000
                    installments:
                      - installments: 2
                        installmentAmount: 1100
                        totalPaymentAmount: 2200
                        amountWithInternalFee: 2200
                        financingFee: 200
                      - installments: 3
                        installmentAmount: 941.7187
                        totalPaymentAmount: 2825.156
                        amountWithInternalFee: 2360
                        financingFee: 825.156
                      - installments: 6
                        installmentAmount: 633.17334
                        totalPaymentAmount: 3799.04
                        amountWithInternalFee: 2800
                        financingFee: 1799.04
              examples:
                200 - Installments.:
                  value:
                    installmentsToken: b71a1973-cfdc-4a7b-b014-e03eb4462e82
                    creationDate: '2025-01-01T23:53:52.7150456+00:00'
                    expirationDate: '2025-01-30T00:03:52.71509+00:00'
                    currency: ARS
                    amount: 2000
                    installments:
                      - installments: 2
                        installmentAmount: 1100
                        totalPaymentAmount: 2200
                        amountWithInternalFee: 2200
                        financingFee: 200
                      - installments: 3
                        installmentAmount: 941.7187
                        totalPaymentAmount: 2825.156
                        amountWithInternalFee: 2360
                        financingFee: 825.156
                      - installments: 6
                        installmentAmount: 633.17334
                        totalPaymentAmount: 3799.04
                        amountWithInternalFee: 2800
                        financingFee: 1799.04
        '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
        '404':
          description: Não encontrado
      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.