Visão geral - API Cielo Conecta Cielo
Objetivo
Possibilitar a integração de parceiros de negócio/Subadquirentes com a Cielo para transações com cartões não-presentes (transações digitadas) e cartões presentes nas modalidades Chip e Tarja.
Glossário
ID | Descrição |
BC | Biblioteca Compartilhada para PINPad |
DUKPT | (Devired Unique Key Per Transaction) Método de criptografia utilizado na Cielo |
PIN | Senha do cartão |
BDK | (Base Derived Key) Chave do Sub a ser instalada no HSM |
HSM | (Hardware Security Module) Servidor para geração, armazenamento, gerenciamento e funcionalidades criptográficas de chaves digitais |
OAUTH2 | Protocolo de autenticação utilizado nas APIs |
Pré-requisitos
Para a integração é necessário que a solução de captura do parceiro de negócio/Subadquirente possua os seguintes componentes:
- Biblioteca Compartilhada para PINPad ou biblioteca proprietária certificada com as bandeiras.
- Chaves de Criptografia DUKPT implementada para PIN.
- Disponibilizar sua BDK para instalação no HSM Cielo.
- Para soluções de pagamento que utilizam Pinpad externo (conexão Bluetooth ou cabo), é obrigatório o uso de criptografia WKPAN para dados. Clientes desse tipo de solução precisam apresentar certificado PCI DSS e PA DSS
Formato da Chave exigida pela Cielo:
O HSM Cielo está parametrizado para um KSN da seguinte forma:
- KSI - Número de identificação da Chave
- DID – Device ID
- TC – Transaction Counter
No cadastro da chave somente é inserido o KSI que possui 5 caracteres numéricos e a chave, conforme exemplo abaixo:
FFFFF030331234500012
Autenticação
A autenticação é uma operação necessária para obtenção do token que será utilizado nas demais chamadas de APIs.
URL: https://authsandbox.cieloecommerce.cielo.com.br
Security scheme type: | OAuth2 |
clientCredentials OAuth Flow | Username: ClientId Password: ClientSecret Scopes: * PhysicalCieloMaster - Cadastrar de Lojas e Terminais* PhysicalCieloTransactional - Transacionar e consultar* Se não solicitar um escopo ele é atribuido por padrão |
Para testes em sandbox você pode gerar uma credencial a qualquer momento através do site abaixo.
URL: https://omnichannelcadastrosandbox.cieloecommerce.cielo.com.br/
Criar Token
POST https://authsandbox.cieloecommerce.cielo.com.br/oauth2/token
Key Value AUTHORIZATION Username{Auth_ClientId} AUTHORIZATION Password{Auth_ClientSecret} HEADERS Content-Type text/plain BODY grant_type client_credentials scope {scope}
Request
curl --location --request POST 'https://authsandbox.cieloecommerce.cielo.com.br/oauth2/token' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic {base64(ClientId:ClientSecret)}' \
--data-urlencode 'grant_type=client_credentials'
Response
{
"access_token": "{Auth_AccessToken}",
"token_type": "bearer",
"expires_in": 86399
}
Baixa de parâmetros
Essa operação é necessária para que o parceiro de negócio / Subadquirente receba todas as tabelas de parâmetros necessários para que a solução de captura possa efetuar as transações via chamada de API. Essa informação será recebida através de API e deverá ser instalada na BC.
SandBox | Produção |
---|---|
https://parametersdownloadsandbox.cieloecommerce.cielo.com.br/api/v0.1 | https://parametersdownload.cieloecommerce.cielo.com.br/api/v0.1 |
Simular respostas:
Para simular uma resposta especifica utilize o campo TerminalId, onde de acordo com os quatro ultimos digitos finais do valor informado é possivel receber uma resposta conforme a tabela abaixo:
TerminalId(ultimos digitos) | — | Retorno simulado | Exemplo do valor do TerminalId |
---|---|---|---|
0404 | TERMINAL INEXISTENTE | 71990404 | — |
Demais valores | SUCESSO | 82990566 | — |
Inicialização
Solicita as tabelas e parametros para operação do terminal
Requisição
Path Parameters:
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
SubordinatedMerchantId |
String | — | Sim | Identificador da loja |
TerminalId |
String | — | Sim | Identificador do terminal |
Resposta
{
"MerchantId": "string",
"TerminalId": "string",
"Acquirer": {
"EnableContaclessCardReader": true,
"LockAppFunctionsExceptInitialization": true,
"HasChipReader": true,
"HasMagneticTrackReader": true,
"HasKeyboard": true
},
"Merchant": {
"MerchantId": "string",
"NetworkName": "string",
"MerchantName": "string",
"MerchantAddress": "string",
"NationalId": "string"
},
"Bins": [
{
"InitialBin": "string",
"FinalBin": "string",
"ProductId": 0,
"Type": 0,
"AllowFallbackWhenChipReadingFails": true,
"AllowChargingMoedeiroFromCash": true,
"AllowPurchaseWithCompreESaque": true,
"AllowOfflineFunctionExceptForEMVCard": true,
"AllowTypingCardNumber": true,
"MaskCardNumberUsingLast4Digits": true,
"MaskCardNumberUsingFirst6AndLast4Digits": true,
"AllowPrintCardHolderBalance": true,
"AllowDisplayCardHolderBalance": true,
"AllowPrintingPartialCardNumberInReceipt": true,
"RestrictSaleWithDuplicateValueWhenPostdated": true,
"RestrictSaleWithDuplicateValue": true,
"RequiresPassword": true,
"InterpretsLastDigitOfSecurityCode": true,
"RequiresPasswordExceptForEMVCard": true,
"EnableAdditionalSecurityCodeOptions_Unreadable_NoCode": true,
"RequiresSecurityCodeWhenMagneticTrackIsRead": true,
"RequiresSecurityCodeWhenCardNumberIsTyped": true,
"RequiresTypingLast4Digits": true,
"AllowCaptureOfFirstInstallmentValue": true,
"AllowCaptureOfDownpaymentValue": true,
"AllowGuaranteeHandling": true,
"AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery": true,
"AllowPostdating": true,
"AllowCDCSale": true,
"AllowFinancingByStore": true,
"AllowFinancingByCreditCardCompany": true,
"ValidateCardTrack1": true,
"DoNotValidateCardModule10": true,
"CheckExpiryDateWhenCardNumberIsTyped": true,
"CheckExpiryDateWhenMagneticTrackIsRead": true,
"IssuerId": 0
}
],
"Products": [
{
"ProductId": 0,
"ProductName": "string",
"ProductType": 0,
"BrandId": "string",
"AllowTransactionWithContactlessCard": true,
"IsFinancialProduct": true,
"AllowOfflineAuthorizationForEMVCard": true,
"AllowReprintReceipt": true,
"AllowPrintReceipt": true,
"AllowOfflineAuthorizationForContactlessCard": true,
"AllowCancel": true,
"AllowUndo": true,
"AllowCaptureOfFirstInstallmentValue": true,
"AllowCaptureOfDownpaymentValue": true,
"AllowGuaranteeHandling": true,
"AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery": true,
"AllowPostdating": true,
"AllowCDCSale": true,
"AllowFinancingByStore": true,
"AllowFinancingByCreditCardCompany": true,
"MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany": 0,
"MaximumNumberOfInstallmentsWhenFinancingByStore": 0,
"MaximumNumberOfinstallmentsForSaleAndCDCQuery": 0,
"MinimumNumberOfInstallmentsWhenFinancingByStore": 0,
"PostdatedSaleGuaranteeType": "DoNotAllowSalesWithGuarantee",
"PostdatedDayCountLimit": 0,
"FirstInstallmentDayCountLimit": 0
}
],
"Emv": [
{
"Aid": "string",
"TagsFirst": "string",
"TagsSecond": "string",
"IdxRecord": 0,
"Type": 0,
"RCodeFirst": "string",
"RCodeSecond": "string",
"InvalidateFunctionIfCardIsOnBlacklist": true,
"RequireBINToBeInCardRangeTable": true,
"StoreTransactionsRejectedByTerminalAppAndSendToHost": true,
"AllowOnlineAuthorizationTransactionRequest": true,
"AllowExtendedCardHolderName": true,
"NatEmvConctactRiskFloorLimit": 0,
"NatEmvConctactRiskMinValue": 0,
"NatEmvConctactRiskMinPercent": 0,
"NatEmvConctactRiskMaxPercent": 0,
"IntEmvConctactRiskFloorLimit": 0,
"IntEmvConctactRiskMinValue": 0,
"IntEmvConctactRiskMinPercent": 0,
"IntEmvConctactRiskMaxPercent": 0,
"ProductIds": [
0
]
}
],
"Parameters": [
{
"Currency": "string",
"AllowFallbackWhenChipReadingFails": true,
"AllowChargingMoedeiroFromCash": true,
"AllowPurchaseWithCompreESaque": true,
"AllowOfflineFunctionExceptForEMVCard": true,
"AllowTypingCardNumber": true,
"MaskCardNumberUsingLast4Digits": true,
"MaskCardNumberUsingFirst6AndLast4Digits": true,
"AllowPrintCardHolderBalance": true,
"AllowDisplayCardHolderBalance": true,
"AllowPrintingPartialCardNumberInReceipt": true,
"RestrictSaleWithDuplicateValueWhenPostdated": true,
"RestrictSaleWithDuplicateValue": true,
"RequiresPassword": true,
"InterpretsLastDigitOfSecurityCode": true,
"RequiresPasswordExceptForEMVCard": true,
"EnableAdditionalSecurityCodeOptions_Unreadable_NoCode": true,
"RequiresSecurityCodeWhenMagneticTrackIsRead": true,
"RequiresSecurityCodeWhenCardNumberIsTyped": true,
"RequiresTypingLast4Digits": true,
"CapturesServiceFee": true,
"AllowCancellationWithValueGreaterThanTheValueOfTheSale": true,
"CaptureBoardingFee": true
}
],
"Issuers": [
{
"IssuerId": 0,
"IssuerName": "string",
"AllowFallbackWhenChipReadingFails": true,
"AllowChargingMoedeiroFromCash": true,
"AllowPurchaseWithCompreESaque": true,
"AllowOfflineFunctionExceptForEMVCard": true,
"AllowTypingCardNumber": true,
"MaskCardNumberUsingLast4Digits": true,
"MaskCardNumberUsingFirst6AndLast4Digits": true,
"AllowPrintCardHolderBalance": true,
"AllowDisplayCardHolderBalance": true,
"Option03BiAllowPrintingPartialCardNumberInReceipt07": true,
"RestrictSaleWithDuplicateValueWhenPostdated": true,
"RestrictSaleWithDuplicateValue": true,
"RequiresPassword": true,
"InterpretsLastDigitOfSecurityCode": true,
"RequiresPasswordExceptForEMVCard": true,
"EnableAdditionalSecurityCodeOptions_Unreadable_NoCode": true,
"RequiresSecurityCodeWhenMagneticTrackIsRead": true,
"RequiresSecurityCodeWhenCardNumberIsTyped": true,
"RequiresTypingLast4Digits": true,
"AllowCaptureOfFirstInstallmentValue": true,
"AllowCaptureOfDownpaymentValue": true,
"AllowGuaranteeHandling": true,
"AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery": true,
"AllowPostdating": true,
"AllowCDCSale": true,
"AllowFinancingByStore": true,
"AllowFinancingByCreditCardCompany": true,
"RequiresChipReader": true,
"RequiresPinpad": true,
"LimitDayforReversal": 0,
"LimitValueforReversal": "string",
"LimitPercentforReversal": 0,
"IssuerNameForDisplay": "string",
"IssuerNameForPrint": "string"
}
],
"AidParameters": "string",
"PublicKeys": "string",
"InitializationVersion": 1558708320029
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantId |
String | — | — | Identificador da loja |
TerminalId |
String | — | — | Identificador do terminal |
Acquirer.EnableContaclessCardReader |
Booleano | — | — | Habilita Leitora Cartão Sem Contato |
Acquirer.LockAppFunctionsExceptInitialization |
Booleano | — | — | Bloquear as funções do aplicativo, com exceção da Inicialização |
Acquirer.HasChipReader |
Booleano | — | — | Indica que tem leitora de Chip-Card |
Acquirer.HasMagneticTrackReader |
Booleano | — | — | Indica que tem leitor da trilha magnética |
Acquirer.HasKeyboard |
Booleano | — | — | Indica que tem teclado para digitação |
Acquirer.IntervalInDaysForSendingTechnicalParameter |
Integer | — | Não | intervalo em dias de envio da Baixa Técnica, sendo: 0 - nunca enviar 1 a 99 - intervalo em dias, exemplo: 30 = enviar a cada 30 dias. |
Merchant.MerchantId |
String | — | — | Código do Lojista na PayStore, definido no momento da criação do lojista. |
Merchant.NetworkName |
String | — | — | Nome da rede da sub-adquirente cadastrado pelo Gestor da PayStore. |
Merchant.MerchantName |
String | — | — | Nome fantasia do lojista, definido no momento da criação do mesmo no portal da PayStore. |
Merchant.MerchantAddress |
String | — | — | Endereço do lojista obtido a partir da digitação do CEP momento da criação do mesmo no portal da PayStore. |
Merchant.NationalId |
String | — | — | CPF ou CNPJ, definido no momento da criação do Lojista no portal da PayStore. |
Bins.InitialBin |
String | — | — | Início do range de BIN’s. |
Bins.FinalBin |
String | — | — | Final do range de BIN’s. |
Bins.ProductId |
Integer int32 | — | — | Chave estrangeira de “PRODUCT TABLE”. |
Bins.Type |
Integer int32 | — | — | Admite os seguintes valores 0 - ESPECÍFICO 1 – GENERICO. |
Bins.AllowFallbackWhenChipReadingFails |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Bins.AllowChargingMoedeiroFromCash |
Booleano | — | — | Permite carga de moedeiro a partir de dinheiro em espécie. |
Bins.AllowPurchaseWithCompreESaque |
Booleano | — | — | Permite venda com Compre & Saque. |
Bins.AllowOfflineFunctionExceptForEMVCard |
Booleano | — | — | Permite função offline, exceto cartão EMV. |
Bins.AllowTypingCardNumber |
Booleano | — | — | Permite digitação do número do cartão. |
Bins.MaskCardNumberUsingLast4Digits |
Booleano | — | — | Imprimir apenas os 4 últimos dígitos do cartão. |
Bins.MaskCardNumberUsingFirst6AndLast4Digits |
Booleano | — | — | Imprimir os 6 primeiros e os 4 últimos dígitos do cartão. |
Bins.AllowPrintCardHolderBalance |
Booleano | — | — | Permite imprimir o saldo do portador. |
Bins.AllowDisplayCardHolderBalance |
Booleano | — | — | Permite exibir no display o saldo do portador. |
Bins.AllowPrintingPartialCardNumberInReceipt |
Booleano | — | — | Permite impressão parcial do número do cartão no comprovante das transações. |
Bins.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado para prédatamento. |
Bins.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado. |
Bins.RequiresPassword |
Booleano | — | — | Solicita senha. |
Bins.InterpretsLastDigitOfSecurityCode |
Booleano | — | — | Interpreta último dígito do Código de Serviço. |
Bins.RequiresPasswordExceptForEMVCard |
Booleano | — | — | Solicita senha, exceto cartão EMV. |
Bins.EnableAdditionalSecurityCodeOptions_Unreadable_NoCode |
Booleano | — | — | Habilita opções “Ilegível” e “Não Possui” para Código de Segurança. |
Bins.RequiresSecurityCodeWhenMagneticTrackIsRead |
Booleano | — | — | Solicita Código de Segurança na leitura de trilha. |
Bins.RequiresSecurityCodeWhenCardNumberIsTyped |
Booleano | — | — | Solicita Código de Segurança para cartão digitado. |
Bins.RequiresTypingLast4Digits |
Booleano | — | — | Solicita digitação dos últimos 4 dígitos. |
Bins.AllowCaptureOfFirstInstallmentValue |
Booleano | — | — | Permite captura do valor da primeira parcela. |
Bins.AllowCaptureOfDownpaymentValue |
Booleano | — | — | Permite captura do valor de entrada. |
Bins.AllowGuaranteeHandling |
Booleano | — | — | Permite tratamento de garantia. |
Bins.AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery |
Booleano | — | — | Permite pré-datar a primeira parcela para venda e consulta CDC. |
Bins.AllowPostdating |
Booleano | — | — | Permite pré-datamento. |
Bins.AllowCDCSale |
Booleano | — | — | Permite venda CDC. |
Bins.AllowFinancingByStore |
Booleano | — | — | Permite financiamento pela Loja. |
Bins.AllowFinancingByCreditCardCompany |
Booleano | — | — | Permite financiamento pela Administradora. |
Bins.ValidateCardTrack1 |
Booleano | — | — | Verifica Trilha 1 do cartão. |
Bins.DoNotValidateCardModule10 |
Booleano | — | — | Não validar o Módulo 10 do cartão. |
Bins.CheckExpiryDateWhenCardNumberIsTyped |
Booleano | — | — | Verifica data de validade do cartão digitado. |
Bins.CheckExpiryDateWhenMagneticTrackIsRead |
Booleano | — | — | Verifica data de validade da trilha. |
Bins.IssuerId |
Integer int32 | — | — | Chave estrangeira de “ISSUER TABLE”. |
Products.ProductId |
Integer int32 | — | — | Identificador do produto. |
Products.ProductName |
String | — | — | Nome do produto. |
Products.ProductType |
Integer int32 | — | — | Admite os seguintes valores 0 - CREDITO 1 – DEBITO |
Products.BrandId |
String | — | — | Identificador da bandeira do cartão. |
Products.AllowTransactionWithContactlessCard |
Booleano | — | — | Permite Transação com Cartão Sem Contato. |
Products.IsFinancialProduct |
Booleano | — | — | Produto Financeiro. |
Products.AllowOfflineAuthorizationForEMVCard |
Booleano | — | — | Permite Autorização Offline EMV. |
Products.AllowReprintReceipt |
Booleano | — | — | Permite Reimpressão do comprovante. |
Products.AllowPrintReceipt |
Booleano | — | — | Permite Impressão do comprovante. |
Products.AllowOfflineAuthorizationForContactlessCard |
Booleano | — | — | Permite Autorização Offline para Cartão Sem Contato. |
Products.AllowCancel |
Booleano | — | — | Permite Cancelamento. |
Products.AllowUndo |
Booleano | — | — | Permite Desfazimento. |
Products.AllowCaptureOfFirstInstallmentValue |
Booleano | — | — | Permite captura do valor da primeira parcela. |
Products.AllowCaptureOfDownpaymentValue |
Booleano | — | — | Permite captura do valor de entrada. |
Products.AllowGuaranteeHandling |
Booleano | — | — | Permite tratamento de garantia. |
Products.AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery |
Booleano | — | — | Permite pré-datar a primeira parcela para venda e consulta CDC. |
Products.AllowPostdating |
Booleano | — | — | Permite pré-datamento. |
Products.AllowCDCSale |
Booleano | — | — | Permite venda CDC. |
Products.AllowFinancingByStore |
Booleano | — | — | Permite financiamento pela Loja. |
Products.AllowFinancingByCreditCardCompany |
Booleano | — | — | Permite financiamento pela Administradora. |
Products.MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany |
Integer int32 | — | — | Número máximo de parcelas para financiamento ADM. |
Products.MaximumNumberOfInstallmentsWhenFinancingByStore |
Integer int32 | — | — | Número máximo de parcelas para financiamento Loja. |
Products.MaximumNumberOfinstallmentsForSaleAndCDCQuery |
Integer int32 | — | — | Número máximo de parcelas para venda e consulta CDC. |
Products.MinimumNumberOfInstallmentsWhenFinancingByStore |
Integer int64 | — | — | Valor mínimo de parcelas para financiamento Loja. |
Products.PostdatedSaleGuaranteeType |
String | — | — | Tipo de Garantia para o Pré-datado. Admite os seguintes valores 00 – Não permite tratamento de Garantia (Venda Garantida); 05 – Permite transações Pré-datadas Garantidas; 07 – Permite transações Pré-datadas Garantidas e Sem Garantia. |
Products.PostdatedDayCountLimit |
Integer int32 | — | — | Limite máximo em dias para pré-datar a partir da data atual. 00 – Não aceita. XX - Pré-datado. |
Products.FirstInstallmentDayCountLimit |
Integer int32 | — | — | Limite da data de primeira parcela. 00 – Não aceita. XX - Limite de dias. |
Emv.Aid |
String | — | — | Identificador da aplicação EMV. |
Emv.TagsFirst |
String | — | — | Conjunto de tags obrigatórias enviadas o 1º Generate AC. |
Emv.TagsSecond |
String | — | — | Conjunto de tags obrigatórias enviadas o 2º Generate AC. |
Emv.IdxRecord |
Integer int32 | — | — | — |
Emv.Type |
Integer int32 | — | — | Admite os seguintes valores 0 - CREDITO 1 – DEBITO |
Emv.RCodeFirst |
String | — | — | — |
Emv.RCodeSecond |
String | — | — | — |
Emv.InvalidateFunctionIfCardIsOnBlacklist |
Booleano | — | — | Invalida a função se o cartão consta na Lista Negra. |
Emv.RequireBINToBeInCardRangeTable |
Booleano | — | — | Obriga que o BIN esteja na tabela de Range de Cartões (tipo 2B). |
Emv.StoreTransactionsRejectedByTerminalAppAndSendToHost |
Booleano | — | — | Armazena e envia para o Host as transações rejeitadas pelo aplicativo do terminal. |
Emv.AllowOnlineAuthorizationTransactionRequest |
Booleano | — | — | — |
Emv.AllowExtendedCardHolderName |
Booleano | — | — | — |
Emv.NatEmvConctactRiskFloorLimit |
Integer int32 | — | — | Valor máximo de verificação para autorização offline das transações. As transações realizadas com a leitura do Chip EMV e com valor acima do “Floor limit”, deverão ser autorizadas no modo online. |
Emv.NatEmvConctactRiskMinValue |
Integer int32 | — | — | Valor mínimo para o cálculo de seleção aleatória para autorização offline. Conforme processo definido na Especificação EMV. |
Emv.NatEmvConctactRiskMinPercent |
Integer int32 | — | — | Porcentagem mínima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.NatEmvConctactRiskMaxPercent |
Integer int32 | — | — | Porcentagem máxima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.IntEmvConctactRiskFloorLimit |
Integer int32 | — | — | Valor máximo de verificação para autorização offline das transações. As transações realizadas com a leitura do Chip EMV e com valor acima do “Floor limit”, deverão ser autorizadas no modo online. |
Emv.IntEmvConctactRiskMinValue |
Integer int32 | — | — | Valor mínimo para o cálculo de seleção aleatória para autorização offline. Conforme processo definido na Especificação EMV. |
Emv.IntEmvConctactRiskMinPercent |
Integer int32 | — | — | Porcentagem mínima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.IntEmvConctactRiskMaxPercent |
Integer int32 | — | — | Porcentagem máxima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.ProductIds |
Array of integers int32 | — | — | Produtos habilitados para esta aplicação EMV. |
Parameters.Currency |
String | — | — | — |
Parameters.AllowFallbackWhenChipReadingFails |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Parameters.AllowChargingMoedeiroFromCash |
Booleano | — | — | Permite carga de moedeiro a partir de dinheiro em espécie. |
Parameters.AllowPurchaseWithCompreESaque |
Booleano | — | — | Permite venda com Compre & Saque. |
Parameters.AllowOfflineFunctionExceptForEMVCard |
Booleano | — | — | Permite função offline, exceto cartão EMV. |
Parameters.AllowTypingCardNumber |
Booleano | — | — | Permite entrada manual do número do cartão. |
Parameters.MaskCardNumberUsingLast4Digits |
Booleano | — | — | Imprimir apenas os 4 últimos dígitos do cartão. |
Parameters.MaskCardNumberUsingFirst6AndLast4Digits |
Booleano | — | — | Imprimir os 6 primeiros e os 4 últimos dígitos do cartão. |
Parameters.AllowPrintCardHolderBalance |
Booleano | — | — | Permite imprimir o saldo do portador. |
Parameters.AllowDisplayCardHolderBalance |
Booleano | — | — | Permite exibir no display o saldo do portador. |
Parameters.AllowPrintingPartialCardNumberInReceipt |
Booleano | — | — | Permite impressão parcial do número do cartão no comprovante das transações. |
Parameters.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado para pré-datamento. |
Parameters.RestrictSaleWithDuplicateValue |
Booleano | — | — | Impede venda com valor duplicado. |
Parameters.RequiresPassword |
Booleano | — | — | Solicita senha. |
Parameters.InterpretsLastDigitOfSecurityCode |
Booleano | — | — | Interpreta último dígito do Código de Serviço. |
Parameters.RequiresPasswordExceptForEMVCard |
Booleano | — | — | Solicita senha, exceto cartão EMV. |
Parameters.EnableAdditionalSecurityCodeOptions_Unreadable_NoCode |
Booleano | — | — | Habilita opções “Ilegível” e “Não Possui” para Código de Segurança. |
Parameters.RequiresSecurityCodeWhenMagneticTrackIsRead |
Booleano | — | — | Solicita Código de Segurança na leitura de trilha. |
Parameters.RequiresSecurityCodeWhenCardNumberIsTyped |
Booleano | — | — | Solicita Código de Segurança para cartão digitado. |
Parameters.RequiresTypingLast4Digits |
Booleano | — | — | Solicita digitação dos últimos 4 dígitos. |
Parameters.CapturesServiceFee |
Booleano | — | — | Captura Taxa de Serviço. |
Parameters.AllowCancellationWithValueGreaterThanTheValueOfTheSale |
Booleano | — | — | Permite valor do Cancelamento maior que o valor da venda original. |
Parameters.CaptureBoardingFee |
Booleano | — | — | Captura Taxa de Embarque. |
Issuers.IssuerId |
integer int32 | — | — | Identificador do emissor. |
Issuers.IssuerName |
String | — | — | Nome do emissor. |
Issuers.AllowFallbackWhenChipReadingFails |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Issuers.AllowChargingMoedeiroFromCash |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Issuers.AllowPurchaseWithCompreESaque |
Booleano | — | — | Permite venda com Compre & Saque. |
Issuers.AllowOfflineFunctionExceptForEMVCard |
Booleano | — | — | Permite função offline, exceto cartão EMV. |
Issuers.AllowTypingCardNumber |
Booleano | — | — | Permite digitação do número do cartão. |
Issuers.MaskCardNumberUsingLast4Digits |
Booleano | — | — | Imprimir apenas os 4 últimos dígitos do cartão. |
Issuers.MaskCardNumberUsingFirst6AndLast4Digits |
Booleano | — | — | Imprimir os 6 primeiros e os 4 últimos dígitos do cartão. |
Issuers.AllowPrintCardHolderBalance |
Booleano | — | — | Permite imprimir o saldo do portador. |
Issuers.AllowDisplayCardHolderBalance |
Booleano | — | — | Permite exibir no display o saldo do portador. |
Issuers.Option03BiAllowPrintingPartialCardNumberInReceipt07 |
Booleano | — | — | Permite impressão parcial do número do cartão no comprovante das transações. |
Issuers.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado para pré-datamento. |
Issuers.RestrictSaleWithDuplicateValue |
Booleano | — | — | Impede venda com valor duplicado. |
Issuers.RequiresPassword |
Booleano | — | — | Solicita senha. |
Issuers.InterpretsLastDigitOfSecurityCode |
Booleano | — | — | Interpreta último dígito do Código de Serviço. |
Issuers.RequiresPasswordExceptForEMVCard |
Booleano | — | — | Solicita senha, exceto cartão EMV. |
Issuers.EnableAdditionalSecurityCodeOptions_Unreadable_NoCode |
Booleano | — | — | Habilita opções “Ilegível” e “Não Possui” para Código de Segurança. |
Issuers.RequiresSecurityCodeWhenMagneticTrackIsRead |
Booleano | — | — | Solicita Código de Segurança na leitura de trilha. |
Issuers.RequiresSecurityCodeWhenCardNumberIsTyped |
Booleano | — | — | Solicita Código de Segurança para cartão digitado. |
Issuers.RequiresTypingLast4Digits |
Booleano | — | — | Solicita digitação dos últimos 4 dígitos. |
Issuers.AllowCaptureOfFirstInstallmentValue |
Booleano | — | — | Permite captura do valor da primeira parcela. |
Issuers.AllowCaptureOfDownpaymentValue |
Booleano | — | — | Permite captura do valor de entrada. |
Issuers.AllowGuaranteeHandling |
Booleano | — | — | Permite tratamento de garantia. |
Issuers.AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery |
Booleano | — | — | Permite pré-datar a primeira parcela para venda e consulta CDC. |
Issuers.AllowPostdating |
Booleano | — | — | Permite pré-datamento. |
Issuers.AllowCDCSale |
Booleano | — | — | Permite venda CDC. |
Issuers.AllowFinancingByStore |
Booleano | — | — | Permite financiamento pela Loja. |
Issuers.AllowFinancingByCreditCardCompany |
Booleano | — | — | Permite financiamento pela Administradora. |
Issuers.RequiresChipReader |
Booleano | — | — | Exige a existência de Leitor de Chip. |
Issuers.RequiresPinpad |
Booleano | — | — | Exige a existência de PIN-pad. |
Issuers.LimitDayforReversal |
integer int32 | — | — | Data limite em dias para permitir Cancelamento. |
Issuers.LimitValueforReversal |
String | — | — | Valor máximo para Cancelamento. |
Issuers.LimitPercentforReversal |
integer int64 | — | — | Percentual máximo para Cancelamento. |
Issuers.IssuerNameForDisplay |
String | — | — | Nome do Issuer para o Display. |
Issuers.IssuerNameForPrint |
String | — | — | Nome do Issuer para Impressão. |
AidParameters |
— | — | — | — |
PublicKeys |
— | — | — | — |
InitializationVersion |
— | — | — | — |
Inicialização com baixa tecnica
Solicita as tabelas e parametros para operação do terminal.
Requisição
Path Parameters:
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
SubordinatedMerchantId |
String(Guid) | 36 | Sim | Identificador da loja |
TerminalId |
String | — | Sim | Identificador do terminal |
TechnicalParameter |
Object | — | Não | Objeto com os parametros da baixa tecnica |
TechnicalParameter.KernelEmvVersion |
String | — | Sim | Versão kernel EMV com contato |
TechnicalParameter.ContactlessModuleVersion |
String | — | Sim | Versão kernel EMV contactless |
TechnicalParameter.KernelPayPassVersion |
String | — | Sim | Versão kernel contactless Mastercard PayPass / MCL |
TechnicalParameter.KernelContactlessPayWaveVersion |
String | — | Sim | Versão kernel contactless Visa PayWave |
TechnicalParameter.HardwareModel |
String | — | Sim | Modelo do pinpad |
TechnicalParameter.ManufacturerName |
String | — | Sim | Nome do fabricante do pinpad |
TechnicalParameter.FirmwareVersion |
String | — | Sim | Versão do firmware |
TechnicalParameter.BasicLibVersion |
String | — | Sim | versão da aplicação básica |
TechnicalParameter.SpecificationVersion |
String | — | Sim | Versão da especificação |
TechnicalParameter.AcquirerVersion |
String | — | Sim | Versão da rede adquirente |
TechnicalParameter.SimCardNumber |
String | — | Sim | Número do SIM Card que é utilizado no pelo terminal |
TechnicalParameter.PaymentAppVersion |
String | — | Sim | Versão do App de pagamentos. No caso do SDK android será versão do PaymentsApp. Já no caso do SDK PhAST será a versão da TEF Sueite. |
TechnicalParameter.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
TechnicalParameter.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato =PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
TechnicalParameter.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
{
"SubordinatedMerchantId": "",
"TerminalId": "12345678",
"TechnicalParameter": {
"KernelEmvVersion": "v653",
"ContactlessModuleVersion": "v553",
"KernelPayPassVersion": "553",
"KernelContactlessPayWaveVersion": "553",
"HardwareModel": "S920",
"ManufacturerName": "PAX",
"FirmwareVersion": "2.4.149",
"BasicLibVersion": "001.41 200617",
"SpecificationVersion": "1.08",
"AcquirerVersion": "001.41 200617",
"SimCardNumber": "123",
"PaymentAppVersion": "abc",
"PhysicalCharacteristics": "PinPadWithChipReaderWithoutSamAndContactless",
"ReturnDataInfo": "00",
"SerialNumber": "0820471929"
}
}
Resposta
{
"MerchantId": "000002",
"TerminalId": "12345678",
"Acquirer": {
"EnableContaclessCardReader": true,
"LockAppFunctionsExceptInitialization": true,
"HasChipReader": true,
"HasMagneticTrackReader": true,
"HasKeyboard": true,
"IntervalInDaysForSendingTechnicalParameter": 10
},
"Merchant": {
"MerchantId": "string",
"NetworkName": "string",
"MerchantName": "string",
"MerchantAddress": "string",
"NationalId": "string"
},
"Bins": [
{
"InitialBin": "string",
"FinalBin": "string",
"ProductId": 0,
"Type": 0,
"AllowFallbackWhenChipReadingFails": true,
"AllowChargingMoedeiroFromCash": true,
"AllowPurchaseWithCompreESaque": true,
"AllowOfflineFunctionExceptForEMVCard": true,
"AllowTypingCardNumber": true,
"MaskCardNumberUsingLast4Digits": true,
"MaskCardNumberUsingFirst6AndLast4Digits": true,
"AllowPrintCardHolderBalance": true,
"AllowDisplayCardHolderBalance": true,
"AllowPrintingPartialCardNumberInReceipt": true,
"RestrictSaleWithDuplicateValueWhenPostdated": true,
"RestrictSaleWithDuplicateValue": true,
"RequiresPassword": true,
"InterpretsLastDigitOfSecurityCode": true,
"RequiresPasswordExceptForEMVCard": true,
"EnableAdditionalSecurityCodeOptions_Unreadable_NoCode": true,
"RequiresSecurityCodeWhenMagneticTrackIsRead": true,
"RequiresSecurityCodeWhenCardNumberIsTyped": true,
"RequiresTypingLast4Digits": true,
"AllowCaptureOfFirstInstallmentValue": true,
"AllowCaptureOfDownpaymentValue": true,
"AllowGuaranteeHandling": true,
"AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery": true,
"AllowPostdating": true,
"AllowCDCSale": true,
"AllowFinancingByStore": true,
"AllowFinancingByCreditCardCompany": true,
"ValidateCardTrack1": true,
"DoNotValidateCardModule10": true,
"CheckExpiryDateWhenCardNumberIsTyped": true,
"CheckExpiryDateWhenMagneticTrackIsRead": true,
"IssuerId": 0
}
],
"Products": [
{
"ProductId": 0,
"ProductName": "string",
"ProductType": 0,
"BrandId": "string",
"AllowTransactionWithContactlessCard": true,
"IsFinancialProduct": true,
"AllowOfflineAuthorizationForEMVCard": true,
"AllowReprintReceipt": true,
"AllowPrintReceipt": true,
"AllowOfflineAuthorizationForContactlessCard": true,
"AllowCancel": true,
"AllowUndo": true,
"AllowCaptureOfFirstInstallmentValue": true,
"AllowCaptureOfDownpaymentValue": true,
"AllowGuaranteeHandling": true,
"AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery": true,
"AllowPostdating": true,
"AllowCDCSale": true,
"AllowFinancingByStore": true,
"AllowFinancingByCreditCardCompany": true,
"MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany": 0,
"MaximumNumberOfInstallmentsWhenFinancingByStore": 0,
"MaximumNumberOfinstallmentsForSaleAndCDCQuery": 0,
"MinimumNumberOfInstallmentsWhenFinancingByStore": 0,
"PostdatedSaleGuaranteeType": "DoNotAllowSalesWithGuarantee",
"PostdatedDayCountLimit": 0,
"FirstInstallmentDayCountLimit": 0
}
],
"Emv": [
{
"Aid": "string",
"TagsFirst": "string",
"TagsSecond": "string",
"IdxRecord": 0,
"Type": 0,
"RCodeFirst": "string",
"RCodeSecond": "string",
"InvalidateFunctionIfCardIsOnBlacklist": true,
"RequireBINToBeInCardRangeTable": true,
"StoreTransactionsRejectedByTerminalAppAndSendToHost": true,
"AllowOnlineAuthorizationTransactionRequest": true,
"AllowExtendedCardHolderName": true,
"NatEmvConctactRiskFloorLimit": 0,
"NatEmvConctactRiskMinValue": 0,
"NatEmvConctactRiskMinPercent": 0,
"NatEmvConctactRiskMaxPercent": 0,
"IntEmvConctactRiskFloorLimit": 0,
"IntEmvConctactRiskMinValue": 0,
"IntEmvConctactRiskMinPercent": 0,
"IntEmvConctactRiskMaxPercent": 0,
"ProductIds": [
0
]
}
],
"Parameters": [
{
"Currency": "string",
"AllowFallbackWhenChipReadingFails": true,
"AllowChargingMoedeiroFromCash": true,
"AllowPurchaseWithCompreESaque": true,
"AllowOfflineFunctionExceptForEMVCard": true,
"AllowTypingCardNumber": true,
"MaskCardNumberUsingLast4Digits": true,
"MaskCardNumberUsingFirst6AndLast4Digits": true,
"AllowPrintCardHolderBalance": true,
"AllowDisplayCardHolderBalance": true,
"AllowPrintingPartialCardNumberInReceipt": true,
"RestrictSaleWithDuplicateValueWhenPostdated": true,
"RestrictSaleWithDuplicateValue": true,
"RequiresPassword": true,
"InterpretsLastDigitOfSecurityCode": true,
"RequiresPasswordExceptForEMVCard": true,
"EnableAdditionalSecurityCodeOptions_Unreadable_NoCode": true,
"RequiresSecurityCodeWhenMagneticTrackIsRead": true,
"RequiresSecurityCodeWhenCardNumberIsTyped": true,
"RequiresTypingLast4Digits": true,
"CapturesServiceFee": true,
"AllowCancellationWithValueGreaterThanTheValueOfTheSale": true,
"CaptureBoardingFee": true
}
],
"Issuers": [
{
"IssuerId": 0,
"IssuerName": "string",
"AllowFallbackWhenChipReadingFails": true,
"AllowChargingMoedeiroFromCash": true,
"AllowPurchaseWithCompreESaque": true,
"AllowOfflineFunctionExceptForEMVCard": true,
"AllowTypingCardNumber": true,
"MaskCardNumberUsingLast4Digits": true,
"MaskCardNumberUsingFirst6AndLast4Digits": true,
"AllowPrintCardHolderBalance": true,
"AllowDisplayCardHolderBalance": true,
"Option03BiAllowPrintingPartialCardNumberInReceipt07": true,
"RestrictSaleWithDuplicateValueWhenPostdated": true,
"RestrictSaleWithDuplicateValue": true,
"RequiresPassword": true,
"InterpretsLastDigitOfSecurityCode": true,
"RequiresPasswordExceptForEMVCard": true,
"EnableAdditionalSecurityCodeOptions_Unreadable_NoCode": true,
"RequiresSecurityCodeWhenMagneticTrackIsRead": true,
"RequiresSecurityCodeWhenCardNumberIsTyped": true,
"RequiresTypingLast4Digits": true,
"AllowCaptureOfFirstInstallmentValue": true,
"AllowCaptureOfDownpaymentValue": true,
"AllowGuaranteeHandling": true,
"AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery": true,
"AllowPostdating": true,
"AllowCDCSale": true,
"AllowFinancingByStore": true,
"AllowFinancingByCreditCardCompany": true,
"RequiresChipReader": true,
"RequiresPinpad": true,
"LimitDayforReversal": 0,
"LimitValueforReversal": "string",
"LimitPercentforReversal": 0,
"IssuerNameForDisplay": "string",
"IssuerNameForPrint": "string"
}
],
"AidParameters": "string",
"PublicKeys": "string",
"InitializationVersion": 1558708320029
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantId |
String | — | — | Identificador da loja |
TerminalId |
String | — | — | Identificador do terminal |
Acquirer.EnableContaclessCardReader |
Booleano | — | — | Habilita Leitora Cartão Sem Contato |
Acquirer.LockAppFunctionsExceptInitialization |
Booleano | — | — | Bloquear as funções do aplicativo, com exceção da Inicialização |
Acquirer.HasChipReader |
Booleano | — | — | Indica que tem leitora de Chip-Card |
Acquirer.HasMagneticTrackReader |
Booleano | — | — | Indica que tem leitor da trilha magnética |
Acquirer.HasKeyboard |
Booleano | — | — | Indica que tem teclado para digitação |
Acquirer.IntervalInDaysForSendingTechnicalParameter |
Integer | — | Não | intervalo em dias de envio da Baixa Técnica, sendo: 0 - nunca enviar 1 a 99 - intervalo em dias, exemplo: 30 = enviar a cada 30 dias. |
Merchant.MerchantId |
String | — | — | Código do Lojista na PayStore, definido no momento da criação do lojista. |
Merchant.NetworkName |
String | — | — | Nome da rede da sub-adquirente cadastrado pelo Gestor da PayStore. |
Merchant.MerchantName |
String | — | — | Nome fantasia do lojista, definido no momento da criação do mesmo no portal da PayStore. |
Merchant.MerchantAddress |
String | — | — | Endereço do lojista obtido a partir da digitação do CEP momento da criação do mesmo no portal da PayStore. |
Merchant.NationalId |
String | — | — | CPF ou CNPJ, definido no momento da criação do Lojista no portal da PayStore. |
Bins.InitialBin |
String | — | — | Início do range de BIN’s. |
Bins.FinalBin |
String | — | — | Final do range de BIN’s. |
Bins.ProductId |
Integer int32 | — | — | Chave estrangeira de “PRODUCT TABLE”. |
Bins.Type |
Integer int32 | — | — | Admite os seguintes valores 0 - ESPECÍFICO 1 – GENERICO. |
Bins.AllowFallbackWhenChipReadingFails |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Bins.AllowChargingMoedeiroFromCash |
Booleano | — | — | Permite carga de moedeiro a partir de dinheiro em espécie. |
Bins.AllowPurchaseWithCompreESaque |
Booleano | — | — | Permite venda com Compre & Saque. |
Bins.AllowOfflineFunctionExceptForEMVCard |
Booleano | — | — | Permite função offline, exceto cartão EMV. |
Bins.AllowTypingCardNumber |
Booleano | — | — | Permite digitação do número do cartão. |
Bins.MaskCardNumberUsingLast4Digits |
Booleano | — | — | Imprimir apenas os 4 últimos dígitos do cartão. |
Bins.MaskCardNumberUsingFirst6AndLast4Digits |
Booleano | — | — | Imprimir os 6 primeiros e os 4 últimos dígitos do cartão. |
Bins.AllowPrintCardHolderBalance |
Booleano | — | — | Permite imprimir o saldo do portador. |
Bins.AllowDisplayCardHolderBalance |
Booleano | — | — | Permite exibir no display o saldo do portador. |
Bins.AllowPrintingPartialCardNumberInReceipt |
Booleano | — | — | Permite impressão parcial do número do cartão no comprovante das transações. |
Bins.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado para prédatamento. |
Bins.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado. |
Bins.RequiresPassword |
Booleano | — | — | Solicita senha. |
Bins.InterpretsLastDigitOfSecurityCode |
Booleano | — | — | Interpreta último dígito do Código de Serviço. |
Bins.RequiresPasswordExceptForEMVCard |
Booleano | — | — | Solicita senha, exceto cartão EMV. |
Bins.EnableAdditionalSecurityCodeOptions_Unreadable_NoCode |
Booleano | — | — | Habilita opções “Ilegível” e “Não Possui” para Código de Segurança. |
Bins.RequiresSecurityCodeWhenMagneticTrackIsRead |
Booleano | — | — | Solicita Código de Segurança na leitura de trilha. |
Bins.RequiresSecurityCodeWhenCardNumberIsTyped |
Booleano | — | — | Solicita Código de Segurança para cartão digitado. |
Bins.RequiresTypingLast4Digits |
Booleano | — | — | Solicita digitação dos últimos 4 dígitos. |
Bins.AllowCaptureOfFirstInstallmentValue |
Booleano | — | — | Permite captura do valor da primeira parcela. |
Bins.AllowCaptureOfDownpaymentValue |
Booleano | — | — | Permite captura do valor de entrada. |
Bins.AllowGuaranteeHandling |
Booleano | — | — | Permite tratamento de garantia. |
Bins.AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery |
Booleano | — | — | Permite pré-datar a primeira parcela para venda e consulta CDC. |
Bins.AllowPostdating |
Booleano | — | — | Permite pré-datamento. |
Bins.AllowCDCSale |
Booleano | — | — | Permite venda CDC. |
Bins.AllowFinancingByStore |
Booleano | — | — | Permite financiamento pela Loja. |
Bins.AllowFinancingByCreditCardCompany |
Booleano | — | — | Permite financiamento pela Administradora. |
Bins.ValidateCardTrack1 |
Booleano | — | — | Verifica Trilha 1 do cartão. |
Bins.DoNotValidateCardModule10 |
Booleano | — | — | Não validar o Módulo 10 do cartão. |
Bins.CheckExpiryDateWhenCardNumberIsTyped |
Booleano | — | — | Verifica data de validade do cartão digitado. |
Bins.CheckExpiryDateWhenMagneticTrackIsRead |
Booleano | — | — | Verifica data de validade da trilha. |
Bins.IssuerId |
Integer int32 | — | — | Chave estrangeira de “ISSUER TABLE”. |
Products.ProductId |
Integer int32 | — | — | Identificador do produto. |
Products.ProductName |
String | — | — | Nome do produto. |
Products.ProductType |
Integer int32 | — | — | Admite os seguintes valores 0 - CREDITO 1 – DEBITO |
Products.BrandId |
String | — | — | Identificador da bandeira do cartão. |
Products.AllowTransactionWithContactlessCard |
Booleano | — | — | Permite Transação com Cartão Sem Contato. |
Products.IsFinancialProduct |
Booleano | — | — | Produto Financeiro. |
Products.AllowOfflineAuthorizationForEMVCard |
Booleano | — | — | Permite Autorização Offline EMV. |
Products.AllowReprintReceipt |
Booleano | — | — | Permite Reimpressão do comprovante. |
Products.AllowPrintReceipt |
Booleano | — | — | Permite Impressão do comprovante. |
Products.AllowOfflineAuthorizationForContactlessCard |
Booleano | — | — | Permite Autorização Offline para Cartão Sem Contato. |
Products.AllowCancel |
Booleano | — | — | Permite Cancelamento. |
Products.AllowUndo |
Booleano | — | — | Permite Desfazimento. |
Products.AllowCaptureOfFirstInstallmentValue |
Booleano | — | — | Permite captura do valor da primeira parcela. |
Products.AllowCaptureOfDownpaymentValue |
Booleano | — | — | Permite captura do valor de entrada. |
Products.AllowGuaranteeHandling |
Booleano | — | — | Permite tratamento de garantia. |
Products.AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery |
Booleano | — | — | Permite pré-datar a primeira parcela para venda e consulta CDC. |
Products.AllowPostdating |
Booleano | — | — | Permite pré-datamento. |
Products.AllowCDCSale |
Booleano | — | — | Permite venda CDC. |
Products.AllowFinancingByStore |
Booleano | — | — | Permite financiamento pela Loja. |
Products.AllowFinancingByCreditCardCompany |
Booleano | — | — | Permite financiamento pela Administradora. |
Products.MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany |
Integer int32 | — | — | Número máximo de parcelas para financiamento ADM. |
Products.MaximumNumberOfInstallmentsWhenFinancingByStore |
Integer int32 | — | — | Número máximo de parcelas para financiamento Loja. |
Products.MaximumNumberOfinstallmentsForSaleAndCDCQuery |
Integer int32 | — | — | Número máximo de parcelas para venda e consulta CDC. |
Products.MinimumNumberOfInstallmentsWhenFinancingByStore |
Integer int64 | — | — | Valor mínimo de parcelas para financiamento Loja. |
Products.PostdatedSaleGuaranteeType |
String | — | — | Tipo de Garantia para o Pré-datado. Admite os seguintes valores 00 – Não permite tratamento de Garantia (Venda Garantida); 05 – Permite transações Pré-datadas Garantidas; 07 – Permite transações Pré-datadas Garantidas e Sem Garantia. |
Products.PostdatedDayCountLimit |
Integer int32 | — | — | Limite máximo em dias para pré-datar a partir da data atual. 00 – Não aceita. XX - Pré-datado. |
Products.FirstInstallmentDayCountLimit |
Integer int32 | — | — | Limite da data de primeira parcela. 00 – Não aceita. XX - Limite de dias. |
Emv.Aid |
String | — | — | Identificador da aplicação EMV. |
Emv.TagsFirst |
String | — | — | Conjunto de tags obrigatórias enviadas o 1º Generate AC. |
Emv.TagsSecond |
String | — | — | Conjunto de tags obrigatórias enviadas o 2º Generate AC. |
Emv.IdxRecord |
Integer int32 | — | — | — |
Emv.Type |
Integer int32 | — | — | Admite os seguintes valores 0 - CREDITO 1 – DEBITO |
Emv.RCodeFirst |
String | — | — | — |
Emv.RCodeSecond |
String | — | — | — |
Emv.InvalidateFunctionIfCardIsOnBlacklist |
Booleano | — | — | Invalida a função se o cartão consta na Lista Negra. |
Emv.RequireBINToBeInCardRangeTable |
Booleano | — | — | Obriga que o BIN esteja na tabela de Range de Cartões (tipo 2B). |
Emv.StoreTransactionsRejectedByTerminalAppAndSendToHost |
Booleano | — | — | Armazena e envia para o Host as transações rejeitadas pelo aplicativo do terminal. |
Emv.AllowOnlineAuthorizationTransactionRequest |
Booleano | — | — | — |
Emv.AllowExtendedCardHolderName |
Booleano | — | — | — |
Emv.NatEmvConctactRiskFloorLimit |
Integer int32 | — | — | Valor máximo de verificação para autorização offline das transações. As transações realizadas com a leitura do Chip EMV e com valor acima do “Floor limit”, deverão ser autorizadas no modo online. |
Emv.NatEmvConctactRiskMinValue |
Integer int32 | — | — | Valor mínimo para o cálculo de seleção aleatória para autorização offline. Conforme processo definido na Especificação EMV. |
Emv.NatEmvConctactRiskMinPercent |
Integer int32 | — | — | Porcentagem mínima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.NatEmvConctactRiskMaxPercent |
Integer int32 | — | — | Porcentagem máxima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.IntEmvConctactRiskFloorLimit |
Integer int32 | — | — | Valor máximo de verificação para autorização offline das transações. As transações realizadas com a leitura do Chip EMV e com valor acima do “Floor limit”, deverão ser autorizadas no modo online. |
Emv.IntEmvConctactRiskMinValue |
Integer int32 | — | — | Valor mínimo para o cálculo de seleção aleatória para autorização offline. Conforme processo definido na Especificação EMV. |
Emv.IntEmvConctactRiskMinPercent |
Integer int32 | — | — | Porcentagem mínima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.IntEmvConctactRiskMaxPercent |
Integer int32 | — | — | Porcentagem máxima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.ProductIds |
Array of integers int32 | — | — | Produtos habilitados para esta aplicação EMV. |
Parameters.Currency |
String | — | — | — |
Parameters.AllowFallbackWhenChipReadingFails |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Parameters.AllowChargingMoedeiroFromCash |
Booleano | — | — | Permite carga de moedeiro a partir de dinheiro em espécie. |
Parameters.AllowPurchaseWithCompreESaque |
Booleano | — | — | Permite venda com Compre & Saque. |
Parameters.AllowOfflineFunctionExceptForEMVCard |
Booleano | — | — | Permite função offline, exceto cartão EMV. |
Parameters.AllowTypingCardNumber |
Booleano | — | — | Permite entrada manual do número do cartão. |
Parameters.MaskCardNumberUsingLast4Digits |
Booleano | — | — | Imprimir apenas os 4 últimos dígitos do cartão. |
Parameters.MaskCardNumberUsingFirst6AndLast4Digits |
Booleano | — | — | Imprimir os 6 primeiros e os 4 últimos dígitos do cartão. |
Parameters.AllowPrintCardHolderBalance |
Booleano | — | — | Permite imprimir o saldo do portador. |
Parameters.AllowDisplayCardHolderBalance |
Booleano | — | — | Permite exibir no display o saldo do portador. |
Parameters.AllowPrintingPartialCardNumberInReceipt |
Booleano | — | — | Permite impressão parcial do número do cartão no comprovante das transações. |
Parameters.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado para pré-datamento. |
Parameters.RestrictSaleWithDuplicateValue |
Booleano | — | — | Impede venda com valor duplicado. |
Parameters.RequiresPassword |
Booleano | — | — | Solicita senha. |
Parameters.InterpretsLastDigitOfSecurityCode |
Booleano | — | — | Interpreta último dígito do Código de Serviço. |
Parameters.RequiresPasswordExceptForEMVCard |
Booleano | — | — | Solicita senha, exceto cartão EMV. |
Parameters.EnableAdditionalSecurityCodeOptions_Unreadable_NoCode |
Booleano | — | — | Habilita opções “Ilegível” e “Não Possui” para Código de Segurança. |
Parameters.RequiresSecurityCodeWhenMagneticTrackIsRead |
Booleano | — | — | Solicita Código de Segurança na leitura de trilha. |
Parameters.RequiresSecurityCodeWhenCardNumberIsTyped |
Booleano | — | — | Solicita Código de Segurança para cartão digitado. |
Parameters.RequiresTypingLast4Digits |
Booleano | — | — | Solicita digitação dos últimos 4 dígitos. |
Parameters.CapturesServiceFee |
Booleano | — | — | Captura Taxa de Serviço. |
Parameters.AllowCancellationWithValueGreaterThanTheValueOfTheSale |
Booleano | — | — | Permite valor do Cancelamento maior que o valor da venda original. |
Parameters.CaptureBoardingFee |
Booleano | — | — | Captura Taxa de Embarque. |
Issuers.IssuerId |
integer int32 | — | — | Identificador do emissor. |
Issuers.IssuerName |
String | — | — | Nome do emissor. |
Issuers.AllowFallbackWhenChipReadingFails |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Issuers.AllowChargingMoedeiroFromCash |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Issuers.AllowPurchaseWithCompreESaque |
Booleano | — | — | Permite venda com Compre & Saque. |
Issuers.AllowOfflineFunctionExceptForEMVCard |
Booleano | — | — | Permite função offline, exceto cartão EMV. |
Issuers.AllowTypingCardNumber |
Booleano | — | — | Permite digitação do número do cartão. |
Issuers.MaskCardNumberUsingLast4Digits |
Booleano | — | — | Imprimir apenas os 4 últimos dígitos do cartão. |
Issuers.MaskCardNumberUsingFirst6AndLast4Digits |
Booleano | — | — | Imprimir os 6 primeiros e os 4 últimos dígitos do cartão. |
Issuers.AllowPrintCardHolderBalance |
Booleano | — | — | Permite imprimir o saldo do portador. |
Issuers.AllowDisplayCardHolderBalance |
Booleano | — | — | Permite exibir no display o saldo do portador. |
Issuers.Option03BiAllowPrintingPartialCardNumberInReceipt07 |
Booleano | — | — | Permite impressão parcial do número do cartão no comprovante das transações. |
Issuers.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado para pré-datamento. |
Issuers.RestrictSaleWithDuplicateValue |
Booleano | — | — | Impede venda com valor duplicado. |
Issuers.RequiresPassword |
Booleano | — | — | Solicita senha. |
Issuers.InterpretsLastDigitOfSecurityCode |
Booleano | — | — | Interpreta último dígito do Código de Serviço. |
Issuers.RequiresPasswordExceptForEMVCard |
Booleano | — | — | Solicita senha, exceto cartão EMV. |
Issuers.EnableAdditionalSecurityCodeOptions_Unreadable_NoCode |
Booleano | — | — | Habilita opções “Ilegível” e “Não Possui” para Código de Segurança. |
Issuers.RequiresSecurityCodeWhenMagneticTrackIsRead |
Booleano | — | — | Solicita Código de Segurança na leitura de trilha. |
Issuers.RequiresSecurityCodeWhenCardNumberIsTyped |
Booleano | — | — | Solicita Código de Segurança para cartão digitado. |
Issuers.RequiresTypingLast4Digits |
Booleano | — | — | Solicita digitação dos últimos 4 dígitos. |
Issuers.AllowCaptureOfFirstInstallmentValue |
Booleano | — | — | Permite captura do valor da primeira parcela. |
Issuers.AllowCaptureOfDownpaymentValue |
Booleano | — | — | Permite captura do valor de entrada. |
Issuers.AllowGuaranteeHandling |
Booleano | — | — | Permite tratamento de garantia. |
Issuers.AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery |
Booleano | — | — | Permite pré-datar a primeira parcela para venda e consulta CDC. |
Issuers.AllowPostdating |
Booleano | — | — | Permite pré-datamento. |
Issuers.AllowCDCSale |
Booleano | — | — | Permite venda CDC. |
Issuers.AllowFinancingByStore |
Booleano | — | — | Permite financiamento pela Loja. |
Issuers.AllowFinancingByCreditCardCompany |
Booleano | — | — | Permite financiamento pela Administradora. |
Issuers.RequiresChipReader |
Booleano | — | — | Exige a existência de Leitor de Chip. |
Issuers.RequiresPinpad |
Booleano | — | — | Exige a existência de PIN-pad. |
Issuers.LimitDayforReversal |
integer int32 | — | — | Data limite em dias para permitir Cancelamento. |
Issuers.LimitValueforReversal |
String | — | — | Valor máximo para Cancelamento. |
Issuers.LimitPercentforReversal |
integer int64 | — | — | Percentual máximo para Cancelamento. |
Issuers.IssuerNameForDisplay |
String | — | — | Nome do Issuer para o Display. |
Issuers.IssuerNameForPrint |
String | — | — | Nome do Issuer para Impressão. |
AidParameters |
String | — | Sim | Tabela de parametros para configuração da biblioteca compartilhada. |
PublicKeys |
String | — | Sim | Tabela de chaves para configuração da biblioteca compartilhada. |
InitializationVersion |
Integer int64 | — | Sim | Versão da inicialização utilizada para controle de atualização dos parametros pelo terminal. |
Inicialização (loja padrão)
Solicita as tabelas e parametros para operação do terminal. Como não foi informado o SubordinatedMerchantId
, será assumida a loja principal do facilitador, isto é, a loja que tem o ID igual ao ClientId
usado para a autenticação. Esta loja é criada automaticamente durante o processo de cadastro do facilitador executado pela Cielo.
Requisição
Path Parameters:
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
TerminalId |
String | — | Sim | Identificador do terminal |
Resposta
{
"MerchantId": "string",
"TerminalId": "string",
"Acquirer": {
"EnableContaclessCardReader": true,
"LockAppFunctionsExceptInitialization": true,
"HasChipReader": true,
"HasMagneticTrackReader": true,
"HasKeyboard": true
},
"Merchant": {
"MerchantId": "string",
"NetworkName": "string",
"MerchantName": "string",
"MerchantAddress": "string",
"NationalId": "string"
},
"Bins": [
{
"InitialBin": "string",
"FinalBin": "string",
"ProductId": 0,
"Type": 0,
"AllowFallbackWhenChipReadingFails": true,
"AllowChargingMoedeiroFromCash": true,
"AllowPurchaseWithCompreESaque": true,
"AllowOfflineFunctionExceptForEMVCard": true,
"AllowTypingCardNumber": true,
"MaskCardNumberUsingLast4Digits": true,
"MaskCardNumberUsingFirst6AndLast4Digits": true,
"AllowPrintCardHolderBalance": true,
"AllowDisplayCardHolderBalance": true,
"AllowPrintingPartialCardNumberInReceipt": true,
"RestrictSaleWithDuplicateValueWhenPostdated": true,
"RestrictSaleWithDuplicateValue": true,
"RequiresPassword": true,
"InterpretsLastDigitOfSecurityCode": true,
"RequiresPasswordExceptForEMVCard": true,
"EnableAdditionalSecurityCodeOptions_Unreadable_NoCode": true,
"RequiresSecurityCodeWhenMagneticTrackIsRead": true,
"RequiresSecurityCodeWhenCardNumberIsTyped": true,
"RequiresTypingLast4Digits": true,
"AllowCaptureOfFirstInstallmentValue": true,
"AllowCaptureOfDownpaymentValue": true,
"AllowGuaranteeHandling": true,
"AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery": true,
"AllowPostdating": true,
"AllowCDCSale": true,
"AllowFinancingByStore": true,
"AllowFinancingByCreditCardCompany": true,
"ValidateCardTrack1": true,
"DoNotValidateCardModule10": true,
"CheckExpiryDateWhenCardNumberIsTyped": true,
"CheckExpiryDateWhenMagneticTrackIsRead": true,
"IssuerId": 0
}
],
"Products": [
{
"ProductId": 0,
"ProductName": "string",
"ProductType": 0,
"BrandId": "string",
"AllowTransactionWithContactlessCard": true,
"IsFinancialProduct": true,
"AllowOfflineAuthorizationForEMVCard": true,
"AllowReprintReceipt": true,
"AllowPrintReceipt": true,
"AllowOfflineAuthorizationForContactlessCard": true,
"AllowCancel": true,
"AllowUndo": true,
"AllowCaptureOfFirstInstallmentValue": true,
"AllowCaptureOfDownpaymentValue": true,
"AllowGuaranteeHandling": true,
"AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery": true,
"AllowPostdating": true,
"AllowCDCSale": true,
"AllowFinancingByStore": true,
"AllowFinancingByCreditCardCompany": true,
"MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany": 0,
"MaximumNumberOfInstallmentsWhenFinancingByStore": 0,
"MaximumNumberOfinstallmentsForSaleAndCDCQuery": 0,
"MinimumNumberOfInstallmentsWhenFinancingByStore": 0,
"PostdatedSaleGuaranteeType": "DoNotAllowSalesWithGuarantee",
"PostdatedDayCountLimit": 0,
"FirstInstallmentDayCountLimit": 0
}
],
"Emv": [
{
"Aid": "string",
"TagsFirst": "string",
"TagsSecond": "string",
"IdxRecord": 0,
"Type": 0,
"RCodeFirst": "string",
"RCodeSecond": "string",
"InvalidateFunctionIfCardIsOnBlacklist": true,
"RequireBINToBeInCardRangeTable": true,
"StoreTransactionsRejectedByTerminalAppAndSendToHost": true,
"AllowOnlineAuthorizationTransactionRequest": true,
"AllowExtendedCardHolderName": true,
"NatEmvConctactRiskFloorLimit": 0,
"NatEmvConctactRiskMinValue": 0,
"NatEmvConctactRiskMinPercent": 0,
"NatEmvConctactRiskMaxPercent": 0,
"IntEmvConctactRiskFloorLimit": 0,
"IntEmvConctactRiskMinValue": 0,
"IntEmvConctactRiskMinPercent": 0,
"IntEmvConctactRiskMaxPercent": 0,
"ProductIds": [
0
]
}
],
"Parameters": [
{
"Currency": "string",
"AllowFallbackWhenChipReadingFails": true,
"AllowChargingMoedeiroFromCash": true,
"AllowPurchaseWithCompreESaque": true,
"AllowOfflineFunctionExceptForEMVCard": true,
"AllowTypingCardNumber": true,
"MaskCardNumberUsingLast4Digits": true,
"MaskCardNumberUsingFirst6AndLast4Digits": true,
"AllowPrintCardHolderBalance": true,
"AllowDisplayCardHolderBalance": true,
"AllowPrintingPartialCardNumberInReceipt": true,
"RestrictSaleWithDuplicateValueWhenPostdated": true,
"RestrictSaleWithDuplicateValue": true,
"RequiresPassword": true,
"InterpretsLastDigitOfSecurityCode": true,
"RequiresPasswordExceptForEMVCard": true,
"EnableAdditionalSecurityCodeOptions_Unreadable_NoCode": true,
"RequiresSecurityCodeWhenMagneticTrackIsRead": true,
"RequiresSecurityCodeWhenCardNumberIsTyped": true,
"RequiresTypingLast4Digits": true,
"CapturesServiceFee": true,
"AllowCancellationWithValueGreaterThanTheValueOfTheSale": true,
"CaptureBoardingFee": true
}
],
"Issuers": [
{
"IssuerId": 0,
"IssuerName": "string",
"AllowFallbackWhenChipReadingFails": true,
"AllowChargingMoedeiroFromCash": true,
"AllowPurchaseWithCompreESaque": true,
"AllowOfflineFunctionExceptForEMVCard": true,
"AllowTypingCardNumber": true,
"MaskCardNumberUsingLast4Digits": true,
"MaskCardNumberUsingFirst6AndLast4Digits": true,
"AllowPrintCardHolderBalance": true,
"AllowDisplayCardHolderBalance": true,
"Option03BiAllowPrintingPartialCardNumberInReceipt07": true,
"RestrictSaleWithDuplicateValueWhenPostdated": true,
"RestrictSaleWithDuplicateValue": true,
"RequiresPassword": true,
"InterpretsLastDigitOfSecurityCode": true,
"RequiresPasswordExceptForEMVCard": true,
"EnableAdditionalSecurityCodeOptions_Unreadable_NoCode": true,
"RequiresSecurityCodeWhenMagneticTrackIsRead": true,
"RequiresSecurityCodeWhenCardNumberIsTyped": true,
"RequiresTypingLast4Digits": true,
"AllowCaptureOfFirstInstallmentValue": true,
"AllowCaptureOfDownpaymentValue": true,
"AllowGuaranteeHandling": true,
"AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery": true,
"AllowPostdating": true,
"AllowCDCSale": true,
"AllowFinancingByStore": true,
"AllowFinancingByCreditCardCompany": true,
"RequiresChipReader": true,
"RequiresPinpad": true,
"LimitDayforReversal": 0,
"LimitValueforReversal": "string",
"LimitPercentforReversal": 0,
"IssuerNameForDisplay": "string",
"IssuerNameForPrint": "string"
}
],
"AidParameters": "string",
"PublicKeys": "string",
"InitializationVersion": 1558708320029
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantId |
String | — | — | Identificador da loja |
TerminalId |
String | — | — | Identificador do terminal |
Acquirer.EnableContaclessCardReader |
Booleano | — | — | Habilita Leitora Cartão Sem Contato |
Acquirer.LockAppFunctionsExceptInitialization |
Booleano | — | — | Bloquear as funções do aplicativo, com exceção da Inicialização |
Acquirer.HasChipReader |
Booleano | — | — | Indica que tem leitora de Chip-Card |
Acquirer.HasMagneticTrackReader |
Booleano | — | — | Indica que tem leitor da trilha magnética |
Acquirer.HasKeyboard |
Booleano | — | — | Indica que tem teclado para digitação |
Acquirer.IntervalInDaysForSendingTechnicalParameter |
Integer | — | Não | intervalo em dias de envio da Baixa Técnica, sendo: 0 - nunca enviar 1 a 99 - intervalo em dias, exemplo: 30 = enviar a cada 30 dias. |
Merchant.MerchantId |
String | — | — | Código do Lojista na PayStore, definido no momento da criação do lojista. |
Merchant.NetworkName |
String | — | — | Nome da rede da sub-adquirente cadastrado pelo Gestor da PayStore. |
Merchant.MerchantName |
String | — | — | Nome fantasia do lojista, definido no momento da criação do mesmo no portal da PayStore. |
Merchant.MerchantAddress |
String | — | — | Endereço do lojista obtido a partir da digitação do CEP momento da criação do mesmo no portal da PayStore. |
Merchant.NationalId |
String | — | — | CPF ou CNPJ, definido no momento da criação do Lojista no portal da PayStore. |
Bins.InitialBin |
String | — | — | Início do range de BIN’s. |
Bins.FinalBin |
String | — | — | Final do range de BIN’s. |
Bins.ProductId |
Integer int32 | — | — | Chave estrangeira de “PRODUCT TABLE”. |
Bins.Type |
Integer int32 | — | — | Admite os seguintes valores 0 - ESPECÍFICO 1 – GENERICO. |
Bins.AllowFallbackWhenChipReadingFails |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Bins.AllowChargingMoedeiroFromCash |
Booleano | — | — | Permite carga de moedeiro a partir de dinheiro em espécie. |
Bins.AllowPurchaseWithCompreESaque |
Booleano | — | — | Permite venda com Compre & Saque. |
Bins.AllowOfflineFunctionExceptForEMVCard |
Booleano | — | — | Permite função offline, exceto cartão EMV. |
Bins.AllowTypingCardNumber |
Booleano | — | — | Permite digitação do número do cartão. |
Bins.MaskCardNumberUsingLast4Digits |
Booleano | — | — | Imprimir apenas os 4 últimos dígitos do cartão. |
Bins.MaskCardNumberUsingFirst6AndLast4Digits |
Booleano | — | — | Imprimir os 6 primeiros e os 4 últimos dígitos do cartão. |
Bins.AllowPrintCardHolderBalance |
Booleano | — | — | Permite imprimir o saldo do portador. |
Bins.AllowDisplayCardHolderBalance |
Booleano | — | — | Permite exibir no display o saldo do portador. |
Bins.AllowPrintingPartialCardNumberInReceipt |
Booleano | — | — | Permite impressão parcial do número do cartão no comprovante das transações. |
Bins.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado para prédatamento. |
Bins.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado. |
Bins.RequiresPassword |
Booleano | — | — | Solicita senha. |
Bins.InterpretsLastDigitOfSecurityCode |
Booleano | — | — | Interpreta último dígito do Código de Serviço. |
Bins.RequiresPasswordExceptForEMVCard |
Booleano | — | — | Solicita senha, exceto cartão EMV. |
Bins.EnableAdditionalSecurityCodeOptions_Unreadable_NoCode |
Booleano | — | — | Habilita opções “Ilegível” e “Não Possui” para Código de Segurança. |
Bins.RequiresSecurityCodeWhenMagneticTrackIsRead |
Booleano | — | — | Solicita Código de Segurança na leitura de trilha. |
Bins.RequiresSecurityCodeWhenCardNumberIsTyped |
Booleano | — | — | Solicita Código de Segurança para cartão digitado. |
Bins.RequiresTypingLast4Digits |
Booleano | — | — | Solicita digitação dos últimos 4 dígitos. |
Bins.AllowCaptureOfFirstInstallmentValue |
Booleano | — | — | Permite captura do valor da primeira parcela. |
Bins.AllowCaptureOfDownpaymentValue |
Booleano | — | — | Permite captura do valor de entrada. |
Bins.AllowGuaranteeHandling |
Booleano | — | — | Permite tratamento de garantia. |
Bins.AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery |
Booleano | — | — | Permite pré-datar a primeira parcela para venda e consulta CDC. |
Bins.AllowPostdating |
Booleano | — | — | Permite pré-datamento. |
Bins.AllowCDCSale |
Booleano | — | — | Permite venda CDC. |
Bins.AllowFinancingByStore |
Booleano | — | — | Permite financiamento pela Loja. |
Bins.AllowFinancingByCreditCardCompany |
Booleano | — | — | Permite financiamento pela Administradora. |
Bins.ValidateCardTrack1 |
Booleano | — | — | Verifica Trilha 1 do cartão. |
Bins.DoNotValidateCardModule10 |
Booleano | — | — | Não validar o Módulo 10 do cartão. |
Bins.CheckExpiryDateWhenCardNumberIsTyped |
Booleano | — | — | Verifica data de validade do cartão digitado. |
Bins.CheckExpiryDateWhenMagneticTrackIsRead |
Booleano | — | — | Verifica data de validade da trilha. |
Bins.IssuerId |
Integer int32 | — | — | Chave estrangeira de “ISSUER TABLE”. |
Products.ProductId |
Integer int32 | — | — | Identificador do produto. |
Products.ProductName |
String | — | — | Nome do produto. |
Products.ProductType |
Integer int32 | — | — | Admite os seguintes valores 0 - CREDITO 1 – DEBITO |
Products.BrandId |
String | — | — | Identificador da bandeira do cartão. |
Products.AllowTransactionWithContactlessCard |
Booleano | — | — | Permite Transação com Cartão Sem Contato. |
Products.IsFinancialProduct |
Booleano | — | — | Produto Financeiro. |
Products.AllowOfflineAuthorizationForEMVCard |
Booleano | — | — | Permite Autorização Offline EMV. |
Products.AllowReprintReceipt |
Booleano | — | — | Permite Reimpressão do comprovante. |
Products.AllowPrintReceipt |
Booleano | — | — | Permite Impressão do comprovante. |
Products.AllowOfflineAuthorizationForContactlessCard |
Booleano | — | — | Permite Autorização Offline para Cartão Sem Contato. |
Products.AllowCancel |
Booleano | — | — | Permite Cancelamento. |
Products.AllowUndo |
Booleano | — | — | Permite Desfazimento. |
Products.AllowCaptureOfFirstInstallmentValue |
Booleano | — | — | Permite captura do valor da primeira parcela. |
Products.AllowCaptureOfDownpaymentValue |
Booleano | — | — | Permite captura do valor de entrada. |
Products.AllowGuaranteeHandling |
Booleano | — | — | Permite tratamento de garantia. |
Products.AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery |
Booleano | — | — | Permite pré-datar a primeira parcela para venda e consulta CDC. |
Products.AllowPostdating |
Booleano | — | — | Permite pré-datamento. |
Products.AllowCDCSale |
Booleano | — | — | Permite venda CDC. |
Products.AllowFinancingByStore |
Booleano | — | — | Permite financiamento pela Loja. |
Products.AllowFinancingByCreditCardCompany |
Booleano | — | — | Permite financiamento pela Administradora. |
Products.MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany |
Integer int32 | — | — | Número máximo de parcelas para financiamento ADM. |
Products.MaximumNumberOfInstallmentsWhenFinancingByStore |
Integer int32 | — | — | Número máximo de parcelas para financiamento Loja. |
Products.MaximumNumberOfinstallmentsForSaleAndCDCQuery |
Integer int32 | — | — | Número máximo de parcelas para venda e consulta CDC. |
Products.MinimumNumberOfInstallmentsWhenFinancingByStore |
Integer int64 | — | — | Valor mínimo de parcelas para financiamento Loja. |
Products.PostdatedSaleGuaranteeType |
String | — | — | Tipo de Garantia para o Pré-datado. Admite os seguintes valores 00 – Não permite tratamento de Garantia (Venda Garantida); 05 – Permite transações Pré-datadas Garantidas; 07 – Permite transações Pré-datadas Garantidas e Sem Garantia. |
Products.PostdatedDayCountLimit |
Integer int32 | — | — | Limite máximo em dias para pré-datar a partir da data atual. 00 – Não aceita. XX - Pré-datado. |
Products.FirstInstallmentDayCountLimit |
Integer int32 | — | — | Limite da data de primeira parcela. 00 – Não aceita. XX - Limite de dias. |
Emv.Aid |
String | — | — | Identificador da aplicação EMV. |
Emv.TagsFirst |
String | — | — | Conjunto de tags obrigatórias enviadas o 1º Generate AC. |
Emv.TagsSecond |
String | — | — | Conjunto de tags obrigatórias enviadas o 2º Generate AC. |
Emv.IdxRecord |
Integer int32 | — | — | — |
Emv.Type |
Integer int32 | — | — | Admite os seguintes valores 0 - CREDITO 1 – DEBITO |
Emv.RCodeFirst |
String | — | — | — |
Emv.RCodeSecond |
String | — | — | — |
Emv.InvalidateFunctionIfCardIsOnBlacklist |
Booleano | — | — | Invalida a função se o cartão consta na Lista Negra. |
Emv.RequireBINToBeInCardRangeTable |
Booleano | — | — | Obriga que o BIN esteja na tabela de Range de Cartões (tipo 2B). |
Emv.StoreTransactionsRejectedByTerminalAppAndSendToHost |
Booleano | — | — | Armazena e envia para o Host as transações rejeitadas pelo aplicativo do terminal. |
Emv.AllowOnlineAuthorizationTransactionRequest |
Booleano | — | — | — |
Emv.AllowExtendedCardHolderName |
Booleano | — | — | — |
Emv.NatEmvConctactRiskFloorLimit |
Integer int32 | — | — | Valor máximo de verificação para autorização offline das transações. As transações realizadas com a leitura do Chip EMV e com valor acima do “Floor limit”, deverão ser autorizadas no modo online. |
Emv.NatEmvConctactRiskMinValue |
Integer int32 | — | — | Valor mínimo para o cálculo de seleção aleatória para autorização offline. Conforme processo definido na Especificação EMV. |
Emv.NatEmvConctactRiskMinPercent |
Integer int32 | — | — | Porcentagem mínima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.NatEmvConctactRiskMaxPercent |
Integer int32 | — | — | Porcentagem máxima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.IntEmvConctactRiskFloorLimit |
Integer int32 | — | — | Valor máximo de verificação para autorização offline das transações. As transações realizadas com a leitura do Chip EMV e com valor acima do “Floor limit”, deverão ser autorizadas no modo online. |
Emv.IntEmvConctactRiskMinValue |
Integer int32 | — | — | Valor mínimo para o cálculo de seleção aleatória para autorização offline. Conforme processo definido na Especificação EMV. |
Emv.IntEmvConctactRiskMinPercent |
Integer int32 | — | — | Porcentagem mínima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.IntEmvConctactRiskMaxPercent |
Integer int32 | — | — | Porcentagem máxima para seleção aleatória. Utilizar apenas o conteúdo do último byte. |
Emv.ProductIds |
Array of integers int32 | — | — | Produtos habilitados para esta aplicação EMV. |
Parameters.Currency |
String | — | — | — |
Parameters.AllowFallbackWhenChipReadingFails |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Parameters.AllowChargingMoedeiroFromCash |
Booleano | — | — | Permite carga de moedeiro a partir de dinheiro em espécie. |
Parameters.AllowPurchaseWithCompreESaque |
Booleano | — | — | Permite venda com Compre & Saque. |
Parameters.AllowOfflineFunctionExceptForEMVCard |
Booleano | — | — | Permite função offline, exceto cartão EMV. |
Parameters.AllowTypingCardNumber |
Booleano | — | — | Permite entrada manual do número do cartão. |
Parameters.MaskCardNumberUsingLast4Digits |
Booleano | — | — | Imprimir apenas os 4 últimos dígitos do cartão. |
Parameters.MaskCardNumberUsingFirst6AndLast4Digits |
Booleano | — | — | Imprimir os 6 primeiros e os 4 últimos dígitos do cartão. |
Parameters.AllowPrintCardHolderBalance |
Booleano | — | — | Permite imprimir o saldo do portador. |
Parameters.AllowDisplayCardHolderBalance |
Booleano | — | — | Permite exibir no display o saldo do portador. |
Parameters.AllowPrintingPartialCardNumberInReceipt |
Booleano | — | — | Permite impressão parcial do número do cartão no comprovante das transações. |
Parameters.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado para pré-datamento. |
Parameters.RestrictSaleWithDuplicateValue |
Booleano | — | — | Impede venda com valor duplicado. |
Parameters.RequiresPassword |
Booleano | — | — | Solicita senha. |
Parameters.InterpretsLastDigitOfSecurityCode |
Booleano | — | — | Interpreta último dígito do Código de Serviço. |
Parameters.RequiresPasswordExceptForEMVCard |
Booleano | — | — | Solicita senha, exceto cartão EMV. |
Parameters.EnableAdditionalSecurityCodeOptions_Unreadable_NoCode |
Booleano | — | — | Habilita opções “Ilegível” e “Não Possui” para Código de Segurança. |
Parameters.RequiresSecurityCodeWhenMagneticTrackIsRead |
Booleano | — | — | Solicita Código de Segurança na leitura de trilha. |
Parameters.RequiresSecurityCodeWhenCardNumberIsTyped |
Booleano | — | — | Solicita Código de Segurança para cartão digitado. |
Parameters.RequiresTypingLast4Digits |
Booleano | — | — | Solicita digitação dos últimos 4 dígitos. |
Parameters.CapturesServiceFee |
Booleano | — | — | Captura Taxa de Serviço. |
Parameters.AllowCancellationWithValueGreaterThanTheValueOfTheSale |
Booleano | — | — | Permite valor do Cancelamento maior que o valor da venda original. |
Parameters.CaptureBoardingFee |
Booleano | — | — | Captura Taxa de Embarque. |
Issuers.IssuerId |
integer int32 | — | — | Identificador do emissor. |
Issuers.IssuerName |
String | — | — | Nome do emissor. |
Issuers.AllowFallbackWhenChipReadingFails |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Issuers.AllowChargingMoedeiroFromCash |
Booleano | — | — | Permite fallback se houver erro na leitura do Chip. |
Issuers.AllowPurchaseWithCompreESaque |
Booleano | — | — | Permite venda com Compre & Saque. |
Issuers.AllowOfflineFunctionExceptForEMVCard |
Booleano | — | — | Permite função offline, exceto cartão EMV. |
Issuers.AllowTypingCardNumber |
Booleano | — | — | Permite digitação do número do cartão. |
Issuers.MaskCardNumberUsingLast4Digits |
Booleano | — | — | Imprimir apenas os 4 últimos dígitos do cartão. |
Issuers.MaskCardNumberUsingFirst6AndLast4Digits |
Booleano | — | — | Imprimir os 6 primeiros e os 4 últimos dígitos do cartão. |
Issuers.AllowPrintCardHolderBalance |
Booleano | — | — | Permite imprimir o saldo do portador. |
Issuers.AllowDisplayCardHolderBalance |
Booleano | — | — | Permite exibir no display o saldo do portador. |
Issuers.Option03BiAllowPrintingPartialCardNumberInReceipt07 |
Booleano | — | — | Permite impressão parcial do número do cartão no comprovante das transações. |
Issuers.RestrictSaleWithDuplicateValueWhenPostdated |
Booleano | — | — | Impede venda com valor duplicado para pré-datamento. |
Issuers.RestrictSaleWithDuplicateValue |
Booleano | — | — | Impede venda com valor duplicado. |
Issuers.RequiresPassword |
Booleano | — | — | Solicita senha. |
Issuers.InterpretsLastDigitOfSecurityCode |
Booleano | — | — | Interpreta último dígito do Código de Serviço. |
Issuers.RequiresPasswordExceptForEMVCard |
Booleano | — | — | Solicita senha, exceto cartão EMV. |
Issuers.EnableAdditionalSecurityCodeOptions_Unreadable_NoCode |
Booleano | — | — | Habilita opções “Ilegível” e “Não Possui” para Código de Segurança. |
Issuers.RequiresSecurityCodeWhenMagneticTrackIsRead |
Booleano | — | — | Solicita Código de Segurança na leitura de trilha. |
Issuers.RequiresSecurityCodeWhenCardNumberIsTyped |
Booleano | — | — | Solicita Código de Segurança para cartão digitado. |
Issuers.RequiresTypingLast4Digits |
Booleano | — | — | Solicita digitação dos últimos 4 dígitos. |
Issuers.AllowCaptureOfFirstInstallmentValue |
Booleano | — | — | Permite captura do valor da primeira parcela. |
Issuers.AllowCaptureOfDownpaymentValue |
Booleano | — | — | Permite captura do valor de entrada. |
Issuers.AllowGuaranteeHandling |
Booleano | — | — | Permite tratamento de garantia. |
Issuers.AllowPostdatingTheFirstInstallmentForSaleAndCDCQuery |
Booleano | — | — | Permite pré-datar a primeira parcela para venda e consulta CDC. |
Issuers.AllowPostdating |
Booleano | — | — | Permite pré-datamento. |
Issuers.AllowCDCSale |
Booleano | — | — | Permite venda CDC. |
Issuers.AllowFinancingByStore |
Booleano | — | — | Permite financiamento pela Loja. |
Issuers.AllowFinancingByCreditCardCompany |
Booleano | — | — | Permite financiamento pela Administradora. |
Issuers.RequiresChipReader |
Booleano | — | — | Exige a existência de Leitor de Chip. |
Issuers.RequiresPinpad |
Booleano | — | — | Exige a existência de PIN-pad. |
Issuers.LimitDayforReversal |
integer int32 | — | — | Data limite em dias para permitir Cancelamento. |
Issuers.LimitValueforReversal |
String | — | — | Valor máximo para Cancelamento. |
Issuers.LimitPercentforReversal |
integer int64 | — | — | Percentual máximo para Cancelamento. |
Issuers.IssuerNameForDisplay |
String | — | — | Nome do Issuer para o Display. |
Issuers.IssuerNameForPrint |
String | — | — | Nome do Issuer para Impressão. |
AidParameters |
— | — | — | — |
PublicKeys |
— | — | — | — |
InitializationVersion |
— | — | — | — |
Pagamentos
Fluxo de pagamento
Exemplo fluxo (Biblioteca Compartilhada):
ID | Descrição do Fluxo |
---|---|
1 | Inserção do valor da transação (campo Amount do request da transação) |
2 | Recuperar Data/Hora da transação (campo PaymentDateTime do request da transação) |
3 | Seleção do tipo de pagamento (débito, crédito, voucher…) (campo Type do request da transação) |
4 | Chamada do PP_StartGetCard passando os valores: |
4.1 | Identificador da rede adquirente (Cielo 03 ) |
4.2 | Tipo de aplicação (relacionado ao item 3) |
4.3 | Valor inicial da transação (item 1) |
4.4 | Data da transação (item 2) |
4.5 | Hora da transação (item 2) |
5 | Caso tenha sido utilizado um cartão com chip, recuperar o aid através da tag 4F no retorno da PP_getCard. |
6 | Seleção de produtos (campo “ProductId” do request da transação): |
Transações com chip:
ID | Descrição do Fluxo |
---|---|
1 | Realizar a busca na tabela “Emv” pelo AID do cartão (campo Aid ) e selecionar os produtos associados através do campo ProductIds |
2 | Nos produtos associados, recuperar aqueles que possuem o mesmo ProductType (tabela Products ) que iniciado na transação (DÉBITO, CRÉDITO..) e o mesmo fluxo do host (campo HostFlow ) que os definido pela Cielo. |
Transações com tarja/digitada:
ID | Descrição do Fluxo |
---|---|
1 | Ao recuperar o pan do cartão, buscar na tabela Bins um que o bin esteja entre os valores InitialBin e FinalBin (considerar sempre a faixa de Bins mais específica) e recuperar o produto associado no campo ProductId ; |
2 | Recuperar os produtos que tem o mesmo ProductType (tabela Products ) que iniciado na transação (DÉBITO, CRÉDITO…) e o mesmo fluxo do host (campo HostFlow ) que os definido pela Cielo. |
Simular respostas:
Para simular alguma resposta especifica utilize o campo Amount
, onde de acordo com o valor dos centavos informado nesse campo é possivel receber uma resposta conforme descrito na tabela abaixo:
Amount (valor dos centavos) | Retorno simulado do Pagamento | Exemplo de valor simulado |
---|---|---|
10 | Aprovado | 5010 = R$50,10 |
11 | Negado | 20011 = R$200,11 |
12 | Timeout | 3512 = R$35,12 |
19 | Erro | 1019 = R$10,19 |
Autorização
Quando um pagamento é criado (201 - Created), deve-se analisar o Status (Payment.Status) na resposta para certificar-se que o pagamento foi gerado com sucesso ou se houve alguma falha.
SandBox | Produção |
---|---|
https://apisandbox.cieloecommerce.cielo.com.br | https://api.cieloecommerce.cielo.com.br/ |
Crédito Digitado
Requisição
{
"MerchantOrderId": "1596226820548",
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Capture": true,
"Interest": "ByMerchant",
"ProductId": 1,
"CreditCard": {
"CardNumber": "1234567812345678",
"ExpirationDate": "12/2020",
"SecurityCodeStatus": "Collected",
"SecurityCode": 1230,
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Typed",
"AuthenticationMethod": "NoPassword",
"TruncateCardNumberWhenPrinting": true,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default:false/Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.CreditCard.CardNumber |
String | 19 | Sim | Número do cartão (PAN) |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.SecurityCodeStatus |
String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.CreditCard.SecurityCode |
String | 4 | Sim | Código de segurança (CVV) |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry da baixa de parametros. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | Não | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no campo AllowPrintingPartialCardNumberInReceipt presente nos objetos BinEntry, ParameterEntry e IssuerEntry. |
Payment.CreditCard.SaveCard |
Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão. |
Payment.CreditCard.IsFallback |
Booleano | — | Não | Identifica se é uma transação de fallback. |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String` | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "20180204",
"Customer": {
"Name": "Comprador crédito completo",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "compradorteste@teste.com",
"Birthday": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
}
},
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PaymentDateTime": "2019-04-15T12:00:00Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"Provider": "Cielo",
"ConfirmationStatus": 0,
"InitializationVersion": 1558708320029,
"EmvResponseData": "123456789ABCD1345DEA",
"Status": 2,
"IsSplitted": false,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
},
"RecurrentPayment": {
"RecurrentPaymentId": "a6b719fa-a8df-ab11-4e1a-f4e50d5bd702",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"NextRecurrency": "2019-12-01",
"EndDate": "2019-12-01",
"Interval": 6
},
"SplitPayments": [
{
"SubordinateMerchantId": "491daf20-35f2-4379-874c-e7552ae8dc10",
"Amount": 100,
"Fares": {
"Mdr": 5,
"Fee": 0
}
},
{
"SubordinateMerchantId": "7e2846be-4e80-4f86-8ca9-eb35db6aea00",
"Amount": 80,
"Fares": {
"Mdr": 3,
"Fee": 1
}
}
],
"SplitErrors": [
{
"Code": 326,
"Message": "SubordinatePayment amount must be greater than zero"
}
]
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição | ||
---|---|---|---|---|---|---|
MerchantOrderId |
String | — | — | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. Aceita apenas valores numéricos de 1 a 15 dígitos. | ||
Customer.Name |
String | — | — | — | — | |
Customer.Identity |
— | — | — | — | ||
Customer.IdentityType |
— | — | — | — | ||
Customer.Email |
— | — | — | — | ||
Customer.Birthday |
— | — | — | — | ||
Address.Street |
String | — | — | — | ||
Address.Number |
String | — | — | — | ||
Address.Complement |
String | — | — | — | ||
Address.ZipCode |
String | — | — | — | ||
Address.City |
String | — | — | — | ||
Address.State |
String | — | — | — | ||
Address.Country |
String | — | — | — | ||
DeliveryAddress.Street |
String | — | — | — | ||
DeliveryAddress.Number |
String | — | — | — | ||
DeliveryAddress.Complement |
String | — | — | — | ||
DeliveryAddress.ZipCode |
String | — | — | — | ||
DeliveryAddress.City |
String | — | — | — | ||
DeliveryAddress.State |
String | — | — | — | ||
DeliveryAddress.Country |
String | — | — | — | ||
Payment.Installments |
Integer | — | — | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos maxOfPayments1, maxOfPayments2, maxOfPayments3 e minValOfPayments da tabela productTable. | ||
Payment.Interest |
String | — | — | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
||
Payment.Capture |
Booleano | — | — | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. | ||
CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
||
CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. | ||
CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. | ||
CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | — | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no confParamOp03 presente nas tabelas BIN TABLE, PARAMETER TABLE e ISSUER TABLE. |
||
CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
||
CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
||
CreditCard.EmvData |
String | — | — | Dados da transação EMV Obtidos através do comando PP_GoOnChip na BC |
||
PinBlock.EncryptedPinBlock |
— | — | — | — | ||
PinBlock.EncryptionType |
String | — | — | — | ||
PinBlock.KsnIdentification |
String | — | — | — | ||
CreditCard.PanSequenceNumber |
Number | — | — | Número sequencial do cartão, utilizado para identificar a conta corrente do cartão adicional. Mandatório para transações com cartões Chip EMV e que possuam PAN Sequence Number (Tag 5F34). | ||
CreditCard.SaveCard |
— | — | — | — | ||
CreditCard.IsFallback |
— | — | — | — | ||
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação | ||
Payment.ServiceTaxAmount |
— | — | — | — | ||
Payment.SoftDescriptor |
String | 13 | — | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. | ||
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. | ||
PinPadInformation.TerminalId |
String | — | Sim | Número Lógico definido no Concentrador Cielo. | ||
PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. | ||
PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad ; PIN-pad sem leitor de Chip = PinpadWithoutChipReader ; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule ; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule ; PIN-pad não homologado = NotCertifiedPinPad ; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless ; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless . Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
||
PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada | ||
Payment.Amount |
Integer(int64) | — | Sim | Valor da transação (1079 = R$10,79) | ||
Payment.ReceivedDate |
— | — | — | — | ||
Payment.CapturedAmount |
— | — | — | — | ||
Payment.Provider |
String | — | — | — | ||
Payment.ConfirmationStatus |
— | — | — | — | ||
Payment.InitializationVersion |
— | — | — | — | ||
Payment.EmvResponseData |
— | — | — | — | ||
Payment.Status |
— | — | — | — | ||
Payment.IsSplitted |
Booleano | — | — | — | ||
Payment.ReturnCode |
— | — | — | — | ||
Payment.ReturnMessage |
String | — | — | — | ||
Payment.PaymentId |
— | — | — | — | ||
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
||
Payment.Currency |
String | — | — | Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”). | ||
Payment.Country |
String | — | — | Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”). | ||
Receipt.MerchantName |
— | — | — | — | ||
Receipt.MerchantAddress |
— | — | — | — | ||
Receipt.MerchantCity |
— | — | — | — | ||
Receipt.MerchantState |
— | — | — | — | ||
Receipt.MerchantCode |
— | — | — | — | ||
Receipt.Terminal |
— | — | — | — | ||
Receipt.Nsu |
— | — | — | — | ||
Receipt.Date |
— | — | — | — | ||
Receipt.Hour |
— | — | — | — | ||
Receipt.IssuerName |
— | — | — | — | ||
Receipt.CardNumber |
— | — | — | — | ||
Receipt.TransactionType |
— | — | — | — | ||
Receipt.AuthorizationCode |
— | — | — | — | ||
Receipt.TransactionMode |
— | — | — | — | ||
Receipt.InputMethod |
— | — | — | — | ||
Receipt.Value |
— | — | — | — | ||
Receipt.SoftDescriptor |
— | — | — | — | ||
RecurrentPayment.RecurrentPaymentId |
— | — | — | — | ||
RecurrentPayment.ReasonCode |
— | — | — | — | ||
RecurrentPayment.ReasonMessage |
— | — | — | — | ||
RecurrentPayment.NextRecurrency |
— | — | — | — | ||
RecurrentPayment.EndDate |
— | — | — | — | ||
RecurrentPayment.Interval |
— | — | — | — | ||
SplitPayments.SubordinateMerchantId |
— | — | — | — | ||
SplitPayments.Amount |
— | — | — | — | ||
SplitPayments.Fares.Mdr |
— | — | — | — | ||
SplitPayments.Fares.Fee |
— | — | — | — | ||
SplitErrors.Code |
— | — | — | — | ||
SplitErrors.Message |
— | — | — | — |
Crédito Digitado com Recorrência
Requisição
{
"MerchantOrderId": "201904150001",
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Capture": true,
"Interest": "ByMerchant",
"ProductId": 1,
"CreditCard": {
"CardNumber": 1234567812345678,
"ExpirationDate": "12/2020",
"SecurityCodeStatus": "Collected",
"SecurityCode": 1230,
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Typed",
"AuthenticationMethod": "NoPassword",
"TruncateCardNumberWhenPrinting": true,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"RecurrentPayment": {
"EndDate": "2019-12-01",
"Interval": "SemiAnual"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default:false/Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.CreditCard.CardNumber |
String | 19 | Sim | Número do cartão (PAN) |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.SecurityCodeStatus |
String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.CreditCard.SecurityCode |
String | 4 | Sim | Código de segurança (CVV) |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry da baixa de parametros. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | Não | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no campo AllowPrintingPartialCardNumberInReceipt presente nos objetos BinEntry, ParameterEntry e IssuerEntry. |
Payment.CreditCard.SaveCard |
Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão. |
Payment.CreditCard.IsFallback |
Booleano | — | Não | Identifica se é uma transação de fallback. |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String` | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "20180204",
"Customer": {
"Name": "Comprador crédito completo",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "compradorteste@teste.com",
"Birthday": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
}
},
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PaymentDateTime": "2019-04-15T12:00:00Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"Provider": "Cielo",
"ConfirmationStatus": 0,
"InitializationVersion": 1558708320029,
"EmvResponseData": "123456789ABCD1345DEA",
"Status": 2,
"IsSplitted": false,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
},
"RecurrentPayment": {
"RecurrentPaymentId": "a6b719fa-a8df-ab11-4e1a-f4e50d5bd702",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"NextRecurrency": "2019-12-01",
"EndDate": "2019-12-01",
"Interval": 6
},
"SplitPayments": [
{
"SubordinateMerchantId": "491daf20-35f2-4379-874c-e7552ae8dc10",
"Amount": 100,
"Fares": {
"Mdr": 5,
"Fee": 0
}
},
{
"SubordinateMerchantId": "7e2846be-4e80-4f86-8ca9-eb35db6aea00",
"Amount": 80,
"Fares": {
"Mdr": 3,
"Fee": 1
}
}
],
"SplitErrors": [
{
"Code": 326,
"Message": "SubordinatePayment amount must be greater than zero"
}
]
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição | |
---|---|---|---|---|---|
MerchantOrderId |
String | — | — | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. Aceita apenas valores numéricos de 1 a 15 dígitos. | |
Customer.Name |
— | — | — | — | |
Customer.Identity |
— | — | — | — | |
Customer.IdentityType |
— | — | — | — | |
Customer.Email |
— | — | — | — | |
Customer.Birthday |
— | — | — | — | |
Address.Street |
String | — | — | — | |
Address.Number |
String | — | — | — | |
Address.Complement |
String | — | — | — | |
Address.ZipCode |
String | — | — | — | |
Address.City |
String | — | — | — | |
Address.State |
String | — | — | — | |
Address.Country |
String | — | — | — | |
DeliveryAddress.Street |
String | — | — | — | |
DeliveryAddress.Number |
String | — | — | — | |
DeliveryAddress.Complement |
String | — | — | — | |
DeliveryAddress.ZipCode |
String | — | — | — | |
DeliveryAddress.City |
String | — | — | — | |
DeliveryAddress.State |
String | — | — | — | |
DeliveryAddress.Country |
String | — | — | — | |
Payment.Installments |
Integer | — | — | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos maxOfPayments1, maxOfPayments2, maxOfPayments3 e minValOfPayments da tabela productTable. | |
Payment.Interest |
String | — | — | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
|
Payment.Capture |
Booleano | — | — | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. | |
CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
|
CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. | |
CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. | |
CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | — | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no confParamOp03 presente nas tabelas BIN TABLE, PARAMETER TABLE e ISSUER TABLE. |
|
CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
|
CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
|
CreditCard.EmvData |
String | — | — | Dados da transação EMV Obtidos através do comando PP_GoOnChip na BC |
|
PinBlock.EncryptedPinBlock |
— | — | — | — | |
PinBlock.EncryptionType |
— | — | — | — | |
PinBlock.KsnIdentification |
— | — | — | — | |
CreditCard.PanSequenceNumber |
Number | — | — | Número sequencial do cartão, utilizado para identificar a conta corrente do cartão adicional. Mandatório para transações com cartões Chip EMV e que possuam PAN Sequence Number (Tag 5F34). | |
CreditCard.SaveCard |
— | — | — | — | |
CreditCard.IsFallback |
— | — | — | — | |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação | |
Payment.ServiceTaxAmount |
— | — | — | — | |
Payment.SoftDescriptor |
String | 13 | — | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. | |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. | |
PinPadInformation.TerminalId |
String | — | Sim | Número Lógico definido no Concentrador Cielo. | |
PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. | |
PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad ; PIN-pad sem leitor de Chip = PinpadWithoutChipReader ; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule ; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule ; PIN-pad não homologado = NotCertifiedPinPad ; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless ; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless . Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
|
PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada | |
Payment.Amount |
Integer(int64) | — | Sim | Valor da transação (1079 = R$10,79) | |
Payment.ReceivedDate |
— | — | — | — | |
Payment.CapturedAmount |
— | — | — | — | |
Payment.Provider |
String | — | — | — | |
Payment.ConfirmationStatus |
— | — | — | — | |
Payment.InitializationVersion |
— | — | — | — | |
Payment.EmvResponseData |
— | — | — | — | |
Payment.Status |
— | — | — | — | |
Payment.IsSplitted |
Booleano | — | — | — | |
Payment.ReturnCode |
— | — | — | — | |
Payment.ReturnMessage |
String | — | — | — | |
Payment.PaymentId |
— | — | — | — | |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
|
Payment.Currency |
String | — | — | Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”) | |
Payment.Country |
String | — | — | Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”) | |
Receipt.MerchantName |
— | — | — | — | |
Receipt.MerchantAddress |
— | — | — | — | |
Receipt.MerchantCity |
— | — | — | — | |
Receipt.MerchantState |
— | — | — | — | |
Receipt.MerchantCode |
— | — | — | — | |
Receipt.Terminal |
— | — | — | — | |
Receipt.Nsu |
— | — | — | — | |
Receipt.Date |
— | — | — | — | |
Receipt.Hour |
— | — | — | — | |
Receipt.IssuerName |
— | — | — | — | |
Receipt.CardNumber |
— | — | — | — | |
Receipt.TransactionType |
— | — | — | — | |
Receipt.AuthorizationCode |
— | — | — | — | |
Receipt.TransactionMode |
— | — | — | — | |
Receipt.InputMethod |
— | — | — | — | |
Receipt.Value |
— | — | — | — | |
Receipt.SoftDescriptor |
— | — | — | — | |
RecurrentPayment.RecurrentPaymentId |
— | — | — | — | |
RecurrentPayment.ReasonCode |
— | — | — | — | |
RecurrentPayment.ReasonMessage |
— | — | — | — | |
RecurrentPayment.NextRecurrency |
— | — | — | — | |
RecurrentPayment.EndDate |
— | — | — | — | |
RecurrentPayment.Interval |
— | — | — | — | |
SplitPayments.SubordinateMerchantId |
— | — | — | — | |
SplitPayments.Amount |
— | — | — | — | |
SplitPayments.Fares.Mdr |
— | — | — | — | |
SplitPayments.Fares.Fee |
— | — | — | — | |
SplitErrors.Code |
— | — | — | — | |
SplitErrors.Message |
— | — | — | — |
Crédito Digitado com dados de Comprador
Requisição
{
"MerchantOrderId": "201904150001",
"Customer": {
"Name": "Comprador crédito completo",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "compradorteste@teste.com",
"Birthday": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
}
},
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Capture": true,
"Interest": "ByMerchant",
"ProductId": 1,
"CreditCard": {
"CardNumber": 1234567812345678,
"ExpirationDate": "12/2020",
"SecurityCodeStatus": "Collected",
"SecurityCode": 1230,
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Typed",
"AuthenticationMethod": "NoPassword",
"TruncateCardNumberWhenPrinting": true,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Customer.Name |
String | 255 | Não | Nome do comprador |
Customer.Identity |
String | 14 | Não | Numero do cpf ou cnpj do cliente |
Customer.IdentityType |
String | 255 | Não | Tipo de documento de identificação do comprador (CPF ou CNPJ) |
Customer.Email |
String | 255 | Não | Email do comprador |
Customer.Birthday |
String | 10 | Não | Data de nascimento do comprador no formato AAAA-MM-DD |
Customer.Address.Street |
String | 255 | Não | Endereço de contato do comprador |
Customer.Address.Number |
String | 15 | Não | Número do endereço de contato do comprador |
Customer.Address.Complement |
String | 50 | Não | Complemento do endereço de contato do comprador |
Customer.Address.ZipCode |
String | 9 | Não | CEP do endereço de contato do comprador |
Customer.Address.City |
String | 50 | Não | Cidade do endereço de contato do comprador |
Customer.Address.State |
String | 2 | Não | Estado do endereço de contato do comprador |
Customer.Address.Country |
String | 35 | Não | País do endereço de contato do comprador |
Customer.DeliveryAddress.Street |
String | 255 | Não | Endereço de entrega do comprador |
Customer.DeliveryAddress.Number |
String | 15 | Não | Número do endereço de entrega |
Customer.DeliveryAddress.Complement |
String | 50 | Não | Complemento do endereço de entrega |
Customer.DeliveryAddress.ZipCode |
String | 9 | Não | CEP do endereço de entrega |
Customer.DeliveryAddress.City |
String | 50 | Não | Cidade do endereço de entrega |
Customer.DeliveryAddress.State |
String | 2 | Não | Estado do endereço de entrega |
Customer.DeliveryAddress.Country |
String | 35 | Não | País do endereço de entrega |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.CreditCard.CardNumber |
String | 19 | Sim | Número do cartão (PAN) |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.SecurityCodeStatus |
String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.CreditCard.SecurityCode |
String | 4 | Sim | Código de segurança (CVV) |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry da baixa de parametros. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | Não | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no campo AllowPrintingPartialCardNumberInReceipt presente nos objetos BinEntry, ParameterEntry e IssuerEntry. |
Payment.CreditCard.SaveCard |
Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão. |
Payment.CreditCard.IsFallback |
Booleano | — | Não | Identifica se é uma transação de fallback. |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "20180204",
"Customer": {
"Name": "Comprador crédito completo",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "compradorteste@teste.com",
"Birthday": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
}
},
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PaymentDateTime": "2019-04-15T12:00:00Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"Provider": "Cielo",
"ConfirmationStatus": 0,
"InitializationVersion": 1558708320029,
"EmvResponseData": "123456789ABCD1345DEA",
"Status": 2,
"IsSplitted": false,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
},
"RecurrentPayment": {
"RecurrentPaymentId": "a6b719fa-a8df-ab11-4e1a-f4e50d5bd702",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"NextRecurrency": "2019-12-01",
"EndDate": "2019-12-01",
"Interval": 6
},
"SplitPayments": [
{
"SubordinateMerchantId": "491daf20-35f2-4379-874c-e7552ae8dc10",
"Amount": 100,
"Fares": {
"Mdr": 5,
"Fee": 0
}
},
{
"SubordinateMerchantId": "7e2846be-4e80-4f86-8ca9-eb35db6aea00",
"Amount": 80,
"Fares": {
"Mdr": 3,
"Fee": 1
}
}
],
"SplitErrors": [
{
"Code": 326,
"Message": "SubordinatePayment amount must be greater than zero"
}
]
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição | |
---|---|---|---|---|---|
MerchantOrderId |
String | — | — | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. Aceita apenas valores numéricos de 1 a 15 dígitos. | |
Customer.Name |
String | — | — | — | — |
Customer.Identity |
— | — | — | — | |
Customer.IdentityType |
— | — | — | — | |
Customer.Email |
— | — | — | — | |
Customer.Birthday |
— | — | — | — | |
Address.Street |
String | — | — | — | |
Address.Number |
String | — | — | — | |
Address.Complement |
String | — | — | — | |
Address.ZipCode |
String | — | — | — | |
Address.City |
String | — | — | — | |
Address.State |
String | — | — | — | |
Address.Country |
String | — | — | — | |
DeliveryAddress.Street |
String | — | — | — | |
DeliveryAddress.Number |
String | — | — | — | |
DeliveryAddress.Complement |
String | — | — | — | |
DeliveryAddress.ZipCode |
String | — | — | — | |
DeliveryAddress.City |
String | — | — | — | |
DeliveryAddress.State |
String | — | — | — | |
DeliveryAddress.Country |
String | — | — | — | |
Payment.Installments |
Integer | — | — | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos maxOfPayments1, maxOfPayments2, maxOfPayments3 e minValOfPayments da tabela productTable. | |
Payment.Interest |
String | — | — | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
|
Payment.Capture |
Booleano | — | — | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. | |
CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
|
CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. | |
CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. | |
CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | — | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no confParamOp03 presente nas tabelas BIN TABLE, PARAMETER TABLE e ISSUER TABLE. |
|
CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
|
CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
|
CreditCard.EmvData |
String | — | — | Dados da transação EMV Obtidos através do comando PP_GoOnChip na BC |
|
PinBlock.EncryptedPinBlock |
— | — | — | — | |
PinBlock.EncryptionType |
String | — | — | — | |
PinBlock.KsnIdentification |
String | — | — | — | |
CreditCard.PanSequenceNumber |
Number | — | — | Número sequencial do cartão, utilizado para identificar a conta corrente do cartão adicional. Mandatório para transações com cartões Chip EMV e que possuam PAN Sequence Number (Tag 5F34). | |
CreditCard.SaveCard |
— | — | — | — | |
CreditCard.IsFallback |
— | — | — | — | |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação | |
Payment.ServiceTaxAmount |
— | — | — | — | |
Payment.SoftDescriptor |
String | 13 | — | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. | |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. | |
PinPadInformation.TerminalId |
String | — | Sim | Número Lógico definido no Concentrador Cielo. | |
PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. | |
PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad ; PIN-pad sem leitor de Chip = PinpadWithoutChipReader ; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule ; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule ; PIN-pad não homologado = NotCertifiedPinPad ; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless ; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless . Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
|
PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada | |
Payment.Amount |
Integer(int64) | — | Sim | Valor da transação (1079 = R$10,79) | |
Payment.ReceivedDate |
— | — | — | — | |
Payment.CapturedAmount |
— | — | — | — | |
Payment.Provider |
String | — | — | — | |
Payment.ConfirmationStatus |
— | — | — | — | |
Payment.InitializationVersion |
— | — | — | — | |
Payment.EmvResponseData |
— | — | — | — | |
Payment.Status |
— | — | — | — | |
Payment.IsSplitted |
Booleano | — | — | — | |
Payment.ReturnCode |
— | — | — | — | |
Payment.ReturnMessage |
String | — | — | — | |
Payment.PaymentId |
— | — | — | — | |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
|
Payment.Currency |
String | — | — | Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”) | |
Payment.Country |
String | — | — | Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”) | |
Receipt.MerchantName |
— | — | — | — | |
Receipt.MerchantAddress |
— | — | — | — | |
Receipt.MerchantCity |
— | — | — | — | |
Receipt.MerchantState |
— | — | — | — | |
Receipt.MerchantCode |
— | — | — | — | |
Receipt.Terminal |
— | — | — | — | |
Receipt.Nsu |
— | — | — | — | |
Receipt.Date |
— | — | — | — | |
Receipt.Hour |
— | — | — | — | |
Receipt.IssuerName |
— | — | — | — | |
Receipt.CardNumber |
— | — | — | — | |
Receipt.TransactionType |
— | — | — | — | |
Receipt.AuthorizationCode |
— | — | — | — | |
Receipt.TransactionMode |
— | — | — | — | |
Receipt.InputMethod |
— | — | — | — | |
Receipt.Value |
— | — | — | — | |
Receipt.SoftDescriptor |
— | — | — | — | |
RecurrentPayment.RecurrentPaymentId |
— | — | — | — | |
RecurrentPayment.ReasonCode |
— | — | — | — | |
RecurrentPayment.ReasonMessage |
— | — | — | — | |
RecurrentPayment.NextRecurrency |
— | — | — | — | |
RecurrentPayment.EndDate |
— | — | — | — | |
RecurrentPayment.Interval |
— | — | — | — | |
SplitPayments.SubordinateMerchantId |
— | — | — | — | |
SplitPayments.Amount |
— | — | — | — | |
SplitPayments.Fares.Mdr |
— | — | — | — | |
SplitPayments.Fares.Fee |
— | — | — | — | |
SplitErrors.Code |
— | — | — | — | |
SplitErrors.Message |
— | — | — | — |
Crédito digitado com cartão criptografado
Requisição
{
"MerchantOrderId": "201904150001",
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Capture": true,
"Interest": "ByMerchant",
"ProductId": 1,
"CreditCard": {
"CardNumber": "EncryptedCardNumber",
"EncryptedCardData": {
"EncryptionType": "DUKPT3DES",
"CardNumberKSN": "KSNforCardNumber"
},
"ExpirationDate": "12/2020",
"SecurityCodeStatus": "Collected",
"SecurityCode": 1230,
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Typed",
"AuthenticationMethod": "NoPassword",
"TruncateCardNumberWhenPrinting": true,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. Aceita apenas valores numéricos de 1 a 15 dígitos. |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos maxOfPayments1, maxOfPayments2, maxOfPayments3 e minValOfPayments da tabela productTable. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
CreditCard.CardNumber |
String | — | Sim | Número do cartão (PAN) criptografado |
CreditCard.EncryptedCardData.EncryptionType |
String | — | Sim | Tipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2 <br “Dukpt3Des” = 3, “Dukpt3DesCBC” = 4 |
CreditCard.EncryptedCardData.CardNumberKSN |
String | — | — | Identificador KSN da criptografia do número do cartão |
CreditCard.EncryptedCardData.IsDataInTLVFormat |
Bool | — | Não | Identifica se os dados criptografados estão no formato TLV (tag / length / value). |
CreditCard.EncryptedCardData.InitializationVector |
String | — | Sim | Vetor de inicialização da encryptação |
CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
CreditCard.SecurityCodeStatus |
String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
CreditCard.SecurityCode |
String | 4 | Sim | Código de segurança (CVV) |
CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | — | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no confParamOp03 presente nas tabelas BIN TABLE, PARAMETER TABLE e ISSUER TABLE. |
CreditCard.SaveCard |
Booleano | — | — | Identifica se vai salvar/tokenizar o cartão. |
CreditCard.IsFallback |
Booleano | — | — | Identifica se é uma transação de fallback. |
PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless SemPIN-pad = WithoutPinPad;PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "20180204",
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PaymentDateTime": "2019-04-15T12:00:00Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"Provider": "Cielo",
"ConfirmationStatus": 0,
"InitializationVersion": 1558708320029,
"EmvResponseData": "123456789ABCD1345DEA",
"Status": 2,
"IsSplitted": false,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"MerchantAcquirerId": "0010000244470001",
"TerminalAcquirerId": "71000027",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição | |
---|---|---|---|---|---|
MerchantOrderId |
String | — | — | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. Aceita apenas valores numéricos de 1 a 15 dígitos. | |
Customer.Name |
String | — | — | — | |
Customer.Identity |
— | — | — | — | |
Customer.IdentityType |
— | — | — | — | |
Customer.Email |
— | — | — | — | |
Customer.Birthday |
— | — | — | — | |
Address.Street |
String | — | — | — | |
Address.Number |
String | — | — | — | |
Address.Complement |
String | — | — | — | |
Address.ZipCode |
String | — | — | — | |
Address.City |
String | — | — | — | |
Address.State |
String | — | — | — | |
Address.Country |
String | — | — | — | |
DeliveryAddress.Street |
String | — | — | — | |
DeliveryAddress.Number |
String | — | — | — | |
DeliveryAddress.Complement |
String | — | — | — | |
DeliveryAddress.ZipCode |
String | — | — | — | |
DeliveryAddress.City |
String | — | — | — | |
DeliveryAddress.State |
String | — | — | — | |
DeliveryAddress.Country |
String | — | — | — | |
Payment.Installments |
Integer | — | — | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos maxOfPayments1, maxOfPayments2, maxOfPayments3 e minValOfPayments da tabela productTable. | |
Payment.Interest |
String | — | — | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
|
Payment.Capture |
Booleano | — | — | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. | |
CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão.Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. | |
CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. | |
CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. | |
CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | — | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no confParamOp03 presente nas tabelas BIN TABLE, PARAMETER TABLE e ISSUER TABLE. | |
CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja |
“06” - EMV sem contato. |
CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
|
CreditCard.EmvData |
String | — | — | Dados da transação EMV Obtidos através do comando PP_GoOnChip na BC |
|
PinBlock.EncryptedPinBlock |
— | — | — | — | |
PinBlock.EncryptionType |
String | — | — | — | |
PinBlock.KsnIdentification |
String | — | — | — | |
CreditCard.PanSequenceNumber |
Number | — | — | Número sequencial do cartão, utilizado para identificar a conta corrente do cartão adicional. Mandatório para transações com cartões Chip EMV e que possuam PAN Sequence Number (Tag 5F34). | |
CreditCard.SaveCard |
— | — | — | — | |
CreditCard.IsFallback |
— | — | — | — | |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação | |
Payment.ServiceTaxAmount |
— | — | — | — | |
Payment.SoftDescriptor |
String | 13 | — | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. | |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. | |
PinPadInformation.TerminalId |
String | — | Sim | Número Lógico definido no Concentrador Cielo. | |
PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. | |
PinPadInformation.PhysicalCharacteristics |
String | - | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad ; PIN-pad sem leitor de Chip = PinpadWithoutChipReader ; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule ; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule ; PIN-pad não homologado = NotCertifiedPinPad ; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless ; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless . Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
|
PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada | |
Payment.Amount|Integer |
(int64) | — | Sim | Valor da transação (1079 = R$10,79) | |
Payment.ReceivedDate |
— | — | — | — | |
Payment.CapturedAmount |
— | — | — | — | |
Payment.Provider |
String | - | — | — | |
Payment.ConfirmationStatus |
- | — | — | — | |
Payment.InitializationVersion |
- | — | — | — | |
Payment.EmvResponseData |
— | — | — | — | |
Payment.Status |
— | — | — | — | |
Payment.IsSplitted |
Booleano | — | — | — | — |
Payment.ReturnCode |
— | — | — | — | |
Payment.ReturnMessage |
String | — | — | — | |
Payment.PaymentId |
— | — | — | — | |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação | |
Payment.Currency |
String | — | — | Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”) | |
Payment.Country |
String | — | — | Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”) | |
Receipt.MerchantName |
— | — | — | — | |
Receipt.MerchantAddress |
— | — | — | — | |
Receipt.MerchantCity |
— | — | — | — | |
Receipt.MerchantState |
— | — | — | — | |
Receipt.MerchantCode |
— | — | — | — | |
Receipt.Terminal |
— | — | — | — | |
Receipt.Nsu |
— | — | — | — | |
Receipt.Date |
— | — | — | — | |
Receipt.Hour |
— | — | — | — | |
Receipt.IssuerName |
— | — | — | — | |
Receipt.CardNumber |
— | — | — | — | |
Receipt.TransactionType |
— | — | — | — | |
Receipt.AuthorizationCode |
— | — | — | — | |
Receipt.TransactionMode |
— | — | — | — | |
Receipt.InputMethod |
— | — | — | — | |
Receipt.Value |
— | — | — | — | |
Receipt.SoftDescriptor |
— | — | — | — | |
RecurrentPayment.RecurrentPaymentId |
— | — | — | — | |
RecurrentPayment.ReasonCode |
— | — | — | — | |
RecurrentPayment.ReasonMessage |
— | — | — | — | |
RecurrentPayment.NextRecurrency |
— | — | — | — | |
RecurrentPayment.EndDate |
— | — | — | — | |
RecurrentPayment.Interval |
— | — | — | — | |
SplitPayments.SubordinateMerchantId |
— | — | — | — | |
SplitPayments.Amount |
— | — | — | — | |
SplitPayments.Fares.Mdr |
— | — | — | — | |
SplitPayments.Fares.Fee |
— | — | — | — | |
SplitErrors.Code |
— | — | — | — | |
SplitErrors.Message |
— | — | — | — |
Crédito digitado com Split
Requisição
{
"MerchantOrderId": "201904150001",
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Capture": true,
"Interest": "ByMerchant",
"ProductId": 1,
"CreditCard": {
"CardNumber": 1234567812345678,
"ExpirationDate": "12/2020",
"SecurityCodeStatus": "Collected",
"SecurityCode": 1230,
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Typed",
"AuthenticationMethod": "NoPassword",
"TruncateCardNumberWhenPrinting": true,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"SplitPayments": [
{
"SubordinateMerchantId": "491daf20-35f2-4379-874c-e7552ae8dc10",
"Amount": 100,
"Fares": {
"Mdr": 5,
"Fee": 0
}
},
{
"SubordinateMerchantId": "7e2846be-4e80-4f86-8ca9-eb35db6aea00",
"Amount": 80,
"Fares": {
"Mdr": 3,
"Fee": 1
}
}
]
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.CreditCard.CardNumber |
String | 19 | Sim | Número do cartão (PAN) |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.SecurityCodeStatus |
String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.CreditCard.SecurityCode |
String | 4 | Sim | Código de segurança (CVV) |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry da baixa de parametros. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | Não | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no campo AllowPrintingPartialCardNumberInReceipt presente nos objetos BinEntry, ParameterEntry e IssuerEntry. |
Payment.CreditCard.SaveCard |
Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão. |
Payment.CreditCard.IsFallback |
Booleano | — | Não | Identifica se é uma transação de fallback. |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Payment.SplitPayments.SubordinateMerchantId |
String (Guid) | 36 | Não | Identificador do Seller na Cielo. |
Payment.SplitPayments.Amount |
Integer | 15 | Não | Total da venda do Seller específico. R$ 100,00 = 10000 |
Payment.SplitPayments.Fares.Mdr |
Decimal | 3,2 | Não | Taxa aplicada pela loja Master sobre o Seller para desconto |
Payment.SplitPayments.Fares.Fee |
Integer | 15 | Não | Tarifa aplicada pela loja Master sobre o Seller para desconto |
Resposta
{
"MerchantOrderId": "20180204",
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PaymentDateTime": "2019-04-15T12:00:00Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"Provider": "Cielo",
"ConfirmationStatus": 0,
"InitializationVersion": 1558708320029,
"EmvResponseData": "123456789ABCD1345DEA",
"Status": 2,
"IsSplitted": true,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"MerchantAcquirerId": "0010000244470001",
"TerminalAcquirerId": "71000027",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
},
"SplitPayments": [
{
"SubordinateMerchantId": "491daf20-35f2-4379-874c-e7552ae8dc10",
"Amount": 100,
"Fares": {
"Mdr": 5,
"Fee": 0
}
},
{
"SubordinateMerchantId": "7e2846be-4e80-4f86-8ca9-eb35db6aea00",
"Amount": 80,
"Fares": {
"Mdr": 3,
"Fee": 1
}
}
]
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.ServiceTaxAmount |
Integer | 15 | Não | Aplicável apenas para empresas aéreas. Montante do valor da autorização que deve ser destinado à taxa de serviço. Obs.: Esse valor não é adicionado ao valor da autorização. |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.Amount |
Integer(int64) | — | Sim | Valor da transação (1079 = R$10,79) |
Payment.ReceivedDate |
String (DateTime) | — | Sim | Data em que a transação foi recebida. Formato “AAAA-MM-DD HH:mm:SS” |
Payment.CapturedAmount |
Integer | 15 | Sim | Valor capturado, sem pontuação. 100 equivale a R$ 1,00 |
Payment.CapturedDate |
String (DateTime) | - | Não | Data da captura |
Payment.Provider |
String | 15 | Sim | Nome do provedor do meio de pagamento |
Payment.ConfirmationStatus |
Integer | 2 | Não | Status da confirmação. 0 = Pendente 1 = Confirmado 2 = Desfeito |
Payment.InitializationVersion |
Integer int16 | — | Sim | Número de versão dos parametros baixados na inicialização do equipamento. |
Payment.Status |
Integer | 2 | Sim | Status da transação 0 = Não Finalizado 1 = Autorizado 2 = Pago 3 = Negado 10 = Cancelado 13 = Abortado |
Payment.IsSplitted |
Booleano | — | Não | Indica se o pagamento tem split ou não. Default: false |
Payment.ReturnCode |
String | 3 | Sim | Código de erro/resposta da transação da Adquirência. |
Payment.ReturnMessage |
String | — | Sim | Mensagem de erro/resposta da transação da Adquirência. |
Payment.PaymentId |
String (Guid) | 36 | Sim | Código do Pagamento |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.Currency |
String | 3 | Não | Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”) |
Payment.Country |
String | 3 | Não | Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”) |
Payment.CreditCard.CardNumber |
String | 19 | Sim | Número do cartão |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.SecurityCodeStatus |
String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.CreditCard.SecurityCode |
String | 4 | Sim | retorno com valor mascarado |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry. |
Payment.CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | Não | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no campo AllowPrintingPartialCardNumberInReceipt presente nos objetos BinEntry, ParameterEntry e IssuerEntry. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword, OnlineAuthentication, OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.BrandInformation.Type |
String | _ | Não | Tipo de venda. |
Payment.CreditCard.BrandInformation.Name |
String | — | Não | Nome da bandeira do cartão. |
Payment.CreditCard.SaveCard |
Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão |
Payment.CreditCard.IsFallback |
Booleano | — | Não | Identifica se é uma transação de fallback. |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Payment.Receipt.MerchantName |
String | — | Sim | Nome da loja |
Payment.Receipt.MerchantAddress |
String | — | Sim | Endereço da loja |
Payment.Receipt.MerchantCity |
String | — | Sim | Cidade da loja |
Payment.Receipt.MerchantState |
String | — | Sim | Estado da loja |
Payment.Receipt.MerchantCode |
String | — | Sim | Codigo de identificação da loja |
Payment.Receipt.Terminal |
String | 8 | Sim | Identificação do Terminal |
Payment.Receipt.Nsu |
String | — | Sim | Numero de identificação da transação Cielo |
Payment.Receipt.Date |
String | — | Sim | Data da transação |
Payment.Receipt.Hour |
String | — | Sim | Horario da transação |
Payment.Receipt.IssuerName |
String | — | Sim | Nome do emissor obtido através do campo IssuerId no objeto BinEntry. |
Payment.Receipt.CardNumber |
String | — | Sim | Número do cartão |
Payment.Receipt.CardHolder |
String | — | Não | Nome do titular do cartão. |
Payment.Receipt.Brand |
String | — | Sim | Bandeira do cartão |
Payment.Receipt.TransactionType |
String | — | Sim | Tipo de transação |
Payment.Receipt.AuthorizationCode |
String | — | Sim | Código da autorização |
Payment.Receipt.TransactionMode |
String | — | Sim | Modo da transação |
Payment.Receipt.InputMethod |
String | — | Sim | Metodo de entrada |
Payment.Receipt.Value |
String | — | Sim | Valor do pagamento |
Payment.Receipt.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.Links |
Array[Object] | - | Não | links de navegação. |
Payment.Links.Method |
String | - | Sim | Metodo do link de navegação. |
Payment.Links.Rel |
String | - | Sim | Links de retorno para navegação. |
Payment.Links.Href |
String | - | Sim | Endereço do links de navegação. |
Payment.PrintMessage |
Array[Object] | - | Não | Dados para impressão. |
Payment.PrintMessage.Position |
String | - | Sim | Posição para impressão. |
Payment.PrintMessage.Message |
String | - | Sim | Mensagem para impressão. |
Payment.ReceiptInformation |
Array[Object] | - | Não | Dados do recibo. |
Payment.ReceiptInformation.Field |
String | - | Sim | Nome do campo do recibo. |
Payment.ReceiptInformation.Label |
String | - | Sim | Titulo do campo do recibo. |
Payment.ReceiptInformation.Content |
String | - | Sim | conteúdo do campo do recibo. |
Payment.SplitPayments.SubordinateMerchantId |
String (Guid) | 36 | Não | Identificador do Seller na Cielo. |
Payment.SplitPayments.Amount |
Integer | 15 | Não | Total da venda do Seller específico. R$ 100,00 = 10000 |
Payment.SplitPayments.Fares.Mdr |
Decimal | 3,2 | Não | Taxa aplicada pela loja Master sobre o Seller para desconto |
Payment.SplitPayments.Fares.Fee |
Integer | 15 | Não | Tarifa aplicada pela loja Master sobre o Seller para desconto |
Payment.SplitErrors.Code |
String | — | Não | Código de erro/resposta da transação do Split |
Payment.SplitErrors.Message |
String | — | Não | Mensagem de erro/resposta da transação do Split |
Crédito digitado com dados do facilitador
Requisição
{
"MerchantOrderId": "201904150001",
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Capture": true,
"Interest": "ByMerchant",
"ProductId": 1,
"CreditCard": {
"CardNumber": 1234567812345678,
"ExpirationDate": "12/2020",
"SecurityCodeStatus": "Collected",
"SecurityCode": 1230,
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Typed",
"AuthenticationMethod": "NoPassword",
"TruncateCardNumberWhenPrinting": true,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"PaymentFacilitator": {
"EstablishmentCode": "12345678901",
"SubEstablishment": {
"EstablishmentCode": "123456789012345",
"Mcc": "1234",
"Address": "1234567890abcdefghji12",
"City": "1234567890abc",
"State": "ab",
"PostalCode": "123456789",
"PhoneNumber": "1234567890123",
"CountryCode": "076",
"DocumentType": "Cpf",
"DocumentNumber": "12345678901"
}
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Não | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed, MagStripe, Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.TrackOneData |
String | — | Sim | Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.CreditCard.TrackTwoData |
String | — | Não | Dados da trilha 2 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.CreditCard.PinBlock.EncryptedPinBlock |
String | — | Não | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
Payment.CreditCard.PinBlock.EncryptionType |
String | — | Não | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
Payment.CreditCard.PinBlock.KsnIdentification |
String | — | Não | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
Payment.PinPadInformation.TerminalId |
String | 8 | Não | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Não | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Não | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Não | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "20180204",
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PaymentDateTime": "2019-04-15T12:00:00Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"Provider": "Cielo",
"ConfirmationStatus": 0,
"InitializationVersion": 1558708320029,
"EmvResponseData": "123456789ABCD1345DEA",
"Status": 2,
"IsSplitted": false,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"MerchantAcquirerId": "0010000244470001",
"TerminalAcquirerId": "71000027",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
},
"PaymentFacilitator": {
"EstablishmentCode": "12345678901",
"SubEstablishment": {
"EstablishmentCode": "123456789012345",
"Mcc": "1234",
"Address": "1234567890abcdefghji12",
"City": "1234567890abc",
"State": "ab",
"PostalCode": "123456789",
"PhoneNumber": "1234567890123",
"CountryCode": "076",
"DocumentType": "Cpf",
"DocumentNumber": "12345678901"
}
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Customer.Name |
String | 255 | Não | Nome do comprador |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.ReceivedDate |
String (DateTime) | — | Sim | Data em que a transação foi recebida. Formato “AAAA-MM-DD HH:mm:SS” |
Payment.CapturedAmount |
Integer | 15 | Sim | Valor capturado, sem pontuação. 100 equivale a R$ 1,00 |
InitializationVersion |
Integer int16 | — | Sim | Número de versão dos parametros baixados na inicialização do equipamento. |
Payment.ConfirmationStatus |
Integer | 2 | Não | Status da confirmação. 0 = Pendente 1 = Confirmado 2 = Desfeito |
Payment.Status |
Integer | 2 | Sim | Status da transação 0 = Não Finalizado 1 = Autorizado 2 = Pago 3 = Negado 10 = Cancelado 13 = Abortado |
Payment.ReturnCode |
String | 3 | Sim | Código de erro/resposta da transação da Adquirência. |
Payment.ReturnMessage |
String | — | Sim | Mensagem de erro/resposta da transação da Adquirência. |
Payment.PaymentId |
String (Guid) | 36 | Sim | Código do Pagamento |
Payment.SoftDescriptor |
String | 13 | — | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed, MagStripe, Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.TrackOneData |
String | — | Sim | Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.CreditCard.TrackTwoData |
String | — | Não | Dados da trilha 2 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.CreditCard.PinBlock.EncryptedPinBlock |
String | — | Sim | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
Payment.CreditCard.PinBlock.EncryptionType |
String | — | Sim | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
Payment.CreditCard.PinBlock.KsnIdentification |
String | — | Sim | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
Payment.PinPadInformation.TerminalId |
String | 8 | Não | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Não | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Não | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Não | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Payment.Receipt.MerchantName |
String | — | Sim | Nome da loja |
Payment.Receipt.MerchantAddress |
String | — | Sim | Endereço da loja |
Payment.Receipt.MerchantCity |
String | — | Sim | Cidade da loja |
Payment.Receipt.MerchantState |
String | — | Sim | Estado da loja |
Payment.Receipt.MerchantCode |
String | — | Sim | Codigo de identificação da loja |
Payment.Receipt.Terminal |
String | 8 | Sim | Identificação do Terminal |
Payment.Receipt.Nsu |
String | — | Sim | Numero de identificação da transação Cielo |
Payment.Receipt.Date |
String | — | Sim | Data da transação |
Payment.Receipt.Hour |
String | — | Sim | Horario da transação |
Payment.Receipt.IssuerName |
String | — | Sim | Nome do emissor obtido através do campo IssuerId no objeto BinEntry. |
Payment.Receipt.CardHolder |
String | — | Não | Nome do titular do cartão. |
Payment.Receipt.CardNumber |
String | — | Sim | Número do cartão |
Payment.Receipt.Brand |
String | — | Sim | Bandeira do cartão |
Payment.Receipt.TransactionType |
String | — | Sim | Tipo de transação |
Payment.Receipt.AuthorizationCode |
String | — | Sim | Código da autorização |
Payment.Receipt.TransactionMode |
String | — | Sim | Modo da transação |
Payment.Receipt.InputMethod |
String | — | Sim | Metodo de entrada |
Payment.Receipt.Value |
String | — | Sim | Valor do pagamento |
Payment.Receipt.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.Links |
Array[Object] | - | Não | links de navegação. |
Payment.Links.Method |
String | - | Sim | Metodo do link de navegação. |
Payment.Links.Rel |
String | - | Sim | Links de retorno para navegação. |
Payment.Links.Href |
String | - | Sim | Endereço do links de navegação. |
Payment.PrintMessage |
Array[Object] | - | Não | Dados para impressão. |
Payment.PrintMessage.Position |
String | - | Sim | Posição para impressão. |
Payment.PrintMessage.Message |
String | - | Sim | Mensagem para impressão. |
Payment.ReceiptInformation |
Array[Object] | - | Não | Dados do recibo. |
Payment.ReceiptInformation.Field |
String | - | Sim | Nome do campo do recibo. |
Payment.ReceiptInformation.Label |
String | - | Sim | Titulo do campo do recibo. |
Payment.ReceiptInformation.Content |
String | - | Sim | conteúdo do campo do recibo. |
Crédito digitado com tokenização de cartão
Requisição
{
"MerchantOrderId": "201904150001",
"Customer": {
"Name": "Comprador crédito completo",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "compradorteste@teste.com",
"Birthday": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
}
},
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Capture": true,
"Interest": "ByMerchant",
"ProductId": 1,
"CreditCard": {
"CardNumber": 1234567812345678,
"ExpirationDate": "12/2020",
"SecurityCodeStatus": "Collected",
"SecurityCode": 1230,
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Typed",
"AuthenticationMethod": "NoPassword",
"TruncateCardNumberWhenPrinting": true,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Customer.Name |
String | 255 | Não | Nome do comprador |
Customer.Identity |
String | 14 | Não | Numero do cpf ou cnpj do cliente |
Customer.IdentityType |
String | 255 | Não | Tipo de documento de identificação do comprador (CPF ou CNPJ) |
Customer.Email |
String | 255 | Não | Email do comprador |
Customer.Birthday |
String | 10 | Não | Data de nascimento do comprador no formato AAAA-MM-DD |
Customer.Address.Street |
String | 255 | Não | Endereço de contato do comprador |
Customer.Address.Number |
String | 15 | Não | Número do endereço de contato do comprador |
Customer.Address.Complement |
String | 50 | Não | Complemento do endereço de contato do comprador |
Customer.Address.ZipCode |
String | 9 | Não | CEP do endereço de contato do comprador |
Customer.Address.City |
String | 50 | Não | Cidade do endereço de contato do comprador |
Customer.Address.State |
String | 2 | Não | Estado do endereço de contato do comprador |
Customer.Address.Country |
String | 35 | Não | País do endereço de contato do comprador |
Customer.DeliveryAddress.Street |
String | 255 | Não | Endereço de entrega do comprador |
Customer.DeliveryAddress.Number |
String | 15 | Não | Número do endereço de entrega |
Customer.DeliveryAddress.Complement |
String | 50 | Não | Complemento do endereço de entrega |
Customer.DeliveryAddress.ZipCode |
String | 9 | Não | CEP do endereço de entrega |
Customer.DeliveryAddress.City |
String | 50 | Não | Cidade do endereço de entrega |
Customer.DeliveryAddress.State |
String | 2 | Não | Estado do endereço de entrega |
Customer.DeliveryAddress.Country |
String | 35 | Não | País do endereço de entrega |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.CreditCard.CardNumber |
String | 19 | Sim | Número do cartão (PAN) |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.SecurityCodeStatus |
String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.CreditCard.SecurityCode |
String | 4 | Sim | Código de segurança (CVV) |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry da baixa de parametros. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | Não | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no campo AllowPrintingPartialCardNumberInReceipt presente nos objetos BinEntry, ParameterEntry e IssuerEntry. |
Payment.CreditCard.SaveCard |
Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão. |
Payment.CreditCard.IsFallback |
Booleano | — | Não | Identifica se é uma transação de fallback. |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "20180204",
"Customer": {
"Name": "Comprador crédito completo",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "compradorteste@teste.com",
"Birthday": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
}
},
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PaymentDateTime": "2019-04-15T12:00:00Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"Provider": "Cielo",
"ConfirmationStatus": 0,
"InitializationVersion": 1558708320029,
"EmvResponseData": "123456789ABCD1345DEA",
"Status": 2,
"IsSplitted": false,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"MerchantAcquirerId": "0010000244470001",
"TerminalAcquirerId": "71000027",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.ServiceTaxAmount |
Integer | 15 | Não | Aplicável apenas para empresas aéreas. Montante do valor da autorização que deve ser destinado à taxa de serviço. Obs.: Esse valor não é adicionado ao valor da autorização. |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.Amount |
Integer(int64) | — | Sim | Valor da transação (1079 = R$10,79) |
Payment.ReceivedDate |
String (DateTime) | — | Sim | Data em que a transação foi recebida. Formato “AAAA-MM-DD HH:mm:SS” |
Payment.CapturedAmount |
Integer | 15 | Sim | Valor capturado, sem pontuação. 100 equivale a R$ 1,00 |
Payment.CapturedDate |
String (DateTime) | - | Não | Data da captura |
Payment.Provider |
String | 15 | Sim | Nome do provedor do meio de pagamento |
Payment.ConfirmationStatus |
Integer | 2 | Não | Status da confirmação. 0 = Pendente 1 = Confirmado 2 = Desfeito |
Payment.InitializationVersion |
Integer int16 | — | Sim | Número de versão dos parametros baixados na inicialização do equipamento. |
Payment.Status |
Integer | 2 | Sim | Status da transação 0 = Não Finalizado 1 = Autorizado 2 = Pago 3 = Negado 10 = Cancelado 13 = Abortado |
Payment.IsSplitted |
Booleano | — | Não | Indica se o pagamento tem split ou não. Default: false |
Payment.ReturnCode |
String | 3 | Sim | Código de erro/resposta da transação da Adquirência. |
Payment.ReturnMessage |
String | — | Sim | Mensagem de erro/resposta da transação da Adquirência. |
Payment.PaymentId |
String (Guid) | 36 | Sim | Código do Pagamento |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.Currency |
String | 3 | Não | Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”) |
Payment.Country |
String | 3 | Não | Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”) |
Payment.CreditCard.CardNumber |
String | 19 | Sim | Número do cartão |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.SecurityCodeStatus |
String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.CreditCard.SecurityCode |
String | 4 | Sim | retorno com valor mascarado |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry. |
Payment.CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | Não | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no campo AllowPrintingPartialCardNumberInReceipt presente nos objetos BinEntry, ParameterEntry e IssuerEntry. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword, OnlineAuthentication, OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.BrandInformation.Type |
String | _ | Não | Tipo de venda. |
Payment.CreditCard.BrandInformation.Name |
String | — | Não | Nome da bandeira do cartão. |
Payment.CreditCard.SaveCard |
Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão |
Payment.CreditCard.IsFallback |
Booleano | — | Não | Identifica se é uma transação de fallback. |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Payment.Receipt.MerchantName |
String | — | Sim | Nome da loja |
Payment.Receipt.MerchantAddress |
String | — | Sim | Endereço da loja |
Payment.Receipt.MerchantCity |
String | — | Sim | Cidade da loja |
Payment.Receipt.MerchantState |
String | — | Sim | Estado da loja |
Payment.Receipt.MerchantCode |
String | — | Sim | Codigo de identificação da loja |
Payment.Receipt.Terminal |
String | 8 | Sim | Identificação do Terminal |
Payment.Receipt.Nsu |
String | — | Sim | Numero de identificação da transação Cielo |
Payment.Receipt.Date |
String | — | Sim | Data da transação |
Payment.Receipt.Hour |
String | — | Sim | Horario da transação |
Payment.Receipt.IssuerName |
String | — | Sim | Nome do emissor obtido através do campo IssuerId no objeto BinEntry. |
Payment.Receipt.CardNumber |
String | — | Sim | Número do cartão |
Payment.Receipt.CardHolder |
String | — | Não | Nome do titular do cartão. |
Payment.Receipt.Brand |
String | — | Sim | Bandeira do cartão |
Payment.Receipt.TransactionType |
String | — | Sim | Tipo de transação |
Payment.Receipt.AuthorizationCode |
String | — | Sim | Código da autorização |
Payment.Receipt.TransactionMode |
String | — | Sim | Modo da transação |
Payment.Receipt.InputMethod |
String | — | Sim | Metodo de entrada |
Payment.Receipt.Value |
String | — | Sim | Valor do pagamento |
Payment.Receipt.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.Links |
Array[Object] | - | Não | links de navegação. |
Payment.Links.Method |
String | - | Sim | Metodo do link de navegação. |
Payment.Links.Rel |
String | - | Sim | Links de retorno para navegação. |
Payment.Links.Href |
String | - | Sim | Endereço do links de navegação. |
Payment.PrintMessage |
Array[Object] | - | Não | Dados para impressão. |
Payment.PrintMessage.Position |
String | - | Sim | Posição para impressão. |
Payment.PrintMessage.Message |
String | - | Sim | Mensagem para impressão. |
Payment.ReceiptInformation |
Array[Object] | - | Não | Dados do recibo. |
Payment.ReceiptInformation.Field |
String | - | Sim | Nome do campo do recibo. |
Payment.ReceiptInformation.Label |
String | - | Sim | Titulo do campo do recibo. |
Payment.ReceiptInformation.Content |
String | - | Sim | conteúdo do campo do recibo. |
Customer.Name |
String | 255 | Não | Nome do comprador |
Customer.Identity |
String | 14 | Não | Numero do cpf ou cnpj do cliente |
Customer.IdentityType |
String | 255 | Não | Tipo de documento de identificação do comprador (CPF ou CNPJ) |
Customer.Email |
String | 255 | Não | Email do comprador |
Customer.Birthday |
String | 10 | Não | Data de nascimento do comprador no formato AAAA-MM-DD |
Customer.Address.Street |
String | 255 | Não | Endereço de contato do comprador |
Customer.Address.Number |
String | 15 | Não | Número do endereço de contato do comprador |
Customer.Address.Complement |
String | 50 | Não | Complemento do endereço de contato do comprador |
Customer.Address.ZipCode |
String | 9 | Não | CEP do endereço de contato do comprador |
Customer.Address.City |
String | 50 | Não | Cidade do endereço de contato do comprador |
Customer.Address.State |
String | 2 | Não | Estado do endereço de contato do comprador |
Customer.Address.Country |
String | 35 | Não | País do endereço de contato do comprador |
Customer.DeliveryAddress.Street |
String | 255 | Não | Endereço de entrega do comprador |
Customer.DeliveryAddress.Number |
String | 15 | Não | Número do endereço de entrega |
Customer.DeliveryAddress.Complement |
String | 50 | Não | Complemento do endereço de entrega |
Customer.DeliveryAddress.ZipCode |
String | 9 | Não | CEP do endereço de entrega |
Customer.DeliveryAddress.City |
String | 50 | Não | Cidade do endereço de entrega |
Customer.DeliveryAddress.State |
String | 2 | Não | Estado do endereço de entrega |
Customer.DeliveryAddress.Country |
String | 35 | Não | País do endereço de entrega |
Crédito por tarja e senha
Requisição
{
"MerchantOrderId": "201904150002",
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Capture": true,
"Interest": "ByMerchant",
"ProductId": 1,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"InputMode": "MagStripe",
"AuthenticationMethod": "OnlineAuthentication",
"TrackOneData": "A1234567890123456^FULANO OLIVEIRA SA ^12345678901234567890123",
"TrackTwoData": "0123456789012345=012345678901234",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
}
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModuleAndContactless",
"ReturnDataInfo": "00"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Não | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed, MagStripe, Emv, ContactlessEmv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.TrackOneData |
String | — | Sim | Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.CreditCard.TrackTwoData |
String | — | Não | Dados da trilha 2 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.CreditCard.PinBlock.EncryptedPinBlock |
String | — | Não | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
Payment.CreditCard.PinBlock.EncryptionType |
String | — | Não | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
Payment.CreditCard.PinBlock.KsnIdentification |
String | — | Não | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "20180204",
"Customer": {
"Name": "[Guest]"
},
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"InputMode": "MagStripe",
"AuthenticationMethod": "OnlineAuthentication",
"TrackOneData": "A1234567890123456^FULANO OLIVEIRA SA ^12345678901234567890123",
"TrackTwoData": "0123456789012345=012345678901234",
"SaveCard": false,
"IsFallback": false,
"BrandInformation": {
"Type": "VENDA A DEBITO",
"Name": "VISA"
},
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"CapturedDate": "2019-04-15T12:00:00Z",
"Provider": "Cielo",
"Status": 2,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalCreditCard",
"Currency": "BRL",
"Country": "BRA",
"PaymentDateTime": "2021-09-16T11:42:57.555Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Transação API",
"ProductId": 80,
"AuthorizationCode": "425871",
"ProofOfSale": "284537",
"InitializationVersion": 0,
"ConfirmationStatus": 0,
"OfflinePaymentType": "Online",
"MerchantAcquirerId": "0011110225820001",
"TerminalAcquirerId": "41168548",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"CardHolder": "holder",
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Customer.Name |
String | 255 | Não | Nome do comprador |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.ReceivedDate |
String (DateTime) | — | Sim | Data em que a transação foi recebida. Formato “AAAA-MM-DD HH:mm:SS” |
Payment.CapturedAmount |
Integer | 15 | Sim | Valor capturado, sem pontuação. 100 equivale a R$ 1,00 |
Payment.CapturedDate |
Datetime | Não | Data da captura do pagamento | |
Payment.Provider |
String | 15 | Sim | Nome do provedor do meio de pagamento |
Payment.InitializationVersion |
Integer int16 | — | Sim | Número de versão dos parametros baixados na inicialização do equipamento. |
Payment.ConfirmationStatus |
Integer | 2 | Não | Status da confirmação. 0 = Pendente 1 = Confirmado 2 = Desfeito |
Payment.Status |
Integer | 2 | Sim | Status da transação 0 = Não Finalizado 1 = Autorizado 2 = Pago 3 = Negado 10 = Cancelado 13 = Abortado |
Payment.ReturnCode |
String | 3 | Sim | Código de erro/resposta da transação da Adquirência. |
Payment.ReturnMessage |
String | — | Sim | Mensagem de erro/resposta da transação da Adquirência. |
Payment.PaymentId |
String (Guid) | 36 | Sim | Código do Pagamento |
Payment.PaymentDateTime |
Datetime | - | Sim | Data do pagamento |
Payment.ServiceTaxAmount |
Decimal | - | Não | Taxa de serviço |
Payment.AuthorizationCode |
String | - | Sim | Cõdigo da autorização |
Payment.ProofOfSale |
String | - | Sim | NSU |
Payment.SubordinatedMerchantId |
Guid | 36 | — | Identificador da loja subordinada. |
Payment.OfflinePaymentType |
String | - | Não | Tipo de pagamento. |
Payment.MerchantAcquirerId |
String | - | Não | Identificador da loja. |
Payment.TerminalAcquirerId |
String | - | Não | Terminal da loja. |
Payment.Currency |
String | 3 | Sim | Moeda. |
Payment.Country |
String | 3 | Sim | Pais. |
Payment.IsSplitted |
Booleano | - | Não | Indica se o pagamento tem split ou não. Default: false. |
Payment.CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
Payment.CreditCard.InputMode |
String | — | Sim | Enum: Typed, MagStripe, Emv, ContactlessEmv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.CreditCard.TrackOneData |
String | — | Sim | Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.CreditCard.TrackTwoData |
String | — | Não | Dados da trilha 2 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.CreditCard.PinBlock.EncryptedPinBlock |
String | — | Sim | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
Payment.CreditCard.PinBlock.EncryptionType |
String | — | Sim | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
Payment.CreditCard.PinBlock.KsnIdentification |
String | — | Sim | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
Payment.CreditCard.BrandInformation.Type |
String | — | Sim | Tipo da bandeira |
Payment.CreditCard.BrandInformation.Name |
String | — | Sim | Nome da bandeira |
Payment.CreditCard.BrandInformation.Description |
String | — | Sim | Descrição da bandeira |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Payment.Receipt.MerchantName |
String | — | Sim | Nome da loja |
Payment.Receipt.MerchantAddress |
String | — | Sim | Endereço da loja |
Payment.Receipt.MerchantCity |
String | — | Sim | Cidade da loja |
Payment.Receipt.MerchantState |
String | — | Sim | Estado da loja |
Payment.Receipt.MerchantCode |
String | — | Sim | Codigo de identificação da loja |
Payment.Receipt.Terminal |
String | 8 | Sim | Identificação do Terminal |
Payment.Receipt.Nsu |
String | — | Sim | Numero de identificação da transação Cielo |
Payment.Receipt.Date |
String | — | Sim | Data da transação |
Payment.Receipt.Hour |
String | — | Sim | Horario da transação |
Payment.Receipt.IssuerName |
String | — | Sim | Nome do emissor obtido através do campo IssuerId no objeto BinEntry. |
Payment.Receipt.CardHolder |
String | — | Não | Nome do titular do cartão. |
Payment.Receipt.CardNumber |
String | — | Sim | Número do cartão |
Payment.Receipt.Brand |
String | — | Sim | Bandeira do cartão |
Payment.Receipt.TransactionType |
String | — | Sim | Tipo de transação |
Payment.Receipt.AuthorizationCode |
String | — | Sim | Código da autorização |
Payment.Receipt.TransactionMode |
String | — | Sim | Modo da transação |
Payment.Receipt.InputMethod |
String | — | Sim | Metodo de entrada |
Payment.Receipt.Value |
String | — | Sim | Valor do pagamento |
Payment.Receipt.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.Links |
Array[Object] | - | Não | links de navegação. |
Payment.Links.Method |
String | - | Sim | Metodo do link de navegação. |
Payment.Links.Rel |
String | - | Sim | Links de retorno para navegação. |
Payment.Links.Href |
String | - | Sim | Endereço do links de navegação. |
Payment.PrintMessage |
Array[Object] | - | Não | Dados para impressão. |
Payment.PrintMessage.Position |
String | - | Sim | Posição para impressão. |
Payment.PrintMessage.Message |
String | - | Sim | Mensagem para impressão. |
Payment.ReceiptInformation |
Array[Object] | - | Não | Dados do recibo. |
Payment.ReceiptInformation.Field |
String | - | Sim | Nome do campo do recibo. |
Payment.ReceiptInformation.Label |
String | - | Sim | Titulo do campo do recibo. |
Payment.ReceiptInformation.Content |
String | - | Sim | conteúdo do campo do recibo. |
Débito por tarja e senha
Requisição
{
"MerchantOrderId": "1596226820548",
"Payment": {
"Type": "PhysicalDebitCard",
"SoftDescriptor": "Transação API",
"PaymentDateTime": "2020-01-08T11:00:00",
"Amount": 100,
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"ProductId": 2,
"DebitCard": {
"ExpirationDate": "12/2020",
"SecurityCodeStatus": "Nonexistent",
"BrandId": 1,
"IssuerId": 2,
"InputMode": "MagStripe",
"AuthenticationMethod": "OnlineAuthentication",
"TrackOneData": "A1234567890123456^FULANO OLIVEIRA SA ^12345678901234567890123",
"TrackTwoData": "0123456789012345=012345678901234",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"PhysicalCharacteristics": "PinPadWithChipReaderWithoutSamAndContactless",
"ReturnDataInfo": "00",
"SerialNumber": "0820471929",
"TerminalId": "12345678"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.DebitCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.DebitCard.SecurityCodeStatus |
String | - | Sim | Sim Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.DebitCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.DebitCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
Payment.DebitCard.InputMode |
String | — | Sim | Enum: Typed, MagStripe, Emv,ContactlessEmv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.DebitCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.DebitCard.TrackOneData |
String | — | Sim | Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.DebitCard.TrackTwoData |
String | — | Não | Dados da trilha 2 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.DebitCard.PinBlock.EncryptedPinBlock |
String | — | Sim | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
Payment.DebitCard.PinBlock.EncryptionType |
String | — | Sim | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
Payment.DebitCard.PinBlock.KsnIdentification |
String | — | Sim | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "1633353893294",
"Customer": {
"Name": "[Guest]"
},
"Payment": {
"DebitCard": {
"ExpirationDate": "07/2007",
"SecurityCodeStatus": "Nonexistent",
"BrandId": 1,
"IssuerId": 1001,
"TruncateCardNumberWhenPrinting": false,
"InputMode": "MagStripe",
"AuthenticationMethod": "OnlineAuthentication",
"TrackOneData": "C4984108238141017^TESTE CO ROMEU ^99995012693100184000000",
"TrackTwoData": "*************************************",
"IsFallback": false,
"BrandInformation": {
"Type": "VENDA A DEBITO",
"Name": "VISA"
},
"SaveCard": false
},
"Amount": 700,
"ReceivedDate": "2021-10-04T13:24:53Z",
"CapturedAmount": 700,
"CapturedDate": "2021-10-04T13:24:54Z",
"Provider": "Cielo",
"Status": 2,
"IsSplitted": false,
"ReturnMessage": "APROVADA 334564",
"ReturnCode": "000",
"PaymentId": "5949fcce-e773-4bbc-af88-06aef78280c5",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/5949fcce-e773-4bbc-af88-06aef78280c5"
},
{
"Method": "PUT",
"Rel": "confirm",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/5949fcce-e773-4bbc-af88-06aef78280c5/confirmation"
},
{
"Method": "DELETE",
"Rel": "reverse",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/5949fcce-e773-4bbc-af88-06aef78280c5"
}
],
"PaymentDateTime": "2021-10-04T10:24:54.213Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 2,
"PinPadInformation": {
"TerminalId": "00000001",
"SerialNumber": "6C651996",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModuleAndContactless",
"ReturnDataInfo": "00"
},
"PrintMessage": [],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Braspag Testes"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Alameda Xingu, 512"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "BARUERI"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "SP"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": "0010255016990001"
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": "42001000"
},
{
"Field": "NSU",
"Label": "DOC",
"Content": "677541"
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "04/10/21"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "10:24"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "CIELO#VISA CREDITO"
},
{
"Field": "CARD_HOLDER",
"Label": "NOME DO CLIENTE",
"Content": "TESTE CO ROMEU "
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": "498410-1017"
},
{
"Field": "BRAND",
"Label": "BANDEIRA",
"Content": "VISA"
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A DEBITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": "334564"
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "D"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "7,00"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Description"
}
],
"Receipt": {
"MerchantName": "Braspag Testes",
"MerchantAddress": "Alameda Xingu, 512",
"MerchantCity": "BARUERI",
"MerchantState": "SP",
"MerchantCode": "0010255016990001",
"Terminal": "42001000",
"Nsu": "677541",
"Date": "04/10/21",
"Hour": "10:24",
"IssuerName": "CIELO#VISA CREDITO",
"CardHolder": "TESTE CO ROMEU ",
"CardNumber": "498410-1017",
"Brand": "VISA",
"TransactionType": "VENDA A DEBITO",
"AuthorizationCode": "334564",
"TransactionMode": "ONL",
"InputMethod": "D",
"Value": "7,00",
"SoftDescriptor": "Description"
},
"AuthorizationCode": "334564",
"ProofOfSale": "677541",
"InitializationVersion": 0,
"ConfirmationStatus": 0,
"SubordinatedMerchantId": "b99a463f-88db-442a-b5fa-982187b68f5c",
"OfflinePaymentType": "Online",
"MerchantAcquirerId": "0010255016990001",
"TerminalAcquirerId": "42001000"
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Customer.Name |
String | 255 | Não | Nome do comprador |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.DebitCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.DebitCard.SecurityCodeStatus |
String | - | Sim | Sim Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.DebitCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.DebitCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
Payment.DebitCard.InputMode |
String | — | Sim | Enum: Typed, MagStripe, Emv, ContactlessEmv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.DebitCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.DebitCard.TrackOneData |
String | — | Sim | Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.DebitCard.TrackTwoData |
String | — | Não | Dados da trilha 2 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.DebitCard.PinBlock.EncryptedPinBlock |
String | — | Sim | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
Payment.DebitCard.PinBlock.EncryptionType |
String | — | Sim | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
Payment.DebitCard.PinBlock.KsnIdentification |
String | — | Sim | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
Payment.DebitCard.BrandInformation.Type |
String | — | Sim | Tipo da bandeira |
Payment.DebitCard.BrandInformation.Name |
String | — | Sim | Nome da bandeira |
Payment.DebitCard.BrandInformation.Description |
String | — | Sim | Descrição da bandeira |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Payment.ReceivedDate |
String (DateTime) | — | Sim | Data em que a transação foi recebida. Formato “AAAA-MM-DD HH:mm:SS” |
Payment.CapturedAmount |
Integer | 15 | Sim | Valor capturado, sem pontuação. 100 equivale a R$ 1,00 |
Payment.CapturedDate |
Datetime | Não | Data da captura do pagamento | |
Payment.Provider |
String | 15 | Sim | Nome do provedor do meio de pagamento |
Payment.InitializationVersion |
Integer int16 | — | Sim | Número de versão dos parametros baixados na inicialização do equipamento. |
Payment.ConfirmationStatus |
Integer | 2 | Não | Status da confirmação. 0 = Pendente 1 = Confirmado 2 = Desfeito |
Payment.Status |
Integer | 2 | Sim | Status da transação 0 = Não Finalizado 1 = Autorizado 2 = Pago 3 = Negado 10 = Cancelado 13 = Abortado |
Payment.ReturnCode |
String | 3 | Sim | Código de erro/resposta da transação da Adquirência. |
Payment.ReturnMessage |
String | — | Sim | Mensagem de erro/resposta da transação da Adquirência. |
Payment.PaymentId |
String (Guid) | 36 | Sim | Código do Pagamento |
Payment.PaymentDateTime |
Datetime | - | Sim | Data do pagamento |
Payment.ServiceTaxAmount |
Decimal | - | Não | Taxa de serviço |
Payment.AuthorizationCode |
String | - | Sim | Cõdigo da autorização |
Payment.ProofOfSale |
String | - | Sim | NSU |
Payment.SubordinatedMerchantId |
Guid | 36 | — | Identificador da loja subordinada. |
Payment.OfflinePaymentType |
String | - | Não | Tipo de pagamento. |
Payment.MerchantAcquirerId |
String | - | Não | Identificador da loja. |
Payment.TerminalAcquirerId |
String | - | Não | Terminal da loja. |
Payment.Currency |
String | 3 | Sim | Moeda. |
Payment.Country |
String | 3 | Sim | Pais. |
Payment.IsSplitted |
Booleano | - | Não | Indica se o pagamento tem split ou não. Default: false. |
Payment.Receipt.MerchantName |
String | — | Sim | Nome da loja |
Payment.Receipt.MerchantAddress |
String | — | Sim | Endereço da loja |
Payment.Receipt.MerchantCity |
String | — | Sim | Cidade da loja |
Payment.Receipt.MerchantState |
String | — | Sim | Estado da loja |
Payment.Receipt.MerchantCode |
String | — | Sim | Codigo de identificação da loja |
Payment.Receipt.Terminal |
String | 8 | Sim | Identificação do Terminal |
Payment.Receipt.Nsu |
String | — | Sim | Numero de identificação da transação Cielo |
Payment.Receipt.Date |
String | — | Sim | Data da transação |
Payment.Receipt.Hour |
String | — | Sim | Horario da transação |
Payment.Receipt.IssuerName |
String | — | Sim | Nome do emissor obtido através do campo IssuerId no objeto BinEntry. |
Payment.Receipt.CardHolder |
String | — | Não | Nome do titular do cartão. |
Payment.Receipt.CardNumber |
String | — | Sim | Número do cartão |
Payment.Receipt.Brand |
String | — | Sim | Bandeira do cartão |
Payment.Receipt.TransactionType |
String | — | Sim | Tipo de transação |
Payment.Receipt.AuthorizationCode |
String | — | Sim | Código da autorização |
Payment.Receipt.TransactionMode |
String | — | Sim | Modo da transação |
Payment.Receipt.InputMethod |
String | — | Sim | Metodo de entrada |
Payment.Receipt.Value |
String | — | Sim | Valor do pagamento |
Payment.Receipt.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.Links |
Array[Object] | - | Não | links de navegação. |
Payment.Links.Method |
String | - | Sim | Metodo do link de navegação. |
Payment.Links.Rel |
String | - | Sim | Links de retorno para navegação. |
Payment.Links.Href |
String | - | Sim | Endereço do links de navegação. |
Payment.PrintMessage |
Array[Object] | - | Não | Dados para impressão. |
Payment.PrintMessage.Position |
String | - | Sim | Posição para impressão. |
Payment.PrintMessage.Message |
String | - | Sim | Mensagem para impressão. |
Payment.ReceiptInformation |
Array[Object] | - | Não | Dados do recibo. |
Payment.ReceiptInformation.Field |
String | - | Sim | Nome do campo do recibo. |
Payment.ReceiptInformation.Label |
String | - | Sim | Titulo do campo do recibo. |
Payment.ReceiptInformation.Content |
String | - | Sim | conteúdo do campo do recibo. |
Débito por tarja com cartão criptografado
Requisição
{
"MerchantOrderId": "1596226820548",
"Payment": {
"Type": "PhysicalDebitCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2020-07-31T20:20:20.548Z",
"Amount": 700,
"ProductId": 2,
"DebitCard": {
"ExpirationDate": "",
"SecurityCodeStatus": "Nonexistent",
"BrandId": 1,
"IssuerId": 2501,
"InputMode": "MagStripe",
"AuthenticationMethod": "OnlineAuthentication",
"TrackOneData": "",
"TrackTwoData": "",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "fffff9999900522000d6"
},
"EncryptedCardData": {
"EncryptionType": "DUKPT3DES",
"TrackOneDataKSN": "KSNforTrackOneData",
"TrackTwoDataKSN": "KSNforTrackTwoData"
}
},
"PinPadInformation": {
"TerminalId": "12345678",
"SerialNumber": "6C651996",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModuleAndContactless",
"ReturnDataInfo": "00"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | 15 | Sim | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. |
Customer.Name |
String | 255 | Não | Nome do comprador |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
Payment.Capture |
Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.Installments |
Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore, MaximumNumberOfinstallmentsForSaleAndCDCQuery e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
Payment.Interest |
String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
Payment.DebitCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
Payment.DebitCard.SecurityCodeStatus |
String | - | Sim | Sim Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
Payment.DebitCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
Payment.DebitCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
Payment.DebitCard.InputMode |
String | — | Sim | Enum: Typed, MagStripe, Emv, ContactlessEmv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
Payment.DebitCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
Payment.DebitCard.TrackOneData |
String | — | Sim | Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.DebitCard.TrackTwoData |
String | — | Não | Dados da trilha 2 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
Payment.DebitCard.PinBlock.EncryptedPinBlock |
String | — | Sim | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
Payment.DebitCard.PinBlock.EncryptionType |
String | — | Sim | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
Payment.DebitCard.PinBlock.KsnIdentification |
String | — | Sim | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
Payment.DebitCard.BrandInformation.Type |
String | — | Sim | Tipo da bandeira |
Payment.DebitCard.BrandInformation.Name |
String | — | Sim | Nome da bandeira |
Payment.DebitCard.BrandInformation.Description |
String | — | Sim | Descrição da bandeira |
Payment.PinPadInformation.TerminalId |
String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
Payment.PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
Payment.PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
Payment.PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Payment.ReceivedDate |
String (DateTime) | — | Sim | Data em que a transação foi recebida. Formato “AAAA-MM-DD HH:mm:SS” |
Payment.CapturedAmount |
Integer | 15 | Sim | Valor capturado, sem pontuação. 100 equivale a R$ 1,00 |
Payment.CapturedDate |
Datetime | Não | Data da captura do pagamento | |
Payment.Provider |
String | 15 | Sim | Nome do provedor do meio de pagamento |
Payment.InitializationVersion |
Integer int16 | — | Sim | Número de versão dos parametros baixados na inicialização do equipamento. |
Payment.ConfirmationStatus |
Integer | 2 | Não | Status da confirmação. 0 = Pendente 1 = Confirmado 2 = Desfeito |
Payment.Status |
Integer | 2 | Sim | Status da transação 0 = Não Finalizado 1 = Autorizado 2 = Pago 3 = Negado 10 = Cancelado 13 = Abortado |
Payment.ReturnCode |
String | 3 | Sim | Código de erro/resposta da transação da Adquirência. |
Payment.ReturnMessage |
String | — | Sim | Mensagem de erro/resposta da transação da Adquirência. |
Payment.PaymentId |
String (Guid) | 36 | Sim | Código do Pagamento |
Payment.PaymentDateTime |
Datetime | - | Sim | Data do pagamento |
Payment.ServiceTaxAmount |
Decimal | - | Não | Taxa de serviço |
Payment.AuthorizationCode |
String | - | Sim | Cõdigo da autorização |
Payment.ProofOfSale |
String | - | Sim | NSU |
Payment.SubordinatedMerchantId |
Guid | 36 | — | Identificador da loja subordinada. |
Payment.OfflinePaymentType |
String | - | Não | Tipo de pagamento. |
Payment.MerchantAcquirerId |
String | - | Não | Identificador da loja. |
Payment.TerminalAcquirerId |
String | - | Não | Terminal da loja. |
Payment.Currency |
String | 3 | Sim | Moeda. |
Payment.Country |
String | 3 | Sim | Pais. |
Payment.IsSplitted |
Booleano | - | Não | Indica se o pagamento tem split ou não. Default: false. |
Payment.Receipt.MerchantName |
String | — | Sim | Nome da loja |
Payment.Receipt.MerchantAddress |
String | — | Sim | Endereço da loja |
Payment.Receipt.MerchantCity |
String | — | Sim | Cidade da loja |
Payment.Receipt.MerchantState |
String | — | Sim | Estado da loja |
Payment.Receipt.MerchantCode |
String | — | Sim | Codigo de identificação da loja |
Payment.Receipt.Terminal |
String | 8 | Sim | Identificação do Terminal |
Payment.Receipt.Nsu |
String | — | Sim | Numero de identificação da transação Cielo |
Payment.Receipt.Date |
String | — | Sim | Data da transação |
Payment.Receipt.Hour |
String | — | Sim | Horario da transação |
Payment.Receipt.IssuerName |
String | — | Sim | Nome do emissor obtido através do campo IssuerId no objeto BinEntry. |
Payment.Receipt.CardHolder |
String | — | Não | Nome do titular do cartão. |
Payment.Receipt.CardNumber |
String | — | Sim | Número do cartão |
Payment.Receipt.Brand |
String | — | Sim | Bandeira do cartão |
Payment.Receipt.TransactionType |
String | — | Sim | Tipo de transação |
Payment.Receipt.AuthorizationCode |
String | — | Sim | Código da autorização |
Payment.Receipt.TransactionMode |
String | — | Sim | Modo da transação |
Payment.Receipt.InputMethod |
String | — | Sim | Metodo de entrada |
Payment.Receipt.Value |
String | — | Sim | Valor do pagamento |
Payment.Receipt.SoftDescriptor |
String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.Links |
Array[Object] | - | Não | links de navegação. |
Payment.Links.Method |
String | - | Sim | Metodo do link de navegação. |
Payment.Links.Rel |
String | - | Sim | Links de retorno para navegação. |
Payment.Links.Href |
String | - | Sim | Endereço do links de navegação. |
Payment.PrintMessage |
Array[Object] | - | Não | Dados para impressão. |
Payment.PrintMessage.Position |
String | - | Sim | Posição para impressão. |
Payment.PrintMessage.Message |
String | - | Sim | Mensagem para impressão. |
Payment.ReceiptInformation |
Array[Object] | - | Não | Dados do recibo. |
Payment.ReceiptInformation.Field |
String | - | Sim | Nome do campo do recibo. |
Payment.ReceiptInformation.Label |
String | - | Sim | Titulo do campo do recibo. |
Payment.ReceiptInformation.Content |
String | - | Sim | conteúdo do campo do recibo. |
Resposta
{
"MerchantOrderId": "1633353893294",
"Customer": {
"Name": "[Guest]"
},
"Payment": {
"DebitCard": {
"ExpirationDate": "07/2007",
"SecurityCodeStatus": "Nonexistent",
"BrandId": 1,
"IssuerId": 1001,
"TruncateCardNumberWhenPrinting": false,
"InputMode": "MagStripe",
"AuthenticationMethod": "NoPassword",
"TrackOneData": "C4984108238141017^TESTE CO ROMEU ^99995012693100184000000",
"TrackTwoData": "*************************************",
"IsFallback": false,
"BrandInformation": {
"Type": "VENDA A DEBITO",
"Name": "VISA"
},
"EncryptedCardData": {
"EncryptionType": "DUKPT3DES",
"TrackOneDataKSN": "KSNforTrackOneData",
"TrackTwoDataKSN": "KSNforTrackTwoData"
},
"SaveCard": false
},
"Amount": 700,
"ReceivedDate": "2021-10-04T13:24:53Z",
"CapturedAmount": 700,
"CapturedDate": "2021-10-04T13:24:54Z",
"Provider": "Cielo",
"Status": 2,
"IsSplitted": false,
"ReturnMessage": "APROVADA 334564",
"ReturnCode": "000",
"PaymentId": "5949fcce-e773-4bbc-af88-06aef78280c5",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/5949fcce-e773-4bbc-af88-06aef78280c5"
},
{
"Method": "PUT",
"Rel": "confirm",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/5949fcce-e773-4bbc-af88-06aef78280c5/confirmation"
},
{
"Method": "DELETE",
"Rel": "reverse",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/5949fcce-e773-4bbc-af88-06aef78280c5"
}
],
"PaymentDateTime": "2021-10-04T10:24:54.213Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 2,
"PinPadInformation": {
"TerminalId": "00000001",
"SerialNumber": "6C651996",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModuleAndContactless",
"ReturnDataInfo": "00"
},
"PrintMessage": [],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Braspag Testes"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Alameda Xingu, 512"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "BARUERI"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "SP"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": "0010255016990001"
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": "42001000"
},
{
"Field": "NSU",
"Label": "DOC",
"Content": "677541"
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "04/10/21"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "10:24"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "CIELO#VISA CREDITO"
},
{
"Field": "CARD_HOLDER",
"Label": "NOME DO CLIENTE",
"Content": "TESTE CO ROMEU "
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": "498410-1017"
},
{
"Field": "BRAND",
"Label": "BANDEIRA",
"Content": "VISA"
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A DEBITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": "334564"
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "D"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "7,00"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Description"
}
],
"Receipt": {
"MerchantName": "Braspag Testes",
"MerchantAddress": "Alameda Xingu, 512",
"MerchantCity": "BARUERI",
"MerchantState": "SP",
"MerchantCode": "0010255016990001",
"Terminal": "42001000",
"Nsu": "677541",
"Date": "04/10/21",
"Hour": "10:24",
"IssuerName": "CIELO#VISA CREDITO",
"CardHolder": "TESTE CO ROMEU ",
"CardNumber": "498410-1017",
"Brand": "VISA",
"TransactionType": "VENDA A DEBITO",
"AuthorizationCode": "334564",
"TransactionMode": "ONL",
"InputMethod": "D",
"Value": "7,00",
"SoftDescriptor": "Description"
},
"AuthorizationCode": "334564",
"ProofOfSale": "677541",
"InitializationVersion": 0,
"ConfirmationStatus": 0,
"SubordinatedMerchantId": "b99a463f-88db-442a-b5fa-982187b68f5c",
"OfflinePaymentType": "Online",
"MerchantAcquirerId": "0010255016990001",
"TerminalAcquirerId": "42001000"
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição | |
---|---|---|---|---|---|
MerchantOrderId |
String | — | — | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. Aceita apenas valores numéricos de 1 a 15 dígitos. | |
Customer.Name |
String | — | — | — | |
Customer.Identity |
— | — | — | — | |
Customer.IdentityType |
— | — | — | — | |
Customer.Email |
— | — | — | — | |
Customer.Birthday |
— | — | — | — | |
Address.Street |
String | — | — | — | |
Address.Number |
String | — | — | — | |
Address.Complement |
String | — | — | — | |
Address.ZipCode |
String | — | — | — | |
Address.City |
String | — | — | — | |
Address.State |
String | — | — | — | |
Address.Country |
String | — | — | — | |
DeliveryAddress.Street |
String | — | — | — | |
DeliveryAddress.Number |
String | — | — | — | |
DeliveryAddress.Complement |
String | — | — | — | |
DeliveryAddress.ZipCode |
String | — | — | — | |
DeliveryAddress.City |
String | — | — | — | |
DeliveryAddress.State |
String | — | — | — | |
DeliveryAddress.Country |
String | — | — | — | |
Payment.Installments |
Integer | — | — | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos maxOfPayments1, maxOfPayments2, maxOfPayments3 e minValOfPayments da tabela productTable. | |
Payment.Interest |
String | — | — | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
|
Payment.Capture |
Booleano | — | — | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. | |
DebitCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
|
DebitCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. | |
DebitCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. | |
DebitCard.TruncateCardNumberWhenPrinting |
Booleano | — | — | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no confParamOp03 presente nas tabelas BIN TABLE, PARAMETER TABLE e ISSUER TABLE. |
|
CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv, ContactlessEmv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja |
“06” - EMV sem contato. |
CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
|
CreditCard.EmvData |
String | — | — | Dados da transação EMV Obtidos através do comando PP_GoOnChip na BC. |
|
PinBlock.EncryptedPinBlock |
— | — | — | — | |
PinBlock.EncryptionType |
String | — | — | — | |
PinBlock.KsnIdentification |
String | — | — | — | |
CreditCard.PanSequenceNumber |
Number | — | — | Número sequencial do cartão, utilizado para identificar a conta corrente do cartão adicional. Mandatório para transações com cartões Chip EMV e que possuam PAN Sequence Number (Tag 5F34). | |
CreditCard.SaveCard |
— | — | — | — | |
CreditCard.IsFallback |
— | — | — | — | |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação | |
Payment.ServiceTaxAmount |
— | — | — | — | |
Payment.SoftDescriptor |
String | 13 | — | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. | |
Payment.ProductId|Integer |
— | Sim | Código do produto identificado através do bin do cartão. | ||
PinPadInformation.TerminalId |
String | — | Sim | Número Lógico definido no Concentrador Cielo. | |
PinPadInformation.PhysicalCharacteristics |
String | - | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad ; PIN-pad sem leitor de Chip = PinpadWithoutChipReader ; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule ; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule ; PIN-pad não homologado = NotCertifiedPinPad ; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless ; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless . Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
|
PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. | |
PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada | |
Payment.Amount|Integer |
(int64) | — | Sim | Valor da transação (1079 = R$10,79) | |
Payment.ReceivedDate |
— | — | — | — | |
Payment.CapturedAmount |
— | — | — | — | |
Payment.Provider |
String | — | — | — | |
Payment.ConfirmationStatus |
— | — | — | — | |
Payment.InitializationVersion |
— | — | — | — | |
Payment.EmvResponseData |
— | — | — | — | |
Payment.Status |
— | — | — | — | |
Payment.IsSplitted |
Booleano | — | — | — | |
Payment.ReturnCode |
— | — | — | — | |
Payment.ReturnMessage |
String | — | — | — | |
Payment.PaymentId |
— | — | — | — | |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação | |
Payment.Currency |
String | — | — | Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”) | |
Payment.Country |
String | — | — | Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”) | |
Receipt.MerchantName |
— | — | — | — | |
Receipt.MerchantAddress |
— | — | — | — | |
Receipt.MerchantCity |
— | — | — | — | |
Receipt.MerchantState |
— | — | — | — | |
Receipt.MerchantCode |
— | — | — | — | |
Receipt.Terminal |
— | — | — | — | |
Receipt.Nsu |
— | — | — | — | |
Receipt.Date |
— | — | — | — | |
Receipt.Hour |
— | — | — | — | |
Receipt.IssuerName |
— | — | — | — | |
Receipt.CardNumber |
— | — | — | — | |
Receipt.TransactionType |
— | — | — | — | |
Receipt.AuthorizationCode |
— | — | — | — | |
Receipt.TransactionMode |
— | — | — | — | |
Receipt.InputMethod |
— | — | — | — | |
Receipt.Value |
— | — | — | — | |
Receipt.SoftDescriptor |
— | — | — | — | |
RecurrentPayment.RecurrentPaymentId |
— | — | — | — | |
RecurrentPayment.ReasonCode |
— | — | — | — | |
RecurrentPayment.ReasonMessage |
— | — | — | — | |
RecurrentPayment.NextRecurrency |
— | — | — | — | |
RecurrentPayment.EndDate |
— | — | — | — | |
RecurrentPayment.Interval |
— | — | — | — | |
SplitPayments.SubordinateMerchantId |
— | — | — | — | |
SplitPayments.Amount |
— | — | — | — | |
SplitPayments.Fares.Mdr |
— | — | — | — | |
SplitPayments.Fares.Fee |
— | — | — | — | |
SplitErrors.Code |
— | — | — | — | |
SplitErrors.Message |
— | — | — | — |
Crédito por chip com senha online
Requisição
{
"MerchantOrderId": "201904150004",
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"ProductId": 1,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Emv",
"AuthenticationMethod": "OnlinePassword",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
}
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | — | — | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. Aceita apenas valores numéricos de 1 a 15 dígitos. |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.SoftDescriptor |
String | 13 | — | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.Amount |
Integer(int64) | — | Sim | Valor da transação (1079 = R$10,79) |
Payment.Installments |
Integer | — | — | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos maxOfPayments1, maxOfPayments2, maxOfPayments3 e minValOfPayments da tabela productTable. |
Payment.Interest |
String | — | — | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.Capture |
Booleano | — | — | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
CreditCard.EmvData |
String | — | — | Dados da transação EMV Obtidos através do comando PP_GoOnChip na BC |
PinBlock.EncryptedPinBlock |
String | — | Sim | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
PinBlock.EncryptionType |
String | — | Sim | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
PinBlock.KsnIdentification |
String | — | Sim | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
CreditCard.PanSequenceNumber |
Number | — | — | Número sequencial do cartão, utilizado para identificar a conta corrente do cartão adicional. Mandatório para transações com cartões Chip EMV e que possuam PAN Sequence Number (Tag 5F34). |
CreditCard.SaveCard |
Booleano | — | — | Identifica se vai salvar/tokenizar o cartão. |
CreditCard.IsFallback |
Booleano | — | — | Identifica se é uma transação de fallback. |
PinPadInformation.TerminalId |
String | — | Sim | Número Lógico definido no Concentrador Cielo. |
PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad ; PIN-pad sem leitor de Chip = PinpadWithoutChipReader ; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule ; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule ; PIN-pad não homologado = NotCertifiedPinPad ; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless ; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless . Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "20180204",
"Customer": {
"Name": "Comprador crédito completo",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "compradorteste@teste.com",
"Birthday": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
}
},
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PaymentDateTime": "2019-04-15T12:00:00Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00"
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"Provider": "Cielo",
"ConfirmationStatus": 0,
"InitializationVersion": 1558708320029,
"EmvResponseData": "123456789ABCD1345DEA",
"Status": 2,
"IsSplitted": false,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
},
"RecurrentPayment": {
"RecurrentPaymentId": "a6b719fa-a8df-ab11-4e1a-f4e50d5bd702",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"NextRecurrency": "2019-12-01",
"EndDate": "2019-12-01",
"Interval": 6
},
"SplitPayments": [
{
"SubordinateMerchantId": "491daf20-35f2-4379-874c-e7552ae8dc10",
"Amount": 100,
"Fares": {
"Mdr": 5,
"Fee": 0
}
},
{
"SubordinateMerchantId": "7e2846be-4e80-4f86-8ca9-eb35db6aea00",
"Amount": 80,
"Fares": {
"Mdr": 3,
"Fee": 1
}
}
],
"SplitErrors": [
{
"Code": 326,
"Message": "SubordinatePayment amount must be greater than zero"
}
]
}
}
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
MerchantOrderId |
String | — | — | Número do documento gerado automaticamente pelo terminal e incrementado de 1 a cada transação realizada no terminal. Aceita apenas valores numéricos de 1 a 15 dígitos. |
Customer.Name |
String | — | — | — |
Customer.Identity |
— | — | — | — |
Customer.IdentityType |
— | — | — | — |
Customer.Email |
— | — | — | — |
Customer.Birthday |
— | — | — | — |
Address.Street |
String | — | — | — |
Address.Number |
String | — | — | — |
Address.Complement |
String | — | — | — |
Address.ZipCode |
String | — | — | — |
Address.City |
String | — | — | — |
Address.State |
String | — | — | — |
Address.Country |
String | — | — | — |
DeliveryAddress.Street |
String | — | — | — |
DeliveryAddress.Number |
String | — | — | — |
DeliveryAddress.Complement |
String | — | — | — |
DeliveryAddress.ZipCode |
String | — | — | — |
DeliveryAddress.City |
String | — | — | — |
DeliveryAddress.State |
String | — | — | — |
DeliveryAddress.Country |
String | — | — | — |
Payment.Installments |
Integer | — | — | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos maxOfPayments1, maxOfPayments2, maxOfPayments3 e minValOfPayments da tabela productTable. |
Payment.Interest |
String | — | — | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
Payment.Capture |
Booleano | — | — | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
CreditCard.ExpirationDate |
String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
CreditCard.BrandId |
Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
CreditCard.IssuerId |
Integer | — | Sim | Código do emissor obtido através do campo IssuerId da BIN TABLE. |
CreditCard.TruncateCardNumberWhenPrinting |
Booleano | — | — | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no confParamOp03 presente nas tabelas BIN TABLE, PARAMETER TABLE e ISSUER TABLE. |
CreditCard.InputMode |
String | — | Sim | Enum: Typed MagStripe Emv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
CreditCard.AuthenticationMethod |
String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
CreditCard.EmvData |
String | — | — | Dados da transação EMV Obtidos através do comando PP_GoOnChip na BC |
PinBlock.EncryptedPinBlock |
String | — | Sim | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
PinBlock.EncryptionType |
String | — | Sim | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
PinBlock.KsnIdentification |
String | — | Sim | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
CreditCard.PanSequenceNumber |
Number | — | — | Número sequencial do cartão, utilizado para identificar a conta corrente do cartão adicional. Mandatório para transações com cartões Chip EMV e que possuam PAN Sequence Number (Tag 5F34). |
CreditCard.SaveCard |
Booleano | — | — | Identifica se vai salvar/tokenizar o cartão. |
CreditCard.IsFallback |
Booleano | — | — | Identifica se é uma transação de fallback. |
Payment.PaymentDateTime |
String | date-time | Sim | Data e Hora da captura da transação |
Payment.ServiceTaxAmount |
— | — | — | — |
Payment.SoftDescriptor |
String | 13 | — | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
Payment.ProductId |
Integer | — | Sim | Código do produto identificado através do bin do cartão. |
PinPadInformation.TerminalId |
String | — | Sim | Número Lógico definido no Concentrador Cielo. |
PinPadInformation.SerialNumber |
String | — | Sim | Número de Série do Equipamento. |
PinPadInformation.PhysicalCharacteristics |
String | — | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad ; PIN-pad sem leitor de Chip = PinpadWithoutChipReader ; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule ; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule ; PIN-pad não homologado = NotCertifiedPinPad ; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless ; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless . Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
PinPadInformation.ReturnDataInfo |
String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Payment.Amount |
Integer(int64) | — | Sim | Valor da transação (1079 = R$10,79) |
Payment.ReceivedDate |
— | — | — | — |
Payment.CapturedAmount |
— | — | — | — |
Payment.Provider |
String | — | — | — |
Payment.ConfirmationStatus |
— | — | — | — |
Payment.InitializationVersion |
— | — | — | — |
Payment.EmvResponseData |
— | — | — | — |
Payment.Status |
— | — | — | — |
Payment.IsSplitted |
Booleano | — | — | — |
Payment.ReturnCode |
— | — | — | — |
Payment.ReturnMessage |
String | — | — | — |
Payment.PaymentId |
— | — | — | — |
Payment.Type |
String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
Payment.Currency |
String | — | — | Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”) |
Payment.Country |
String | — | — | Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”) |
Receipt.MerchantName |
— | — | — | — |
Receipt.MerchantAddress |
— | — | — | — |
Receipt.MerchantCity |
— | — | — | — |
Receipt.MerchantState |
— | — | — | — |
Receipt.MerchantCode |
— | — | — | — |
Receipt.Terminal |
— | — | — | — |
Receipt.Nsu |
— | — | — | — |
Receipt.Date |
— | — | — | — |
Receipt.Hour |
— | — | — | — |
Receipt.IssuerName |
— | — | — | — |
Receipt.CardNumber |
— | — | — | — |
Receipt.TransactionType |
— | — | — | — |
Receipt.AuthorizationCode |
— | — | — | — |
Receipt.TransactionMode |
— | — | — | — |
Receipt.InputMethod |
— | — | — | — |
Receipt.Value |
— | — | — | — |
Receipt.SoftDescriptor |
— | — | — | — |
RecurrentPayment.RecurrentPaymentId |
— | — | — | — |
RecurrentPayment.ReasonCode |
— | — | — | — |
RecurrentPayment.ReasonMessage |
— | — | — | — |
RecurrentPayment.NextRecurrency |
— | — | — | — |
RecurrentPayment.EndDate |
— | — | — | — |
RecurrentPayment.Interval |
— | — | — | — |
SplitPayments.SubordinateMerchantId |
— | — | — | — |
SplitPayments.Amount |
— | — | — | — |
SplitPayments.Fares.Mdr |
— | — | — | — |
SplitPayments.Fares.Fee |
— | — | — | — |
SplitErrors.Code |
— | — | — | — |
SplitErrors.Message |
— | — | — | — |
Crédito por chip com envio da baixa tecnica
Requisição
{
"MerchantOrderId": "1596226820548",
"Payment": {
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"ProductId": 1,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"TrackTwoData": "0123456789012345=012345678901234",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadW