A entidade Spot Offer representa uma oportunidade de negociar ou renegociar um produto (atualmente, apenas Empréstimo).
Objeto
{
"id": "jqb8ucespjrrc7zrtc1v2e6wt",
"status": "Processed",
"type": "Regular",
"amount": 100.000000,
"discountRate": 0.100000,
"discountAmount": 10.000000,
"paymentMethod": "Boleto",
"origin": {
"providerId": "Operation",
"externalReference": "80954f690596"
},
"product": {
"type": "Loan",
"externalId": "jq6tknqrqqmccta6a938f2jmq"
},
"customer": {
"name": "Anakin Skywalker",
"fantasyName": "Darth Vader",
"document": "11111111111111",
"email": "[email protected]"
},
"beneficiary": {
"name": "FIDC Stone",
"document": "11111111111111",
"stoneOpenbankAccountId": "123456-acd-xyz-9876"
},
"boleto": {
"amount": 90.000000,
"provider": "StoneOpenbank",
"type": "BillOfExchange",
"externalId": "jqb8ucex2tbq2y6jw1zmj9wqy",
"dueDate": "2022-05-29",
"status": "Settled",
"publicUri": "https://sandbox-link.openbank.stone.com.br/api/boleto?id=b7c51a02-91f9-4a05-bbc6-0210dd4199ae",
"barCode": "19792888200000080000000097672187089193449477",
"createdAt": "2021-07-15T20:55:20Z",
"updatedAt": "2021-07-15T20:57:03Z",
"registeredAt": "2021-07-15T20:57:03Z",
"settledAt": "2021-07-15T20:57:03Z",
"expiredAt": "2021-07-15T20:57:03Z"
},
"entries": [
{
"type": "Boleto",
"provider": "StoneOpenbank",
"amount": 90.000000,
"entryDate": "2022-05-29",
"status": "Created",
"externalId": "jqb8ucezdhm35ne5axnv1pv9p"
},
{
"type": "DebtDiscount",
"provider": "StoneLoan",
"amount": 10.000000,
"entryDate": "2022-05-29T00:00:00Z",
"status": "Created",
"externalId": "jqb8ucezdhm35ne5axnv1pv9p"
}
],
"cancellation": {
"status": "Accepted",
"requestedAt": "2022-03-04T05:09:04Z",
"acceptedAt": "2022-03-04T05:09:06Z"
},
"createdAt": "2021-07-15T20:55:20Z",
"createdBy": "[email protected]",
"updatedAt": "2021-07-15T20:57:06Z",
"emailSentAt": "2021-07-15T20:55:26Z",
"failedAt": "2021-07-15T20:55:26Z"
}
{
"id": "jqb8ucespjrrc7zrtc1v2e6wt",
"status": "Processed",
"type": "Regular",
"amount": 100.000000,
"discountRate": 0.100000,
"discountAmount": 10.000000,
"paymentMethod": "Pix",
"origin": {
"providerId": "Operation",
"externalReference": "80954f690596"
},
"product": {
"type": "Loan",
"externalId": "jq6tknqrqqmccta6a938f2jmq"
},
"customer": {
"name": "Anakin Skywalker",
"fantasyName": "Darth Vader",
"document": "11111111111111",
"email": "[email protected]"
},
"beneficiary": {
"name": "FIDC Stone",
"document": "11111111111111",
"stoneOpenbankAccountId": "123456-acd-xyz-9876"
},
"pix": {
"amount": 90.000000,
"provider": "StoneOpenbank",
"type": "InvoiceWithDueDate",
"externalId": "jqb8ucex2tbq2y6jw1zmj9wqy",
"dueDate": "2022-05-29",
"status": "Settled",
"key": "11111111111111",
"qrCode": {
"content": "00020101021226890014br.gov.bcb.pix2567pix-h.stone.com.br/pix/v2/cobv/e1e80eed-d0cc-4ba1-a87c-2526f5e61cec5204000053039865406100.005802BR5923Nome do CPF 502021060986014RIO DE JANEIRO622905256df486abbb294668817b903ad6304D69E"
},
"createdAt": "2021-07-15T20:55:20Z",
"updatedAt": "2021-07-15T20:57:03Z",
"settledAt": "2021-07-15T20:57:03Z",
"expiredAt": "2021-07-15T20:57:03Z"
},
"entries": [
{
"type": "Pix",
"provider": "StoneOpenbank",
"amount": 90.000000,
"entryDate": "2022-05-29",
"status": "Created",
"externalId": "jqb8ucezdhm35ne5axnv1pv9p"
},
{
"type": "DebtDiscount",
"provider": "StoneLoan",
"amount": 10.000000,
"entryDate": "2022-05-29T00:00:00Z",
"status": "Created",
"externalId": "jqb8ucezdhm35ne5axnv1pv9p"
}
],
"cancellation": {
"status": "Accepted",
"requestedAt": "2022-03-04T05:09:04Z",
"acceptedAt": "2022-03-04T05:09:06Z"
},
"createdAt": "2021-07-15T20:55:20Z",
"createdBy": "[email protected]",
"updatedAt": "2021-07-15T20:57:06Z",
"emailSentAt": "2021-07-15T20:55:26Z",
"failedAt": "2021-07-15T20:55:26Z"
}
Campos
| Campo | Descrição | Tipo de Dados |
|---|---|---|
id | Identificador da oferta | string |
amount | Valor total/bruto da oferta (o valor do desconto está incluso) | decimal |
discountRate | Percentual de desconto relacionado à oferta | decimal |
discountAmount | Valor em R$ do desconto a ser aplicado a partir da oferta | decimal |
paymentMethod | Método de pagamento que será utilizado na oferta | string |
dueDate | Data de vencimento da oferta | date ("yyyy-MM-dd") |
updatedAt | Data e hora de atualização de uma oferta | dateTime ("yyyy-MM-ddTHH:mm:ss") |
createdBy | Identificador do usuário que criou a oferta | string |
createdAt | Data e hora de criação | dateTime ("yyyy-MM-ddTHH:mm:ss") |
status | Status da oferta | string |
type | Tipo da oferta | string |
origin | Dados de originação da oferta | object |
product | Produdo relacionado à oferta | object |
customer | Cliente relacionado à oferta | object |
beneficiary | Beneficiário relacionado à oferta | object |
emailSentAt | Data e hora do envio do email | dateTime ("yyyy-MM-ddTHH:mm:ss") |
failureReason | Razão da falha no processamento | string |
boleto | Dados do método de pagamento "Boleto" | object |
pix | Dados do método de pagamento "Pix" | object |
entries | Dados dos lançamentos | object list |
failedAt | Data e hora em que o método de pagamento foi rejeitado. | dateTime ("yyyy-MM-ddTHH:mm:ss") |
cancellation | Dados do cancelamento "Cancellation" | object |
Tipos de Oferta
As Spot Offers possuem os seguintes tipos a serem definidos em sua criação:
| Nome | Descrição |
|---|---|
Renegotiation | É um tipo de oferta que pode ser oferecido para clientes que estão com o seu empréstimo em atraso ou para clientes que desejam renegociar uma ou mais condições do seu empréstimo. |
Regular | São as ofertas criadas a fim de quitar de maneira antecipada o empréstimo, seja parcial ou totalmente. |
Repatriation | É um tipo de oferta, destinada única e exclusivamente para reaver valores cedidos ao cliente, através de uma ação de fraude. |
Settlement | É um tipo que possibilita a emissão de um método de pagamento, o qual seu pagamento resultará na quitação do empréstimo do cliente. |
Método de Pagamento
| Nome | Descrição |
|---|---|
Boleto | Boleto bancário |
Pix | Transação Pix |
Estados da Oferta
| Nome | Descrição |
|---|---|
Active | Uma oferta foi requisitada |
Cancelled | Uma oferta foi cancelada |
Processing | Processamento do seu método de pagamento |
Processed | Informações sobre o método de pagamento foram enviadas ao serviço de notificação para serem entregues ao cliente |
Failed | A ordem de pagamento foi rejeitada e a oferta chegou em seu status final. Mais detalhes na seção "Rejeições", logo abaixo. |
Rejeições
| Status da Oferta | Motivo | Descrição |
|---|---|---|
Failed | OrderRejected | Falha na criação da ordem de pagamento. |
Failed | OrderBadRequest | Falha na criação da ordem de pagamento. Este será o motivo caso as informações do método de pagamento não estejam corretas. |