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

# Gerar orçamento de parcelamento

Este endpoint gera uma cotação para um plano de parcelamento.

> \**Observação*
>
> Os planos de parcelamento estão disponíveis apenas para pagamentos com cartão de crédito.

**Considerações sobre a moeda:**

A moeda utilizada para o plano de parcelamento pode ser:

* **Moeda local:** A moeda do país selecionado. Nesse caso, o cliente será cobrado em sua moeda local.
* **Moeda da conta:** A moeda da sua conta Localpayment. Se esta moeda for diferente da moeda local, a Localpayment realizará uma conversão cambial para obter o valor equivalente na moeda local. Essa conversão será refletida no seu extrato bancário.

> **Observação**
>
> Para países com várias moedas oficiais, o parâmetro `paymentMethod.code` é usado para especificar a moeda da transação. Isso garante que o pagamento seja processado na moeda correta para o método de pagamento escolhido.

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

## Considerações sobre a moeda:

A moeda utilizada para o plano de parcelamento pode ser:

* **Moeda local**: A moeda do país selecionado. Nesse caso, o cliente será cobrado em sua moeda local.\_
* **Moeda da conta:** A moeda da sua conta Localpayment. Se esta moeda for diferente da moeda local, a Localpayment realizará uma conversão cambial para obter o valor equivalente na moeda local. Essa conversão será refletida no seu extrato bancário.

> [!NOTE]
>
> **Observação**
>
> Para países com várias moedas oficiais, o parâmetro `paymentMethod.code` é usado para especificar a moeda da transação. Isso garante que o pagamento seja processado na moeda correta para o método de pagamento escolhido.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/installments-plans
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/installments-plans:
    post:
      summary: Gerar orçamento de parcelamento
      operationId: installments-plan-quote
      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
                  description: >-
                    Especifica o método de pagamento utilizado ou solicitado
                    para a transação.
                  properties:
                    code:
                      type: string
                      description: >-
                        [Código do método de
                        pagamento](/pt-br/reference/get-available-payment-methods).
                        Apenas `paymentMethodType = CreditCard`.
                  required:
                    - code
                country:
                  type: string
                  enum:
                    - ARG
                    - BOL
                    - BRA
                    - CHL
                    - COL
                    - CRI
                    - DOM
                    - GTM
                    - HND
                    - MEX
                    - PAN
                    - PRY
                    - PER
                  description: >-
                    [País](/pt-br/reference/country-codes) em que o pagamento
                    será processado. ISO 3166-1 alfa-3.
                currency:
                  type: string
                  enum:
                    - ARS
                    - BOB
                    - BRL
                    - CLP
                    - COP
                    - CRC
                    - DOP
                    - USD
                    - GTQ
                    - MXN
                    - PYG
                    - PEN
                  description: >-
                    A [moeda](/pt-br/reference/currency-codes) na qual o valor é
                    expresso.
                amount:
                  type: number
                  description: O valor será dividido em parcelas.
                accountNumber:
                  type: string
                  description: Número da conta Localpayment na qual o valor será creditado.
              required:
                - paymentMethod
                - country
                - currency
                - amount
                - accountNumber
              x-examples:
                Example 1:
                  paymentMethod:
                    code: '1000'
                  country: ARG
                  currency: ARS
                  amount: 1000
                  accountNumber: '{{accountNumber}}'
            examples:
              Installments Plan Quote:
                value:
                  paymentMethod:
                    code: '1000'
                  country: ARG
                  currency: ARS
                  amount: 1000
                  accountNumber: '{{accountNumber}}'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  installmentsToken:
                    type: string
                    description: >-
                      Um identificador único para o plano de parcelamento. Este
                      token é usado para referenciar as opções de parcelamento
                      específicas geradas para uma transação.
                  creationDate:
                    type: string
                    description: >-
                      A data e a hora em que o plano de parcelamento foi criado.
                      O registro de data e hora segue o formato ISO 8601.
                  expirationDate:
                    type: string
                    description: >-
                      A data e hora de expiração do plano de parcelamento. 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: O código da moeda correspondente ao valor da transação.
                  amount:
                    type: number
                    description: >-
                      O valor total da transação para a qual o plano de
                      parcelamento foi gerado.
                  installments:
                    type: array
                    items:
                      type: object
                      properties:
                        installments:
                          type: integer
                          description: Número de parcelas disponíveis para esta opção.
                        installmentAmount:
                          type: number
                          description: O valor a ser pago em cada parcela.
                        totalPaymentAmount:
                          type: number
                          description: >-
                            O valor total a ser pago em todas as parcelas,
                            incluindo quaisquer taxas de financiamento.
                        financingFee:
                          type: number
                          description: >-
                            A taxa adicional cobrada pelo financiamento da
                            transação em um número selecionado de parcelas.
                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
                        financingFee: 200
                      - installments: 3
                        installmentAmount: 941.7187
                        totalPaymentAmount: 2825.156
                        financingFee: 825.156
                      - installments: 6
                        installmentAmount: 633.17334
                        totalPaymentAmount: 3799.04
                        financingFee: 1799.04
              examples:
                200 - Installment Plan Quote:
                  value:
                    installmentsToken: bc1a1973-fadc-427b-b014-e43eb4462e82
                    creationDate: '2025-01-29T23: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
                        financingFee: 200
                      - installments: 3
                        installmentAmount: 941.7187
                        totalPaymentAmount: 2825.156
                        financingFee: 825.156
                      - installments: 6
                        installmentAmount: 633.17334
                        totalPaymentAmount: 3799.04
                        financingFee: 1799.04
        '201':
          description: Criado
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Código de status.
                      detail:
                        type: string
                        description: Detalhes adicionais da resposta.
                    required:
                      - code
                      - detail
                required:
                  - status
              examples:
                829 - System error to generate Installment Plan.:
                  value:
                    status:
                      code: '829'
                      detail: System error to generate Installment Plan
        '400':
          description: Solicitação inválida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Código de status.
                      detail:
                        type: string
                        description: Detalhes adicionais da resposta.
                    required:
                      - code
                      - detail
                required:
                  - status
              examples:
                300 - Invalid param.:
                  value:
                    status:
                      code: '300'
                      detail: Invalid param + [paymentMethod] + [Is mandatory]
        '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.
                required:
                  - detail
                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.
        '404':
          description: Não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Código de status.
                      detail:
                        type: string
                        description: Detalhes adicionais da resposta.
                    required:
                      - code
                      - detail
                required:
                  - status
              examples:
                300 - Instalment Payment Plan is only for types of Credit Card methods:
                  value:
                    status:
                      code: '300'
                      detail: >-
                        Instalment Payment Plan is only for types of Credit Card
                        methods
      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.