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

# Métodos de pagamento da loja

> O que a loja da chave aceita, sem precisar de cobrança: o gateway de cada método (mesma regra do checkout hospedado), como o cartão deve ser enviado e, com `amountInCents`, a tabela de parcelas (a mesma do checkout hospedado). Considera cobrança em BRL.

`card.input`: `raw` (Asaas, cartão aberto), `pagarme_token` (Pagar.me, tokenize com `pagarmePublicKey`), `efi_token` (Efí, tokenize com `efiPayeeCode`), `hosted_only` (Stripe, só checkout hospedado). Método indisponível: `available: false`, `provider: null` e, no cartão, `input: null`.

Serve também para validar a chave ao salvar: 200 é chave boa, 401 inválida, 403 sem escopo.

Escopo exigido: `charges:read`.



## OpenAPI

````yaml /openapi.json get /v1/payment-methods
openapi: 3.1.0
info:
  title: Gravity Play API
  version: 1.0.0
  description: >-
    API para criar cobranças, receber pagamentos e ler cursos, turmas, alunos e
    progresso da área de membros. Cada chave de API tem escopos; cada operação
    indica o escopo que exige.
servers:
  - url: https://api.sandbox.gravitypay.app
    description: Sandbox (testes) — alvo do try-it
  - url: https://api.gravitypay.app
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Cobranças
    description: >-
      Cobranças avulsas: link de pagamento (checkout hospedado) ou pagamento
      transparente (PIX, boleto e cartão pela API).
  - name: Pagamentos
    description: Vendas da loja e vendedores.
  - name: Assinaturas
    description: Assinaturas da loja, com dados do cliente. Exige `subscriptions:read`.
  - name: Cursos
    description: Cursos da área de membros, com módulos e aulas.
  - name: Turmas
    description: Turmas dos cursos.
  - name: Alunos
    description: 'Alunos, matrículas e progresso. Dado pessoal: exige `students:read`.'
paths:
  /v1/payment-methods:
    get:
      tags:
        - Cobranças
      summary: Métodos de pagamento da loja
      description: >-
        O que a loja da chave aceita, sem precisar de cobrança: o gateway de
        cada método (mesma regra do checkout hospedado), como o cartão deve ser
        enviado e, com `amountInCents`, a tabela de parcelas (a mesma do
        checkout hospedado). Considera cobrança em BRL.


        `card.input`: `raw` (Asaas, cartão aberto), `pagarme_token` (Pagar.me,
        tokenize com `pagarmePublicKey`), `efi_token` (Efí, tokenize com
        `efiPayeeCode`), `hosted_only` (Stripe, só checkout hospedado). Método
        indisponível: `available: false`, `provider: null` e, no cartão, `input:
        null`.


        Serve também para validar a chave ao salvar: 200 é chave boa, 401
        inválida, 403 sem escopo.


        Escopo exigido: `charges:read`.
      operationId: getPaymentMethods
      parameters:
        - name: amountInCents
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: Valor da cobrança. Sem ele, `installments` vem `null`.
        - name: maxInstallments
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 12
            default: 1
          description: Máximo de parcelas (1 a 12).
        - name: passInstallmentInterest
          in: query
          required: false
          schema:
            type: boolean
            default: true
          description: >-
            `true`: o comprador paga o juro do parcelamento; `false`: a loja
            absorve. Mesmo default da cobrança.
      responses:
        '200':
          description: Métodos da loja
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethods'
              example:
                object: payment_methods
                pix:
                  available: true
                  provider: ASAAS
                boleto:
                  available: true
                  provider: ASAAS
                card:
                  available: true
                  provider: ASAAS
                  input: raw
                  pagarmePublicKey: null
                  efiPayeeCode: null
                  efiSandbox: false
                installments:
                  - count: 1
                    installmentInCents: 15900
                    totalInCents: 15900
                    hasInterest: false
                  - count: 2
                    installmentInCents: 8501
                    totalInCents: 17002
                    hasInterest: true
                  - count: 3
                    installmentInCents: 5822
                    totalInCents: 17467
                    hasInterest: true
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/InsufficientScope'
components:
  schemas:
    PaymentMethods:
      type: object
      properties:
        object:
          type: string
          example: payment_methods
        pix:
          $ref: '#/components/schemas/PaymentMethodAvailability'
        boleto:
          $ref: '#/components/schemas/PaymentMethodAvailability'
        card:
          type: object
          properties:
            available:
              type: boolean
            provider:
              type: string
              nullable: true
              enum:
                - ASAAS
                - PAGARME
                - EFI
                - STRIPE
                - null
            input:
              type: string
              nullable: true
              enum:
                - raw
                - pagarme_token
                - efi_token
                - hosted_only
                - null
            pagarmePublicKey:
              type: string
              nullable: true
              description: >-
                Chave pública (pk_) para tokenizar o cartão, quando `input =
                pagarme_token`.
            efiPayeeCode:
              type: string
              nullable: true
              description: >-
                Identificador da conta Efí para tokenizar, quando `input =
                efi_token`.
            efiSandbox:
              type: boolean
        installments:
          type: array
          nullable: true
          description: Só com `amountInCents`; vazio quando o cartão não é de gateway BR.
          items:
            type: object
            properties:
              count:
                type: integer
              installmentInCents:
                type: integer
              totalInCents:
                type: integer
              hasInterest:
                type: boolean
    PaymentMethodAvailability:
      type: object
      properties:
        available:
          type: boolean
        provider:
          type: string
          nullable: true
          enum:
            - ASAAS
            - PAGARME
            - null
    Error:
      type: object
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              description: >-
                `authentication` (401), `insufficient_scope` (403), `forbidden`
                (403, rota de parceiro chamada por outra loja),
                `invalid_request` (400), `not_found` (404) e, no pagamento
                transparente, `payment_declined` (402), `conflict` (409),
                `unprocessable` (422) e `gateway_error` (502).
            code:
              type: string
              description: >-
                Detalhe do `type` no pagamento transparente:
                `charge_not_pending`, `payment_in_progress`,
                `method_unavailable`, `card_input_not_supported`,
                `payment_declined` ou `gateway_error`.
            message:
              type: string
            param:
              type: string
              description: Parâmetro que falhou, em `invalid_request`.
            requiredScope:
              type: string
              description: Escopo que falta, em `insufficient_scope`.
  responses:
    Error:
      description: Erro
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InsufficientScope:
      description: A chave é válida, mas não tem o escopo exigido pela operação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: insufficient_scope
              message: Esta chave de API não tem o escopo students:read.
              requiredScope: students:read
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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