Visão Geral do Reembolso

Um reembolso é um pagamento de parcela da dívida de um empréstimo.

Objeto

Abaixo temos um exemplo de como a api representa um reembolso

{
    "id": "jpw3xehm8f1h2xwc93ua6u1fp",
    "borrowerId": "jpusv7ys5ubj7fqs8tcuwsg8z",
    "proposalId": "jpvzc2gzd6ub5bth38154ddc3",
    "loanId": "jpvzc545kthb87kzmh6sdykfy",
    "paymentDate": "2019-12-31T00:00:00",
    "paymentAmount": 417.73,
    "isNotified": true,
    "creationDate": "2019-12-17T12:19:35",
    "lastUpdateDate": "2020-01-30T13:52:08",
    "lenderId": "FIDC",
    "method": "BalanceRetention"
}

Campos

Os atributos abaixo compõe um reembolso

Campo	Descrição
`id`	Identificador único do reembolso no sistema de Crédito gerado automaticamente
`externalId`	Identificador único no sistema que cobrou o pagamento
`borrowerId`	Identificador do tomador de empréstimo pagador do reembolso
`loanId`	Identificador do empréstimo que recebeu o reembolso
`proposalId`	Identificador da proposta que gerou o empréstimo do reembolso
`date`	Data do pagamento
`method`	Método de pagamento
`lenderId`	Identificador do credor que recebeu o pagamento
`isNotified`	Indica se o credor foi notificado sobre este reembolso
`creationDate`	Data de registro do reembolso
`lastUpdateDate`	Data da última atualização do reembolso

Métodos de pagamento suportados

Método	Descrição
`BalanceRetention`	Pagamento através de retenção automática sobre o saldo de recebíveis na conta de adquirente do tomador
`StoneBankingRetention`	Pagamento através de retenção automática sobre recebíveis na conta de pagamento do tomador
`Boleto`	Muito utilizado em fluxos de exceção para quitação antecipada
`TransactionSplit`	Pagamento através de split nas transações de venda do tomador na adquirente
`Manual`	Utilizado em pagamentos via transferência ou qualquer outro tipo manual de transação
`Pix`	Pagamento através de transferência do tipo Pix

📘
Contrato de Streaming dos dados de Reembolso
Veja Streaming de dados

{
    "Content": [
        {
            "Data": [
                {
                    "LoanId": "jq29cu9cpsnd7ytr6reht5x98",
                    "RepaymentMethod": "StoneBankingRetention",
                    "BorrowerId": "jq29csz53tn15rhwqrfdmgp6h",
                    "PaymentAmount": 72.79,
                    "ProposalId": "jq29cu49ycb936wy72wf9s5h3",
                    "IsNotified": false,
                    "Id": "jq29cuvnt49db366gxv9eh9at",
                    "LenderId": "FIDC",
                    "ExternalId": "0314d281-68ff-4550-897c-b03440f6108b",
                    "PaymentDate": "2020-12-31T00:00:00",
                    "CreationDate": "2020-07-15T01:30:54.0210524Z",
                    "LastUpdateDate": "2020-07-15T01:30:54.0210524Z",
                    "Version": 13,
                    "StreamDate": "2020-07-15T01:30:55.4367727Z"
                }
            ],
            "SchemaName": "payment",
            "SchemaVersion": 1
        }
    ]
}

Campos

Campo	Tipo de Dados
`LoanId`	string
`RepaymentMethod`	string
`BorrowerId`	string
`PaymentAmount`	decimal
`ProposalId`	string
`IsNotified`	boolean
`Id`	string
`LenderId`	string
`ExternalId`	string
`PaymentDate`	DateTime
`CreationDate`	DateTime
`LastUpdateDate`	DateTime
`Version`	Int
`StreamDate`	DateTime

Objeto

Campos

Métodos de pagamento suportados

📘Contrato de Streaming dos dados de Reembolso

📘
Contrato de Streaming dos dados de Reembolso