Referência da API
HomeReferência da APIChangelogStatus

Visão Geral do Lançamento Financeiro

A entidade FinancialEntry representa o método utilizado na execução da ordem. Contém todas as informações relacionadas ao lançamento.

Objeto

{
	"id": "jqfjbr3syxyvc8wyrypj9v588",
	"orderId": "jqfjbr3prnbv5qny4z1w314e7",
	"amount": 21.9,
	"provider": "StoneLoan",
	"type": "Boleto",
	"entryDate": "2022-02-05",
	"requestedAt": "2022-01-06T20:48:53",
	"createdAt": "2022-01-06T20:48:54",
	"providerId": "jqfjbrtuzrkh1bb5str6xywsq",
	"status": "Created"
}

{
	"id": "jqfjbr3uze48b41s16gm3dvp7",
	"orderId": "jqfjbr3t7zrc5msrz9yjutnbt",
	"amount": 0.1,
	"provider": "StoneLoan",
	"type": "DebtDiscount",
	"entryDate": "2022-02-05",
	"requestedAt": "2022-01-06T20:48:33",
	"createdAt": "2022-01-06T20:48:54",
	"providerId": "jqfjbrtuzrkh1bb5str6xywsq",
	"status": "Created"
}

Campos

CampoDescriçãoTipo de Dados
idIdentificador único do lançamentostring
statusStatus atual do lançamentostring
providerProvedor para o lançamentostring
typeTipo de lançamentostring
entryDateData do lançamentodate ("YYYY-MM-DD")
requestedAtData e hora da solicitação do lançamento no providerdate ("YYYY-MM-DDThh:mm:ssZ")
createdAtData e hora da criação do lançamento no providerdate ("YYYY-MM-DDThh:mm:ssZ")
amountValor do lançamentodecimal
providerIdIdentificador único do lançamento no providerstring

Estados

StatusDescrição
RequestedLançamento solicitado
CreatedLançamento criado

Provedores

ProviderDescrição
StoneLoanUtilização da Stone Loan API

Tipos de lançamento

TipoDescrição
BoletoPagamento realizado via Boleto
PixPagamento realizado via Pix
ManualLançamento genérico utilizado para representar descontos
DebtDiscountLançamento de desconto

🚧

Aviso importante!

O tipo de lançamento "Manual" não é mais suportado na criação de novas ordens.

Stream de Dados

📘

Contrato de Streaming dos Dados do Boleto

Veja Streaming de dados

{
    "Stream": {
        "Content": [
            {
                "Data": [
                    {
                        "Id": "jq6yw5d4fk39gg4u1yv713wyy",
                        "OrderId": "jq6yw5d2e2p7858yw3t9dy36k",
                        "Status": "Created",
                        "Provider": "StoneLoan",
                        "Type": "Boleto",
                        "EntryDate": "2020-12-04",
                        "RequestedAt": "2020-12-04T13:35:47.792Z",
                        "CreatedAt": "2020-12-04T13:35:47.792Z",
                        "Amount": 20.0,
                        "ProviderId": "ec363b21-113f-44e9-8cc3-dfcdb3cc2dc3",
                        "GeneratedAt": "2021-01-22T14:22:07.817272Z",
                        "LastUpdatedAt": "2021-01-22T14:22:07.817272Z",
                        "Version": -1,
                        "StreamDate": "2021-01-22T14:22:22.2480082Z"
                    }
                ],
                "SchemaName": "order-financial-entry",
                "SchemaVersion": 1
            }
        ]
    },
    "Timestamp": "2021-01-22T14:22:22.3106853Z",
    "CommandKey": "jq6yw5j3qksxeff8sy2j8gad1",
    "SessionKey": "jq6yw5d2e2p7858yw3t9dy36k",
    "ChannelKey": "DefaultNotificationsChannel",
    "IdempotencyKey": "jq6yw5j3qks54faxbt3u5h1mk",
    "SagaProcessKey": "jq6yw5cus5skevp76rm24ns3q",
    "BatchProcessKey": null,
    "Result": {},
    "Id": "jq6yw5d2e2p7858yw3t9dy36k",
    "ApplicationKey": "runscope",
    "UserEmail": null,
    "ValidationResult": null
}

📘

Contrato de Streaming dos Dados - Evento

Veja Streaming de Dados - Evento na Visão Geral da Ordem de Pagamento

Tipos de Eventos e Ações

Tipo de eventoAção
FinancialEntryRequested
FinancialEntryCreated