Pular para o conteúdo
Pagamentos

Parcelas de crédito da cobrança

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/charges/{id}/installments
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escopospayments.read

No cartão parcelado o comprador paga tudo de uma vez; cada parcela aqui é o dinheiro caindo na conta do recebedor, mês a mês. Só leitura local da agenda: não consulta o processador.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho mín. 1

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

As parcelas de crédito da cobrança na agenda do processador (valor, taxa e líquido reais, previsão e data do crédito) e o resumo settlement. installments: [] antes do pagamento ou enquanto a agenda não chegou.

V1ChargeInstallments

  • chargeIdstring
    • statusstring

      pending_credit: pago, nada creditado ainda; partially_credited: parte das parcelas já caiu; credited: tudo creditado.

      • um de"pending_credit""partially_credited""credited"
    • installmentsinteger

      Parcelas de crédito na agenda do processador (1 no Pix e no cartão à vista).

    • grossAmountinteger

      Bruto das parcelas na agenda, em centavos.

    • platformFeeinteger | null

      Taxas REAIS da agenda do processador, em centavos (positivo). null enquanto o processador não informou.

    • netAmountinteger

      Líquido real: grossAmount − platformFee.

    • creditedAmountinteger

      Já creditado na conta, em centavos.

    • pendingAmountinteger

      Ainda a creditar, em centavos.

    • nextCreditDatestring | null

      Próxima data prevista de crédito (YYYY-MM-DD); null quando tudo já caiu.

    • lastCreditAtstring | null

      Último crédito (ISO); null antes do primeiro.

  • Cada item — V1ChargeInstallment

    • numberinteger | null

      Número da parcela (1-based).

    • ofinteger | null

      Total de parcelas.

    • amountinteger

      Bruto da parcela, em centavos.

    • platformFeeinteger | null

      Taxa real da parcela, em centavos (positivo); null quando não informada.

    • netAmountinteger

      Líquido da parcela: amount − platformFee.

    • creditedAmountinteger
    • pendingAmountinteger
    • statusstring

      Situação do crédito na agenda do processador.

      • um de"scheduled""processing""partially_credited""credited""failed"
    • estimatedCreditDatestring

      Data prevista do crédito (YYYY-MM-DD).

    • creditDatestring | null

      Quando o dinheiro entrou (ISO); null até entrar.