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

# Cotar cobrança

> Valor com o cupom e o total de cada opção de parcela, com ou sem repasse de taxa, antes de tokenizar o cartão no checkout transparente.

> [card]
>
> Requer a permissão `TRANSPARENT:CREATE`.

Calcula quanto o cliente vai pagar no checkout transparente: o valor com o [cupom](https://docs.abacatepay.com/pages/vender/cupons.md) e o total de cada opção de parcela no cartão, com o acréscimo do [repasse de taxa](https://docs.abacatepay.com/pages/pagamentos/repasse-de-taxa.md) quando pedido. Chame do seu servidor, mostre as opções ao cliente e tokenize o cartão com o `total` da opção escolhida.

A cotação não reserva o cupom: o uso só conta quando a cobrança é paga.

## Parâmetros

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `amount` | `integer` | Sim | Preço em centavos, a partir de `100`, o mesmo que vai em `data.amount` na criação |
| `coupon` | `string` | Não | Código de um cupom da sua conta |
| `passFeesToCustomer` | `boolean` | Não | `true` soma o acréscimo da taxa em cada opção. Padrão `false` |

## Resposta

| Campo | Descrição |
| - | - |
| `data.amount` | O `amount` enviado |
| `data.coupon` | O cupom aplicado, ou `null` |
| `data.discount` | Desconto do cupom, em centavos |
| `data.amountAfterDiscount` | Valor com o desconto. É o valor do Pix e do boleto |
| `data.installments` | Opções de parcela no cartão, de 1x até o máximo |
| `data.installments[].installmentCount` | Número de parcelas |
| `data.installments[].installmentAmount` | Valor de cada parcela, arredondado para cima. A diferença sai na última |
| `data.installments[].customerFee` | Acréscimo do repasse de taxa. `0` sem repasse |
| `data.installments[].total` | Total que passa no cartão. É o `amount` do `AbacatePay.create` |

As opções vão até 12x, com pelo menos R\$ 10,00 por parcela do valor com desconto. Sem o parcelamento liberado na sua conta, só vem a opção à vista.

## Erros

| Mensagem | Causa |
| - | - |
| `Could not find coupon <código>` | O cupom não existe na sua conta. |
| `Coupon is not active` | O cupom está desativado ou foi excluído. |
| `Coupon usage limit reached` | O cupom já atingiu o `maxRedeems`. |
| `Price after coupon must be more than 100 or free.` | Com o desconto, o valor ficaria entre R$ 0,01 e R$ 0,99. |
| `Coupon cannot make a transparent charge free` | O cupom zera o valor. |
| `passFeesToCustomer requires card payments through Rinne` | Sua conta ainda não está habilitada para o repasse. Fale com o suporte. |

```bash cURL theme={null}
curl "https://api.abacatepay.com/v2/transparents/quote?amount=30000&coupon=BEMVINDO10&passFeesToCustomer=true" \
  -H "Authorization: Bearer $ABACATEPAY_API_KEY"
```

```json 200 theme={null}
{
  "data": {
    "amount": 30000,
    "coupon": "BEMVINDO10",
    "discount": 3000,
    "amountAfterDiscount": 27000,
    "installments": [
      { "installmentCount": 1, "installmentAmount": 27583, "customerFee": 583, "total": 27583 },
      { "installmentCount": 2, "installmentAmount": 13958, "customerFee": 916, "total": 27916 },
      { "installmentCount": 3, "installmentAmount": 9306, "customerFee": 916, "total": 27916 }
    ]
  },
  "success": true,
  "error": null
}
```

O exemplo mostra só três opções. Os acréscimos dependem das taxas da sua conta.


## OpenAPI

````yaml GET /transparents/quote
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /transparents/quote:
    get:
      summary: Cotar cobrança
      description: >-
        Valor com o cupom e o total de cada opção de parcela no cartão, com o
        acréscimo do repasse de taxa quando pedido. Não reserva o cupom.
      parameters:
        - name: amount
          in: query
          required: true
          description: Preço em centavos, o mesmo de `data.amount` na criação.
          schema:
            type: integer
            minimum: 100
            example: 30000
        - name: coupon
          in: query
          required: false
          description: Código de um cupom da sua conta.
          schema:
            type: string
            example: BEMVINDO10
        - name: passFeesToCustomer
          in: query
          required: false
          description: '`true` soma o acréscimo do repasse de taxa em cada opção.'
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Cotação calculada
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      amount:
                        type: integer
                        example: 30000
                      coupon:
                        type: string
                        nullable: true
                        example: BEMVINDO10
                      discount:
                        type: integer
                        example: 3000
                      amountAfterDiscount:
                        type: integer
                        example: 27000
                      installments:
                        type: array
                        items:
                          type: object
                          properties:
                            installmentCount:
                              type: integer
                              example: 3
                            installmentAmount:
                              type: integer
                              example: 9306
                            customerFee:
                              type: integer
                              example: 916
                            total:
                              type: integer
                              description: >-
                                Total que passa no cartão. É o `amount` do
                                `AbacatePay.create`.
                              example: 27916
                  error:
                    type: string
                    nullable: true
                    example: null
                  success:
                    $ref: '#/components/schemas/Success'
        '400':
          description: Cupom inválido ou repasse não habilitado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Could not find coupon BEMVINDO10
      security:
        - bearerAuth: []
components:
  schemas:
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````

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