@suportepos/split-checkout 0.4.8 → 0.4.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +24 -22
  2. package/dist/README.md +24 -22
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -34,8 +34,8 @@ import React from "react";
34
34
  import CheckoutFlow, { Produto, Split } from "@suportepos/split-checkout";
35
35
 
36
36
  const items: Produto[] = [
37
- { id: "sku-1", name: "Mensalidade", unitPrice: 79.9 },
38
- { id: "sku-2", name: "Taxa de adesão", unitPrice: 20.1, quantity: 1 },
37
+ { id: "sku-1", nome: "Plano Mensal", preco: 100, quantidade: 1 },
38
+ { id: "sku-2", nome: "Taxa de Adesão", preco: 20, quantidade: 1 },
39
39
  ];
40
40
 
41
41
  const splits: Split[] = [
@@ -105,8 +105,8 @@ export default function App() {
105
105
  SplitCheckout.renderCheckout({
106
106
  elementId: "checkout",
107
107
  produtos: [
108
- { id: "sku-1", name: "Plano Mensal", unitPrice: 100 },
109
- { id: "sku-2", name: "Taxa de Adesão", unitPrice: 20 },
108
+ { id: "sku-1", nome: "Plano Mensal", preco: 100, quantidade: 1 },
109
+ { id: "sku-2", nome: "Taxa de Adesão", preco: 20, quantidade: 1 },
110
110
  ],
111
111
  codigoPedido: "123",
112
112
  producao: false,
@@ -144,13 +144,13 @@ export default function App() {
144
144
  | Campo | Tipo | Obrigatório | Descrição |
145
145
  |------------------|-----------|-------------|---------------------------------------------------------------------------|
146
146
  | `elementId` | `string` | ✅ (Standalone) | ID do elemento HTML onde o checkout será montado |
147
- | `produtos` | `Array` | ✅ | Lista de produtos `{ id, name, unitPrice, quantity? }` |
147
+ | `produtos` | `Array` | ✅ | Lista de produtos `{ id, nome, preco, quantidade }` |
148
148
  | `splits` | `Array` | ❌ | Lista de splits `{ subordinateMerchantId, valor }` |
149
149
  | `codigoPedido` | `string` | ✅ | Identificador único do pedido |
150
150
  | `producao` | `boolean` | ✅ | Define o ambiente (`true = produção`, `false = homologação/test`) |
151
151
  | `cliente` | `object` | ✅ | Dados do comprador (nome, e-mail, telefone, endereço, documento) |
152
152
  | `merchantName` | `string` | ✅ | Nome exibido do lojista |
153
- | `amountOverride` | `number` | ❌ | Sobrescreve o valor total calculado (útil para descontos, taxas, etc.) |
153
+ | `valorTotal` | `number` | ❌ | Sobrescreve o valor total calculado (útil para descontos, taxas, etc.) |
154
154
  | `merchantId` | `string` | ✅ | Identificador único da loja (fornecido pela SuportePOS) |
155
155
  | `onResponse` | `function`| ✅ | Callback chamado ao finalizar pagamento |
156
156
 
@@ -163,26 +163,28 @@ export default function App() {
163
163
  ```json
164
164
  {
165
165
  "sucesso": true,
166
- "status": 2,
167
- "mensagem": "Pagamento capturado com sucesso",
168
- "paymentId": "ab7adec8-2205-4dee-81cd-49de34998f96",
166
+ "pago": true,
167
+ "payment_id": "ab7adec8-2205-4dee-81cd-49de34998f96",
168
+ "codigo_pedido": "PED-000124",
169
169
  "valor": 105.25,
170
- "nomeComprador": "João da Silva",
171
- "emailComprador": "joao.silva@example.com",
172
- "telefoneComprador": "+55 11988887777"
170
+ "codigo_adquirente": "CIELO",
171
+ "codigo_autenticacao": "998877665544",
172
+ "bandeira": "VISA",
173
+ "nome_produto_primario": "CRÉDITO"
173
174
  }
174
175
  ```
175
176
 
176
- | Campo | Tipo | Descrição |
177
- |--------------------|----------|----------------------------------------------------------|
178
- | `sucesso` | `boolean`| `true` se o pagamento foi aprovado, `false` se falhou |
179
- | `status` | `number` | Status numérico do pagamento (ex.: `2 = capturado`) |
180
- | `mensagem` | `string` | Mensagem amigável do status |
181
- | `paymentId` | `string` | ID único da transação |
182
- | `valor` | `number` | Valor pago |
183
- | `nomeComprador` | `string` | Nome do comprador |
184
- | `emailComprador` | `string` | E-mail do comprador |
185
- | `telefoneComprador`| `string` | Telefone do comprador |
177
+ | Campo | Tipo | Descrição |
178
+ |----------------------|------------|----------------------------------------------------------|
179
+ | `sucesso` | `boolean` | `true` se o pagamento foi aprovado, `false` se falhou. |
180
+ | `pago` | `boolean` | Indica se o pagamento foi efetivamente liquidado. |
181
+ | `payment_id` | `string` | ID único da transação de pagamento. |
182
+ | `codigo_pedido` | `string` | Código de referência do pedido vinculado à transação. |
183
+ | `valor` | `number` | Valor total pago em reais (BRL). |
184
+ | `codigo_adquirente` | `string` | Nome ou código da adquirente (ex.: `CIELO`, `REDE`). |
185
+ | `codigo_autenticacao`| `string` | Código de autenticação retornado pela adquirente. |
186
+ | `bandeira` | `string` | Bandeira do cartão utilizado (ex.: `VISA`, `MASTERCARD`).|
187
+ | `nome_produto_primario` | `string` | Tipo principal de produto (ex.: `CRÉDITO`, `DÉBITO`). |
186
188
 
187
189
  ---
188
190
 
package/dist/README.md CHANGED
@@ -34,8 +34,8 @@ import React from "react";
34
34
  import CheckoutFlow, { Produto, Split } from "@suportepos/split-checkout";
35
35
 
36
36
  const items: Produto[] = [
37
- { id: "sku-1", name: "Mensalidade", unitPrice: 79.9 },
38
- { id: "sku-2", name: "Taxa de adesão", unitPrice: 20.1, quantity: 1 },
37
+ { id: "sku-1", nome: "Plano Mensal", preco: 100, quantidade: 1 },
38
+ { id: "sku-2", nome: "Taxa de Adesão", preco: 20, quantidade: 1 },
39
39
  ];
40
40
 
41
41
  const splits: Split[] = [
@@ -105,8 +105,8 @@ export default function App() {
105
105
  SplitCheckout.renderCheckout({
106
106
  elementId: "checkout",
107
107
  produtos: [
108
- { id: "sku-1", name: "Plano Mensal", unitPrice: 100 },
109
- { id: "sku-2", name: "Taxa de Adesão", unitPrice: 20 },
108
+ { id: "sku-1", nome: "Plano Mensal", preco: 100, quantidade: 1 },
109
+ { id: "sku-2", nome: "Taxa de Adesão", preco: 20, quantidade: 1 },
110
110
  ],
111
111
  codigoPedido: "123",
112
112
  producao: false,
@@ -144,13 +144,13 @@ export default function App() {
144
144
  | Campo | Tipo | Obrigatório | Descrição |
145
145
  |------------------|-----------|-------------|---------------------------------------------------------------------------|
146
146
  | `elementId` | `string` | ✅ (Standalone) | ID do elemento HTML onde o checkout será montado |
147
- | `produtos` | `Array` | ✅ | Lista de produtos `{ id, name, unitPrice, quantity? }` |
147
+ | `produtos` | `Array` | ✅ | Lista de produtos `{ id, nome, preco, quantidade }` |
148
148
  | `splits` | `Array` | ❌ | Lista de splits `{ subordinateMerchantId, valor }` |
149
149
  | `codigoPedido` | `string` | ✅ | Identificador único do pedido |
150
150
  | `producao` | `boolean` | ✅ | Define o ambiente (`true = produção`, `false = homologação/test`) |
151
151
  | `cliente` | `object` | ✅ | Dados do comprador (nome, e-mail, telefone, endereço, documento) |
152
152
  | `merchantName` | `string` | ✅ | Nome exibido do lojista |
153
- | `amountOverride` | `number` | ❌ | Sobrescreve o valor total calculado (útil para descontos, taxas, etc.) |
153
+ | `valorTotal` | `number` | ❌ | Sobrescreve o valor total calculado (útil para descontos, taxas, etc.) |
154
154
  | `merchantId` | `string` | ✅ | Identificador único da loja (fornecido pela SuportePOS) |
155
155
  | `onResponse` | `function`| ✅ | Callback chamado ao finalizar pagamento |
156
156
 
@@ -163,26 +163,28 @@ export default function App() {
163
163
  ```json
164
164
  {
165
165
  "sucesso": true,
166
- "status": 2,
167
- "mensagem": "Pagamento capturado com sucesso",
168
- "paymentId": "ab7adec8-2205-4dee-81cd-49de34998f96",
166
+ "pago": true,
167
+ "payment_id": "ab7adec8-2205-4dee-81cd-49de34998f96",
168
+ "codigo_pedido": "PED-000124",
169
169
  "valor": 105.25,
170
- "nomeComprador": "João da Silva",
171
- "emailComprador": "joao.silva@example.com",
172
- "telefoneComprador": "+55 11988887777"
170
+ "codigo_adquirente": "CIELO",
171
+ "codigo_autenticacao": "998877665544",
172
+ "bandeira": "VISA",
173
+ "nome_produto_primario": "CRÉDITO"
173
174
  }
174
175
  ```
175
176
 
176
- | Campo | Tipo | Descrição |
177
- |--------------------|----------|----------------------------------------------------------|
178
- | `sucesso` | `boolean`| `true` se o pagamento foi aprovado, `false` se falhou |
179
- | `status` | `number` | Status numérico do pagamento (ex.: `2 = capturado`) |
180
- | `mensagem` | `string` | Mensagem amigável do status |
181
- | `paymentId` | `string` | ID único da transação |
182
- | `valor` | `number` | Valor pago |
183
- | `nomeComprador` | `string` | Nome do comprador |
184
- | `emailComprador` | `string` | E-mail do comprador |
185
- | `telefoneComprador`| `string` | Telefone do comprador |
177
+ | Campo | Tipo | Descrição |
178
+ |----------------------|------------|----------------------------------------------------------|
179
+ | `sucesso` | `boolean` | `true` se o pagamento foi aprovado, `false` se falhou. |
180
+ | `pago` | `boolean` | Indica se o pagamento foi efetivamente liquidado. |
181
+ | `payment_id` | `string` | ID único da transação de pagamento. |
182
+ | `codigo_pedido` | `string` | Código de referência do pedido vinculado à transação. |
183
+ | `valor` | `number` | Valor total pago em reais (BRL). |
184
+ | `codigo_adquirente` | `string` | Nome ou código da adquirente (ex.: `CIELO`, `REDE`). |
185
+ | `codigo_autenticacao`| `string` | Código de autenticação retornado pela adquirente. |
186
+ | `bandeira` | `string` | Bandeira do cartão utilizado (ex.: `VISA`, `MASTERCARD`).|
187
+ | `nome_produto_primario` | `string` | Tipo principal de produto (ex.: `CRÉDITO`, `DÉBITO`). |
186
188
 
187
189
  ---
188
190
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@suportepos/split-checkout",
3
- "version": "0.4.8",
3
+ "version": "0.4.9",
4
4
  "type": "module",
5
5
  "main": "dist/index.umd.js",
6
6
  "module": "dist/index.es.js",