Criar transação de crédito sem o nó da divisão

⚠️

Para submeter uma transação do Gateway de Pagamentos ao Split de Pagamento, basta enviar o Parâmetro Payment.DoSplit como true e adicionar o nó Payment.SplitPayments.

ℹ️

As características de uma transação de crédito são:

Neste caso, o master recebe o valor da transação descontado o MDR acordado com o Split de Pagamento. A tarifa Fixa acordada entre o master e o Split de Pagamento é sensibilizada diretamente na agenda de ambas as partes.


Taxa Split de Pagamento: 2% MDR + R$0,10 Tarifa Fixa.

Master:

  • Crédito de R$98,00 (R$100,00 da transação menos R$2,00 de MDR do Split de Pagamento);
  • Débito de R$0,10 (Tarifa Fixa acordada com o Split de Pagamento).

O total a receber pelo master será R$97,90.

Split de Pagamento:

  • Crédito: R$2,10 (MDR aplicado sobre o valor total da transação mais R$0,10 (Tarifa Fixa acordada com o Master).

O total a receber pelo Split de Pagamento será R$2,10.

Veja a requisição dessa transação no valor de R$100,00, com captura automática, sem o nó contendo as regras de divisão.

ℹ️

CNPJs alfanuméricos serão implementados pela Receita Federal em julho de 2026

Essa mudança afeta apenas novas inscrições, não havendo mudanças em CNPJs existentes.

O CNPJ alfanumérico já está sendo suportado pela Cielo, sem mudanças na sua integração.

Recomendamos verificar a necessidade de possíveis ajustes nos sistemas próprios de checkout de sua loja.

TLID Mastercard

O Transaction Link Identifier (TLID), enviado e retornado no campo TransactionLinkId, é um identificador único gerado pela bandeira Mastercard durante uma transação CIT, usado para vincular as transações MIT relacionadas. O TLID vale para a resposta do VerifyCard (apenas resposta) e para as transações de crédito, débito e recorrência.

Na Mastercard, envie IssuerTransactionId e TransactionLinkId juntos nas transações MIT: os dois parâmetros são obrigatórios.

FaseDescrição
Fase 1Vigente. O campo TransactionLinkId está disponível na resposta da validação de cartão por VerifyCard, criação de pagamento com cartão de crédito, criação de pagamento com cartão de débito e na consulta por PaymentId.
Fase 2Envio obrigatório do TransactionLinkId no request (MIT) a partir de 23/10/2026.

Recorrência programada: nas transações seguintes, os campos IssuerTransactionId e TransactionLinkId são enviados automaticamente.

O TransactionLinkId enviado no request deve ter exatamente 22 caracteres (A-Z, a-z, 0-9, hífen e sublinhado). Se o valor estiver fora desse formato, a Cielo o ignora, sem retornar erro. Quando a Cielo envia o TLID à bandeira, a resposta traz também o SentTransactionLinkId, com o valor enviado. O request do VerifyCard não aceita o campo.

Saiba mais em Identificadores da bandeira para adquirente Cielo.

Requisição


{
    "merchantorderid": "30082019",
    "customer": {
        "Name": "Comprador Accept",
        "email": "[email protected]",
        "Identity": "18160361106",
        "identitytype": "CPF",
        "Mobile": "5521995760078"
    },
    "payment": {
        "Provider": "Simulado",
        "type": "Creditcard",
        "DoSplit": true,
        "amount": 10000,
        "capture": true,
        "installments": 1,
        "softdescriptor": "teste",
        "CreditCard": {
            "cardNumber": "4481530710186111",
            "holder": "Yamilet Taylor",
            "ExpirationDate": "12/2030",
            "SecurityCode": "693",
            "Brand": "Visa",
            "SaveCard": false
        }
    }
}

A seguir, veja as propriedades de campo nesta requisição:

Propriedade (Header)TipoTamanhoObrigatórioDescrição
MerchantIdGuid36SimIdentificador da loja no Split de Pagamento
MerchantKeyTexto40SimChave Publica para Autenticação Dupla no Split de Pagamento
Content-TypeHeader40SimApplication/json
PropriedadeTipoTamanhoObrigatórioDescrição
MerchantOrderIdTexto50SimNumero de identificação do Pedido
Customer.EmailTexto255NãoE-mail do comprador
Customer.NameTexto255SimNome do comprador
Customer.Identitystring14NãoNúmero do CPF ou CNPJ do Cliente
Permite envio de CNPJs alfanuméricos.
Customer.IdentityTypeTexto255NãoTipo de documento de identificação do comprador (CPF ou CNPJ)
Customer.MobileTexto14NãoCelular do comprador
Customer.PhoneTexto14NãoTelefone do comprador
Customer.DeliveryAddress.StreetTexto255NãoEndereço do comprador
Customer.DeliveryAddress.NumberTexto15NãoNúmero do endereço de entrega do pedido
Customer.DeliveryAddress.ComplementTexto50NãoComplemento do endereço de entrega do pedido
Customer.DeliveryAddress.ZipCodeTexto9NãoCEP do endereço de entrega do pedido
Customer.DeliveryAddress.CityTexto50NãoCidade do endereço do pedido
Customer.DeliveryAddress.StateTexto2NãoEstado do endereço do pedido
Customer.DeliveryAddress.CountryTexto35NãoPais do endereço de entrega do pedido
Customer.DeliveryAddress.DistrictTexto50NãoBairro do comprador.
Payment.ProviderTexto15SimNome do provedor de meio de pagamento. Valores possíveis:
  • Sandbox: Simulado

  • Produção: Cielo30

    Tamanho: 15.

Payment.TypeTexto100SimTipo do meio de pagamento. Para transação de cartão de crédito, use CreditCard. Tamanho: 100.
Payment.AmountNúmero15SimValor do pedido (ser enviado em centavos)
Payment.InstallmentsNúmero2SimNúmero de parcelas
Payment.CaptureBooleano
Não (Default false)Booleano que indica se a autorização deve ser com captura automática (true) ou não (false).
Payment.SoftDescriptorTexto13NãoTexto que será impresso na fatura do portador. Na fatura, o SoftDescriptor pode ser encurtado de acordo com as regras da adquirente e bandeira.
Payment.IssuerTransactionIdTexto30NãoIdentificador da transação gerado pela bandeira, retornado na transação CIT ou no VerifyCard. Envie nas transações MIT recorrentes, incrementais e reautorizadas. Envio obrigatório para as bandeiras Visa, Mastercard, Elo e Amex.
Payment.TransactionLinkIdTexto22NãoIdentificador único gerado pela bandeira Mastercard (TLID), usado para vincular a transação CIT a transações MIT subsequentes relacionadas, como recorrências, parcelas futuras, cobranças pós-autorizadas e pagamentos com cartão salvo (card-on-file). Envie o valor original, junto com o IssuerTransactionId: os dois são obrigatórios na Mastercard, e o envio do TransactionLinkId é obrigatório a partir de 23/10/2026.
Formato: 22 caracteres alfanuméricos (A-Z, a-z, com diferenciação entre maiúsculas e minúsculas), podendo incluir hífen (-) e underscore (_).
Se o valor for nulo, vazio ou estiver fora desse formato, a Cielo o ignora, sem retornar erro.
Payment.OriginalRecurrentAmountNúmero15NãoValor da transação original (primeira do ciclo), em centavos. Obrigatório na recorrência própria (Payment.Recurrent = true), junto com o IssuerTransactionId e, na Mastercard, o TransactionLinkId.
CreditCard.CardNumberTexto19SimNúmero do Cartão do comprador
CreditCard.HolderTexto25SimNome do portador impresso no cartão
CreditCard.ExpirationDateTexto7SimData de validade impresso no cartão
CreditCard.SecurityCodeTexto4SimCódigo de segurança impresso no verso do cartão
CreditCard.BrandTexto10SimBandeira do cartão de crédito. Valores aceitos: Visa, Master, Elo e Amex.
CreditCard.SaveCardBooleano
Não (Default false)Booleano que identifica se o cartão será salvo para gerar o token (CardToken)
Payment.ExternalAuthentication.CavvTexto--NãoAssinatura retornada nos cenários de sucesso na autenticação.
⚠️Este campo é obrigatório para transações que foram autenticadas pelo emissor ou pela bandeira e nas solicitações de autorizações com Data Only.
Payment.ExternalAuthentication.XidTexto28NãoCampo obrigatório somente quando a versão do 3DS for "2' ou superior.* XID retornado no processo de autenticação.
Payment.ExternalAuthentication.EciNúmero1NãoElectronic Commerce Indicator_ retornado no processo de autenticação.
Payment.ExternalAuthentication.VersionTexto5NãoCampo obrigatório para transações com autenticação 3DS*.
Versão do 3DS aplicado no processo de autenticação.
Valores possíveis:
- Visa e Mastercard: "2.2.0"
- Elo e Amex: "2.1.0"
Payment.ExternalAuthentication.ReferenceIdTexto36NãoCampo obrigatório somente quando a versão do 3DS for "2' ou superior.* RequestID retornado no processo de autenticação.
Payment.ExternalAuthentication.DataOnlyBooleano--NãoDefine se é uma transação com autenticação 3DS do tipo Data Only. O envio é obrigatório no caso de transação Data Only.

Resposta

{
    "MerchantOrderId": "30082019",
    "Customer": {
        "Name": "Comprador Accept",
        "Identity": "18160361106",
        "IdentityType": "CPF",
        "Email": "[email protected]",
        "Mobile": "5521995760078"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "IssuerTransactionId": "580027442382078",
        "CreditCard": {
            "CardNumber": "448153******6111",
            "Holder": "Yamilet Taylor",
            "ExpirationDate": "12/2030",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "ProofOfSale": "20190830104433081",
        "AcquirerTransactionId": "0830104433081",
        "AuthorizationCode": "042693",
        "SoftDescriptor": "teste",
        "DoSplit": true,
        "SplitPayments": [
            {
                "SubordinateMerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                "Amount": 10000,
                "Fares": {
                    "Mdr": 2.0,
                    "Fee": 10
                },
                "Splits": [
                    {
                        "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                        "Amount": 10000
                    }
                ]
            }
        ],
        "PaymentId": "5b01552e-bf38-430e-bd38-8517c36a1ca2",
        "Type": "CreditCard",
        "Amount": 10000,
        "ReceivedDate": "2019-08-30 10:44:13",
        "CapturedAmount": 10000,
        "CapturedDate": "2019-08-30 10:44:33",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 2,
        "ProviderReturnCode": "6",
        "ProviderReturnMessage": "Operation Successful",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/5b01552e-bf38-430e-bd38-8517c36a1ca2"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/5b01552e-bf38-430e-bd38-8517c36a1ca2/void"
            }
        ]
    }
}

A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na criação de um pagamento com cartão de crédito.

PropriedadeDescriçãoTipoTamanho
Payment.IssuerTransactionIdIdentificador da transação gerado pela bandeira e retornado na resposta da transação CIT. Armazene o valor para enviá-lo nas transações MIT seguintes: o envio é obrigatório, para todas as bandeiras, em transações recorrentes, incrementais e reautorizadas. Consulte mais informações em Identificadores da bandeira para adquirente Cielo.Texto30
Payment.TransactionLinkId

Identificador único (TLID) gerado pela Mastercard e retornado na resposta, usado para vincular a transação CIT às transações MIT seguintes. Na Mastercard, envie o TransactionLinkId original junto com o IssuerTransactionId: os dois são obrigatórios, e o envio do TransactionLinkId é obrigatório a partir de 23/10/2026. Consulte mais informações em Identificadores da bandeira para adquirente Cielo.

Formato: 22 caracteres alfanuméricos (A-Z, a-z), com diferenciação entre maiúsculas e minúsculas e podem incluir hífens (-) e sublinhados (_).

Texto22
Payment.SentTransactionLinkIdTLID que o estabelecimento enviou no request e que a Cielo repassou à bandeira. O campo só aparece quando a Cielo enviou o TLID. Consulte mais informações em Identificadores da bandeira para adquirente Cielo.Texto22