Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

PARÂMETROTIPOOBRIGATÓRIODESCRIÇÃO
VersionstringtrueVersão da API
ExecutionstringtrueTipo da execução cetContinue, cetInterrupt, cetFailed
TotalDoublefalseTotal do pagamento realizado
DiscountDoubleDoublefalseDesconto no total pago na venda
IncreaseDoublefalseAcréscimo no total pago na venda
PaymentNumberIntegertrueNúmero da forma de pagamento
AuthorizationCodeText(15)trueCódigo de autorização do pagamento
VouchersPrintArray of objectsfalseInformações para impressão do recibo do pagamento


ParâmetroTipoDescrição
TextStringTexto a ser impresso no recibo de pagamento
IdentifcationArray of objectsfalseInformações para identificação do cliente


ParâmetroTipoDescrição
DocumentStringNúmero do documento de
identificação do cliente
PartnerCodeIntegerCódigo do parceiro
DocumentTypeStringTipo de documento de
identificação

Os outros parâmetros são encontrados no Comando Desconto na VendaClique aqui e acesse a documentação.

Response Example

TransactionCanceledCode

String

false

NSU Cancelamento

InstallmentAmount

Integer

false

Quantidade de parcelas

FirstDigitCard

String

false

BIN do cartão

LastDigitCard

String

false

Últimos dígitos do cartão

FlagCard

String

false

Código da bandeira do cartão

OwnerCard

String

false

Nome do dono do cartão

ExpirationDateCard

String

false

Data de validade do cartão

IdWallet

String

false

ID da carteira digital

TypeWallet

String

false

Tipo da carteira digital

NetworkCard

String

false

Código da rede


Os outros parâmetros são encontrados no Comando Desconto na VendaClique aqui e acesse a documentação.

Response Example

{
"version": 1,
"sale": {
{ "version"1, "sale"{ "discount"0.1, "total"0, "items"[ { "itemNumber"1, "unitPrice"0, "increasePrice" "increase": 0,
"packingQuantitydiscount": 0,
"quantitytotal": 0,
"totalPriceheader"0, : null,
"discountPrice"0.0859, payments": [],
"status""sttValid", paymentChange": null,
"partitionDiscountsolidaryChange"[ : null,
{ "items": [],
"discountAmount"1, discountCodes": [],
"price"0.0859, messages": {
"partnerCode"0, "customer": [ {
"promotionCode"43 } ] } ], "text": "Ganhou 1000 pontos nessa compra\r\n"
"partitionDiscount"[ { "discountAmount"1, "price"0.1, }
"partnerCode"0, "promotionCode"686 } ] }],
"pay"{ "total"8.59, "discount"0, "increase"0, user": [ {
"paymentNumber"1, "authorizationCode""FD455FKL34SS1100AXV", "vouchersPrint"[ { "text": "Ganhou RECEBO100 PAGAMENTO,pontos CONVENIOnessa compra\r\n\r\n N. 100, Vlr. Compra 8.59\r\n" "
}, { }
"text"" RECEBO PAGAMENTO, CONVENIO \r\n\r\n N. 100, Vlr. Compra 8.59\r\n" } ],
"identifcation"{ "document""11263629059", },
"partnerCode"0, "documentType""cdtCPF" } }, "execution""cetContinue", "interpret"{ vouchersPrint": [ {
"commandType""cctGetValue", "value"{ "title""Leitura de codigo", "subtitle""Teste Pagamento", "defaultValue""setsdgsdgsddsg", "dataType""cvtQRCode", text": " CUPOM DESCONTO 1\r\n\r\n Cupom de 5% de desconto para \r\npróxima\r\ncompra, aplicado para todos os \r\nprodutos.\r\n\r\n[ImpBarra]1234567890\r\n[ImpFimBarra]\r\n"
"size"4000 } } }

Exemplo Fluxo de Pagamento

No exemplo abaixo foram:
1 – Vinculado uma forma de pagamento ao parceiro;
2 – Adicionado uma função obter valor para captura do QRCode;
No Início da venda, foi inserido um produto e teclado Enter. Após todos os produtos inseridos, foi acionada a função para finalização da venda.

Image RemovedImagem 1 – Tela Pagamento

Selecionado forma de pagamento vinculado ao parceiro.

Image Removed

Imagem 2 – Tela Pagamento

JSON enviado para o parceiro

{
  "Event""cetBefore",
  "Execution""cetContinue",
  "ID""001600000591145",
  56"Operation""cotSalePayment",
  "Pay"{
    "Discount"0,
    "Increase"0,
    "PaymentNumber"1,
    "Total"4.99
  },
  "Sale"{
    "Discount"0,
    "Header"{
,
{
"text": " CUPOM DESCONTO 2\r\n\r\n Cupom de 10% de desconto para \r\npróxima\r\ncompra, aplicado para todos os \r\nprodutos.\r\n\r\n[ImpBarra]1234567890\r\n[ImpFimBarra]\r\n"
}
],
"partitionIncrease": [],
"AccountingDate""2020-03-10T00 00 00", partitionDiscount": [ {
"DateTimeIssue""2020-03-10T16 57 34", "IdDocument"591145, "IdStore"1, "IdTerminal"600, "IdUserprice"2, : 0,
"Status""sttValid" }, "ID""001600000591145", "IncreasepartnerCode": 0,
"Items"[ { "BarCode""7891000100103", "CaptionPacking""UN", "Description""MOCA", promotionCode": 511,
"DiscountAmount"0, "DiscountPrice"0, "IncreasePrice"0, "InternalCode""4900", discountAmount": 0
"ItemNumber"1, "PackingQuantity"1, "Quantity"1, "Status""sttValid", }
"TotalPrice"4.99, "UnitPrice"4.99 } ],
},
"pay": {
"Totaltotal": 4.99 49,
}, "Version"1 }

O parceiro retorna informando que é necessário obter um valor do QRCode. Após a leitura e confirmação do QRCode, o pagamento é finalizado.

Image RemovedImagem 3 – Pagamento QR Code

JSON enviado para o parceiro

{
  "version"1,
  "sale"{
discount": 0,
"increase": 0,
"discount"0.1, "totalpaymentNumber"0, : 29,
"items"[ "authorizationCode": "FD455FKL34SS1100AXV",
{ "idWallet": "itemNumber123456"1,
"unitPrice"0, "typeWallet": "1",
"increasePriceinstallmentAmount"0: 1,
"packingQuantity"0, "transactionCode": "000080014",
"networkCard": "quantity00125"0,
"totalPrice"0, "discountPrice"0.0499, flagCard": "00002",
"status""sttValid", vouchersPrint": [ {
"partitionDiscount"[ { "discountAmounttext"1, : " RECEBO PAGAMENTO, CONVENIO: \r\n\r\n N. 100, Vlr. Compra: 99,99\r\n"
"price"0.0499, "partnerCode"0, "promotionCode"193 },
} ] } ], {
"partitionDiscount"[ { "discountAmount"1, "price"0.1, "text": " RECEBO "partnerCode"0PAGAMENTO, CONVENIO: \r\n\r\n N. 100, Vlr. "promotionCode"949 Compra: 99,99\r\n"
} ] }, "pay"{ "total"4.99, "discount"0, "increase"0, }
"paymentNumber"1, "authorizationCode""FD455FKL34SS1100AXV", "vouchersPrint"[ { "text"" RECEBO PAGAMENTO],
CONVENIO \r\n\r\n N. 100, Vlr. Compra 4.99\r\n" "identification": {
}, { "text"" RECEBO PAGAMENTO, CONVENIO \r\n\r\n N. 100, Vlr. Compra 4.99\r\n" "document": "11263629059",
} ], "identifcation"{ "document""11263629059", "partnerCode": 0,
"documentType""cdtCPF" } }, "return"{ "code"0 }, "executiondocumentType": "cetContinuecdtCPF",
"interpret"{ "commandType""cctGetValue", "value"{ "title""Leitura de codigo", "subtitle""Teste Pagamento", }
"defaultValue""4E639435-32FB-4386-8777-06E458EFCF8F", },
"return": {
"code": 0
},
"execution"dataType: "cetContinue"cvtQRCode", "size"4000 } } }

Comprovante impresso no final da venda.

...

,
"interpret": {
"commandType": "cctGetValue",
"messageCommand": null,
"options": null,
"value": {
"title": "Leitura de codigo",
"subtitle": "Teste Pagamento",
"defaultValue": "1234567890123456789",
"dataType": "cvtQRCode",
"size": 0,
"documentTypes": []
}
},
"vouchersPrint": []
}

}

}

Exemplo Fluxo de Pagamento

No exemplo abaixo foram:
1 – Vinculado uma forma de pagamento ao parceiro;
2 – Adicionado uma função obter valor para captura do QRCode;
No Início da venda, foi inserido um produto e teclado Enter. Após todos os produtos inseridos, foi acionada a função para finalização da venda.

Image AddedImagem 1 – Tela Pagamento

Selecionado forma de pagamento vinculado ao parceiro.

Image Added

Imagem 2 – Tela Pagamento

JSON enviado para o parceiro

{
  "Event""cetBefore",
  "Execution""cetContinue",
  "ID""001600000591145",
  56"Operation""cotSalePayment",
  "Pay"{
    "Discount"0,
    "Increase"0,
    "PaymentNumber"1,
    "Total"4.99
  },
  "Sale"{
    "Discount"0,
    "Header"{
      "AccountingDate""2020-03-10T00 00 00",
      "DateTimeIssue""2020-03-10T16 57 34",
      "IdDocument"591145,
      "IdStore"1,
      "IdTerminal"600,
      "IdUser"2,
      "Status""sttValid"
    },
    "ID""001600000591145",
    "Increase"0,
    "Items"[
      {
        "BarCode""7891000100103",
        "CaptionPacking""UN",
        "Description""MOCA",
        "DiscountAmount"0,
        "DiscountPrice"0,
        "IncreasePrice"0,
        "InternalCode""4900",
        "ItemNumber"1,
        "PackingQuantity"1,
        "Quantity"1,
        "Status""sttValid",
        "TotalPrice"4.99,
        "UnitPrice"4.99
      }
    ],
    "Total"4.99
  },
  "Version"1
}

O parceiro retorna informando que é necessário obter um valor do QRCode. Após a leitura e confirmação do QRCode, o pagamento é finalizado.

Image AddedImagem 3 – Pagamento QR Code

JSON enviado para o parceiro

{
  "version"1,
  "sale"{
    "increase"0,
    "discount"0.1,
    "total"0,
    "items"[
      {
        "itemNumber"1,
        "unitPrice"0,
        "increasePrice"0,
        "packingQuantity"0,
        "quantity"0,
        "totalPrice"0,
        "discountPrice"0.0499,
        "status""sttValid",
        "partitionDiscount"[
          {
            "discountAmount"1,
            "price"0.0499,
            "partnerCode"0,
            "promotionCode"193
          }
        ]
      }
    ],
    "partitionDiscount"[
      {
        "discountAmount"1,
        "price"0.1,
        "partnerCode"0,
        "promotionCode"949
      }
    ]
  },
  "pay"{
    "total"4.99,
    "discount"0,
    "increase"0,
    "paymentNumber"1,
    "authorizationCode""FD455FKL34SS1100AXV",
    "vouchersPrint"[
      {
        "text"" RECEBO PAGAMENTO, CONVENIO \r\n\r\n N. 100, Vlr. Compra 4.99\r\n"
      },
      {
        "text"" RECEBO PAGAMENTO, CONVENIO \r\n\r\n N. 100, Vlr. Compra 4.99\r\n"
      }
    ],
    "identifcation"{
      "document""11263629059",
      "partnerCode"0,
      "documentType""cdtCPF"
    }
  },
  "return"{
    "code"0
  },
  "execution""cetContinue",
  "interpret"{
    "commandType""cctGetValue",
    "value"{
      "title""Leitura de codigo",
      "subtitle""Teste Pagamento",
      "defaultValue""4E639435-32FB-4386-8777-06E458EFCF8F",
      "dataType""cvtQRCode",
      "size"4000
    }
  }
}

Comprovante impresso no final da venda.

Image Added

Imagem 4 – Texto Cupom


Possíveis códigos de bandeiras de cartão para o campo FlagCard

Código da Bandeira

Descrição

00000

Outro, não definido

00001

Visa (Crédito)

00002

Mastercard (Crédito)

00004

American Express (Crédito)

00011

JCB (Crédito)

10014

Discovery (Voucher)

20001

Maestro (Débito)

20002

Visa Electron (Débito)

20137

Telenet (Débito)


Possíveis códigos das Carteiras Digitais para o campo IdWallet

Código Carteiras

Nome

00150001

VC +

00190002

NuCash

00200003

Veloe

00210006

IzPay

00260005

Vee

00290006

Mercado Pago

00300007

MoneyPag

00340008

Troco Simples

00380009

Itaú

00580011

BrinksPay

00600012

PicPay

00650013

PagSeguro

60110024

Pix

80001000

Cielo

80021002

Tá Pago

80031003

4All


Possíveis códigos de rede para o campo NetworkCard

Código Rede

Nome

0

Outra, não definida

1

Tecban

2

ITAÚ

3

BRADESCO

4

Visanet - Especificação 200001

5

Redecard

6

Amex

7

SOLLO

8

E CAPTURE

9

Serasa

10

SPC Brasil

11

SERASA DETALHADO

12

TELEDATA

13

ACSP

14

ACSP DETALHADO

15

TECBIZ

16

CDL DF

17

Repom

18

STANDBY

19

EDMCARD

20

CREDICESTA

21

Banrisul

22

ACC CARD

23

Clubcard

24

ACPR

25

Vidalink

26

CCC_WEB

27

Ediguay

28

Carrefour

29

Softway

30

Multicheque

31

Ticket combustível

32

YAMADA

33

Citibank

34

Infocard

35

BESC

36

EMS

37

CHEQUE CASH

38

Central Card

39

Drogaraia

40

OUTRO SERVIÇO

41

Edenred

42

EPAY GIFT

43

Parati

44

TOKORO

45

Coopercred

46

SERVCEL

47

Sorocred

48

Vital

49

SAX FINANCEIRA

50

Formosa

51

Hipercard

52

Tricard

53

CHECK OK

54

Policard

55

Cetelem Carrefour

56

LEADER

57

Consórcio Credicard Venezuela

58

GAZINCRED

59

Telenet

60

Cheque Pré

61

Brasil Card

62

Epharma

63

Total

64

Consórcio Amex Venezuela

65

GAX

66

Peralta

67

SERVIDOR PAGAMENTO

68

BANESE

69

RESOMAQ

70

Sysdata

71

CDL POA

72

BIGCARD

73

DTRANSFER

74

VIAVAREJO

75

CHECK EXPRESS

76

Givex

77

Valecard

78

Portal Card

79

Banpara

80

SOFTNEX

81

SUPERCARD

82

GetNet

83

Prevsaude

84

BANCO POTTENCIAL

85

SOPHUS

86

MARISA 2

87

MAXICRED

88

BLACKHAWK

89

EXPANSIVA

90

SAS NT

91

LEADER 2

92

SOMAR

93

CETELEM AURA

94

CABAL

95

CREDSYSTEM

96

Banco Provincial

97

CARTESYS

98

CISA

99

TRNCENTRE

100

ACPR D

101

CARDCO

102

CHECK CHECK

103

CADASA

104

PRIVATE BRADESCO

105

CREDMAIS

106

GWCEL

107

CHECK EXPRESS 2

108

GETNET PBM

109

USECRED

110

SERV VOUCHER

111

TREDENEXX

112

Bonus Presente Carrefour

113

CREDISHOP

114

ESTAPAR

115

Banco Ibi

116

WORKERCARD

117

Telecheque

118

OBOE

119

PROTEGE

120

SERASA CARDS

121

Hotcard

122

Banco Panamericano

123

Banco Mercantil

124

Sigacred

125

Visanet – Especificação 4.1

126

SPTRANS

127

PRESENTE MARISA

128

COOPLIFE

129

BOD

130

G CARD

131

TCREDIT

132

SISCRED

133

FOXWINCARDS

134

CONVCARD

135

Voucher

136

EXPAND CARDS

137

Ultragaz

138

Qualicard

139

HSBC UK

140

Wappa

141

SQCF

142

INTELLISYS

143

BOD DÉBITO

144

ACCREDITO

145

COMPROCARD

146

ORGCARD

147

MINASCRED

148

Farmácia Popular

149

Fidelidade Mais

150

ITAÚ SHOPLINE

151

CDL RIO

152

FORTCARD

153

PAGGO

154

SMARTNET

155

INTERFARMACIA

156

VALECON

157

CARTÃO EVANGÉLICO

158

VEGASCARD

159

SCCARD

160

ORBITALL

161

ICARDS

162

FACILCARD

163

FIDELIZE

164

FINAMAX

165

BANCO GE

166

UNIK

167

TIVIT

168

VALIDATA

169

BANESCARD

170

CSU CARREFOUR

171

VALESHOP

172

SOMAR CARD

173

OMNION

174

CONDOR

175

STANDBYDUP

176

BPAG BOLDCRON

177

MARISA SAX SYSIN

178

STARFICHE

179

ACE SEGUROS

180

TOP CARD

181

GETNET LAC

182

UP SIGHT

183

MAR

184

FUNCIONAL CARD

185

PHARMA SYSTEM

186

MARKET PAY

187

SICREDI

188

ESCALENA

189

N SERVIÇOS

190

CSF CARREFOUR

191

ATP

192

AVST

193

ALGORIX

194

AMEX EMV

195

COMPREMAX

196

LIBERCARD

197

SEICON

198

SERASA AUTORIZ CRÉDITO

199

SMARTN

200

PLATCO

201

SMARTNET EMV

202

PROSA MÉXICO

203

PEELA

204

NUTRIK

205

GOLDENFARMA PBM

206

GLOBAL PAYMENTS

207

ELAVON

208

CTF

209

BANESTIK

210

VISA ARG

211

AMEX ARG

212

POSNET ARG

213

AMEX MÉXICO

214

ELETROZEMA

215

BARIGUI

216

SIMEC

217

SGF

218

HUG

219

CARTÃO CONSIGNUM CARTÃO METTACARD

220

DDTOTAL

221

CARTÃO QUALIDADE

222

REDECONV

223

NUTRICARD

224

DOTZ

225

PREMIAÇÕES RAIZEN

226

TROCO SOLIDÁRIO

227

AMBEV SÓCIO TORCEDOR

228

SEMPRE

229

BIN

230

COCIPA

231

IBI MÉXICO

232

SIANET

233

SGCARDS

234

CIAGROUP

235

FILLIP

236

CONDUCTOR

237

LTM RAIZEN

238

INCOMM

239

VISA PASS FIRST

240

CENCOSUD

241

HIPERLIFE

242

SITPOS

243

AGT

244

MIRA

245

AMBEV 2 SÓCIO TORCEDOR

246

JGV

247

CREDSAT

248

BRAZILIAN CARD

249

RIACHUELO

250

ITS RAIZEN

251

SIMCRED

252

BANCRED CARD

253

CONEKTA

254

SOFTCARD

255

ECOPAG

256

C&A AUTOMAÇÃO IBI

257

C&A PARCERIAS BRADESCARD

258

OGLOBA

259

BANESE VOUCHER

260

RAPP

261

Monitora POS

262

SOLLUS

263

FITCARD

264

ADIANTI

265

STONE

266

DMCARD

267

ICATU 2

268

FARMASEG

269

BIZ

270

SEMPARAR RAIZEN

272

PBM GLOBAL

273

PAYSMART

275

ONEBOX

276

CARTO

277

WAYUP

296

SAFRA

301

CTF Frota

303

SIPAG