Parcelamento de fatura
Transforma o saldo de uma fatura de cartão em um acordo de pagamento com parcelas fixas. O emissor configura as regras (quantidade de parcelas, juros, IOF e entrada) e as oferta ao portador. Cada acordo aceito gera um contrato, com parcelas lançadas nas faturas seguintes.
Como funciona
Conceitos
Tipo de acordo: agreementTypeId — a modalidade do acordo. Ex.: 1 = PARCELAMENTO DE FATURA. Consultado em GET /installments/rules/tipos.
Regra de acordo: agreementRuleId — a política comercial: faixas de parcelas e valores, juros, IOF, entrada e limites. É o que você configura uma vez e reutiliza.
Regra padrão: defaultRule: true — a regra usada na geração da fatura, quando nenhuma outra se aplica à conta.
Vínculo: Associação entre uma regra e as contas (bind/accounts) ou os programas (bind/programs) em que ela vale.
Acordo: paymentAgreementId — a instância do parcelamento de uma fatura específica: valor, entrada, parcelas, juros, IOF, CET e status.
Parcela: agreementInstallmentId — cada parcela do acordo, com o invoiceId da fatura em que será lançada.
Programa: Programa de crédito externo, identificado pelo header Program-id.
Jornada completa
As etapas 1 e 2 são de configuração — feitas uma vez, normalmente por um time de produto ou de operações. As etapas 3 a 5 são de runtime, executadas a cada fatura que o portador decide parcelar.
Mapa de endpoints
Configuração - regras
| Endpoint | O que faz |
|---|---|
GET /installments/rules/tipos | Lista os tipos de acordo disponíveis. |
POST /installments/rules | Cria uma regra de parcelamento. |
GET /installments/rules | Lista e filtra regras. |
POST /installments/rules/{agreementRuleId} | Atualiza uma regra existente. |
POST /installments/rules/{agreementRuleId}/plan | Configura os planos enviados na fatura. |
Configuração - vínculos
| Endpoint | O que faz |
|---|---|
POST /installments/rules/{id}/bind/accounts | Vincula contas à regra. |
PATCH /installments/rules/{id}/unbind/accounts | Desvincula contas da regra. |
POST /installments/rules/{id}/bind/programs | Vincula programas de crédito à regra. |
PATCH /installments/rules/{id}/unbind/programs | Desvincula programas da regra. |
Runtime - acordos
| Endpoint | O que faz |
|---|---|
POST /installments/simulate | Simula um parcelamento sem contratá-lo. |
POST /installments/ | Cria o acordo de parcelamento. |
POST /installments/publish | Efetiva a adesão ao acordo no core de cartões. |
GET /installments/ | Lista acordos, com ou sem as parcelas. |
GET /installments/status | Lista os status possíveis de um acordo. |
GET /installments/simulation/history | Histórico de simulações de uma conta. |
DELETE /installments/cancel/{installment} | Solicita o cancelamento de um acordo. |
Autenticação e headers
| Header | Obrigatório | Descrição |
|---|---|---|
| Authorization | Obrigatório | Bearer <ACCESS_TOKEN> |
| Content-Type | Obrigatório | application/json nas requisições com corpo. |
| Program-id | Obrigatório | Id do programa externo em que a operação ocorre. Exigido em todos os endpoints que o aceitam. |

Updated about 5 hours ago