Criar transação de débito

ℹ️
As características de uma transação de débito são:

Envie o Payment.Type como "SplittedDebitCard";

O nó Payment.FraudAnalysis não deve ser informado, pois a transação não necessita de análise de fraude;

É obrigatório submeter a transação de débito à autenticação. Por isso, envie o nó Payment.ExternalAuthentication com os dados recebidos durante o processo de autenticação 3DS. Para saber mais sobre a integração 3DS, acesse o Manual de Autenticação 3DS.

Requisição

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales`
Produção	post	`https://api.cieloecommerce.cielo.com.br/1/sales`

--header "Authorization: Bearer {access_token}"

{
  "MerchantOrderId": "202301131052",
  "Customer": {
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    },
    "Name": "Aline de Souza",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "[email protected]",
    "Birthdate": "1990-01-01"
  },
  "Payment": {
    "Type": "SplittedDebitCard",
    "Amount": 15700,
    "DoSplit": "true",
    "Capture": "true",
    "Authenticate": "true",
    "IssuerTransactionId": "580027442382078",
    "DebitCard": {
      "CardOnFile": {
        "Usage": "Used",
        "Reason": "Unscheduled"
      },
      "CardNumber": "5200000000002151",
      "Holder": "Aline De Souza",
      "ExpirationDate": "03/2031",
      "SaveCard": "false",
      "SecurityCode": "079",
      "Brand": "Master"
    },
    "InitiatedTransactionIndicator": {
      "Category": "C1",
      "Subcategory": "Standingorder"
    },
    "ExternalAuthentication": {
      "Eci": 5,
      "Cavv": "AAABB2gHA1B5EFNjWQcDAAAAAAB=",
      "ReferenceID": "a24a5d87-b1a1-4aef-a37b-2f30b91274e6",
      "Xid": "Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
      "Version": "2.2.0"
    },
    "SoftDescriptor": "LojaTeste",
    "Tip": false,
    "IsCryptocurrencyNegotiation": false
  },
  "SplitPayments": [
    {
      "subordinatemerchantid": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
      "amount": 6000,
      "fares": {
        "mdr": 20,
        "fee": 25
      }
    },
    {
      "subordinatemerchantid": "9140ca78-3955-44a5-bd44-793370afef94",
      "amount": 4000,
      "fares": {
        "mdr": 10,
        "fee": 15
      }
    }
  ]
}

Parâmetros no header:

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
Authorization Bearer:`access_token`	String	--	Sim	Token de acesso. Informe o `access_token` obtido para a autenticação OAuth2

Parâmetros no body:

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`MerchantOrderId`	Texto	50	Sim	Identificação do pedido. Poderá ser usada para cancelar ou consultar a transação no futuro. Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco.
`Customer.Name`	Texto	255	Sim	Nome do comprador. Atenção: Os caracteres permitidos são apenas a-z, A-Z. Não são permitidos caracteres especiais e números.
`Customer.Status`	Texto	--	Não	Status de cadastro do comprador na loja (NEW / EXISTING) - Utilizado pela análise de fraude
`Customer.Identity`	Texto	14	Não	Número do CPF ou CNPJ do comprador. Permite envio de CNPJs alfanuméricos.
`Customer.IdentityType`	Texto	255	Não	Tipo de documento de identificação do comprador (CPF/CNPJ).
`Customer.Email`	Texto	255	Não	E-mail do comprador.
`Customer.Birthdate`	Texto	10	Não	Data de nascimento do comprador (AAAA/MM/DD).
`Customer.Address.Street`	Texto	255	Não	Endereço do comprador.
`Customer.Address.Number`	Texto	15	Não	Número do endereço do comprador.
`Customer.Address.Complement`	Texto	50	Não	Complemento do endereço do comprador.
`Customer.Address.ZipCode`	Texto	9	Não	CEP do endereço do comprador.
`Customer.Address.City`	Texto	50	Não	Cidade do endereço do comprador.
`Customer.Address.State`	Texto	2	Não	Estado do endereço do comprador.
`Customer.Address.Country`	Texto	35	Não	País do endereço do comprador.
`Customer.DeliveryAddress.Street`	Texto	255	Não	Endereço do comprador.
`Customer.DeliveryAddress.Complement`	Texto	50	Não	Complemento do endereço do comprador.
`Customer.DeliveryAddress.ZipCode`	Texto	9	Não	CEP do endereço do comprador.
`Customer.DeliveryAddress.City`	Texto	50	Não	Cidade do endereço do comprador.
`Customer.DeliveryAddress.State`	Texto	2	Não	Estado do endereço do comprador.
`Customer.DeliveryAddress.Country`	Texto	35	Não	País do endereço do comprador.
`Payment.Type`	Texto	--	Sim	Tipo do meio de pagamento.
`Payment.Amount`	Número	15	Sim	Valor do pedido (ser enviado em centavos).
`Payment.SoftDescriptor`	Texto	13	Não	O complemento do nome da loja que aparecerá na fatura do cartão. Não permite caracteres especiais.
`Payment.Authenticate`	Booleano	--	Sim	Indica se a transação foi autenticada via 3DS antes da autorização.
`Payment.Tip`	Booleano	--	Não	As gorjetas são um tipo de transação que funcionam para cartão de crédito ou débito, tokenizados ou não. Se o valor for "true", a transação é identificada como gorjeta, caso contrário, o valor deverá ser "false".
`Payment.IsCryptocurrencyNegotiation`	Booleano	--	Não	Deve ser enviado com valor “true” caso se trate de uma transação de compra ou venda de Criptomoeda
`Payment.DebitCard.CardNumber`	Texto	19	Sim	Número do cartão do comprador.
`Payment.DebitCard.Holder`	Texto	25	Sim	Nome do comprador impresso no cartão.
`Payment.DebitCard.ExpirationDate`	Texto	7	Sim	Data de validade impresso no cartão.
`Payment.DebitCard.SecurityCode`	Texto	4	Não	Código de segurança impresso no verso do cartão.
`Payment.DebitCard.Brand`	Texto	10	Sim	Bandeira do cartão. Valores possíveis: Visa / Master / Elo.
`Payment.DebitCard.CardOnFile.Usage`	Texto	--	Não	"First" se o cartão foi armazenado e é seu primeiro uso. "Used" se o cartão foi armazenado e ele já foi utilizado anteriormente em outra transação. Saiba mais em Card On File.
`Payment.DebitCard.CardOnFile.Reason`	Texto	--	Não	Indica o propósito de armazenamento de cartões. Envio condicional - enviar somente se `CardOnFile.Usage` for "Used". Valores possíveis: - "Recurring": compra recorrente programada (ex. assinaturas). Se for transação recorrente, usar `Payment.Recurrent` = "true" (recorrência própria do estabelecimento) ou `Recurrent.Payment` = true (recorrência programada pela Cielo); - "Unscheduled": compra recorrente sem agendamento (ex. aplicativos de serviços); - "Installments": parcelamento através da recorrência. Saiba mais em Card On File.
`DoSplit`	Booleano	--	Sim	Indica se a transação será dividida entre vários participantes. Valores possíveis: true / false
`SplitPayments.SubordinateMerchantId`	Texto	36	Sim	Identificador (GUID) do seller na transação
`SplitPayments.Amount`	Número	15	Sim	Valor bruto da participação do seller na transação, em centavos. O desconto da taxa será calculado pelo Split
`SplitPayments.Fares.Mdr`	Texto	--	Sim	MDR(%) do master a ser descontado do valor referente à participação do seller
`SplitPayments.Fares.Fee`	Número	--	Sim	Tarifa Fixa(R$) a ser descontada do valor referente à participação do seller, em centavos
`Payment.InitiatedTransactionIndicator.Category`	Texto	2	Não	Obrigatório apenas para bandeira Mastercard. Categoria do indicador de início da transação. Válido apenas para bandeira Mastercard. Valores possíveis: - “C1”: transação inciada pelo portador do cartão; - “M1”: transação recorrente ou parcelada iniciada pela loja; - “M2”: transação iniciada pela loja. Tamanho: 2.
`Payment.InitiatedTransactionIndicator.Subcategory`	Número	--	Sim	Obrigatório apenas para a bandeira Mastercard. Subcategoria do indicador. Válido apenas para bandeira Mastercard. Valores possíveis: Se `InitiatedTransactionIndicator.Category` = "C1" ou "M1" CredentialsOnFile StandingOrder Subscription Installment Se `InitiatedTransactionIndicator.Category` = "M2" PartialShipment RelatedOrDelayedCharge NoShow Resubmission Consulte a tabela com a descrição das subcategorias em Indicador de início da transação Mastercard.
`Payment.ExternalAuthentication.Eci`	Número	2	Sim	Electronic Commerce Indicator retornado no processo de autenticação.
`Payment.ExternalAuthentication.ReferenceID`	Texto	36	Sim	RequestID retornado no processo de autenticação. - O `ReferenceId` não é retornado em todas as autenticações. - O envio é recomendado caso o `ReferenceId` tenha sido retornado no script.
`Payment.ExternalAuthentication.Cavv`	Texto	--	Sim	Assinatura 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.Xid`	Texto	--	Sim	XID retornado no processo de autenticação. - O `Xid` não é retornado em todas as autenticações. - O envio é recomendado caso o `Xid` tenha sido retornado no script.
`Payment.ExternalAuthentication.Version`	Texto	5	Sim	Campo 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.DataOnly`	Booleano	--	Não	Define se é uma transação com autenticação 3DS do tipo Data Only. O envio é obrigatório no caso de transação Data Only.
`Payment.IssuerTransactionId`	Texto	30	Não	Identificador da transação gerado pela bandeira. Deve ser enviado para referenciar a transação original/anterior em operações relacionadas, como em recorrências.

Resposta

{
  "MerchantOrderId": "202301131052",
  "Customer": {
    "Name": "Aline de Souza",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "[email protected]",
    "Birthdate": "1990-01-01",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "AddressType": 0
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "AddressType": 0
    }
  },
  "Payment": {
    "DebitCard": {
      "CardNumber": "520000******2151",
      "Holder": "Aline De Souza",
      "ExpirationDate": "03/2031",
      "SaveCard": false,
      "Brand": "Master",
      "CardOnFile": {
        "Usage": "Used",
        "Reason": "Unscheduled"
      },
      "PaymentAccountReference": "KB8KXNGEO8TBJCA2U4UKRW8HIJVF6"
    },
    "Provider": "Simulado",
    "AuthorizationCode": "759508",
    "SoftDescriptor": "LojaTeste",
    "Tid": "0813094314173",
    "ProofOfSale": "884376",
    "Authenticate": true,
    "ExternalAuthentication": {
      "Cavv": "AAABB2gHA1B5EFNjWQcDAAAAAAB=",
      "Xid": "Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
      "Eci": "5",
      "Version": "2.2.0",
      "ReferenceId": "a24a5d87-b1a1-4aef-a37b-2f30b91274e6"
    },
    "Recurrent": false,
    "InitiatedTransactionIndicator": {
      "Category": "C1",
      "Subcategory": "StandingOrder"
    },
    "Tip": false,
    "SentOrderId": "202301131052",
    "Amount": 15700,
    "ReceivedDate": "2026-08-13 09:43:13",
    "CapturedAmount": 15700,
    "CapturedDate": "2026-08-13 09:43:14",
    "Status": 2,
    "IsSplitted": true,
    "ReturnMessage": "Operation Successful",
    "ReturnCode": "6",
    "PaymentId": "ea55ad70-3e44-4997-9c89-26799080f3ff",
    "Type": "SplittedDebitCard",
    "Currency": "BRL",
    "Country": "BRA",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/ea55ad70-3e44-4997-9c89-26799080f3ff"
      }
    ],
    "IsCryptoCurrencyNegotiation": false,
    "SplitPayments": [
      {
        "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
        "Amount": 6000,
        "Fares": {
          "Mdr": 5.0,
          "Fee": 30
        },
        "Splits": [
          {
            "MerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
            "Amount": 5390
          },
          {
            "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
            "Amount": 280
          }
        ]
      },
      {
        "SubordinateMerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
        "Amount": 4000,
        "Fares": {
          "Mdr": 4.0,
          "Fee": 15
        },
        "Splits": [
          {
            "MerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
            "Amount": 3610
          },
          {
            "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
            "Amount": 215
          }
        ]
      }
    ]
  }
}