Criar transação de carnê

Cria uma transação de carnê

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.cieloecommerce.cielo.com.br/1/sales/
Produçãohttps://api.cieloecommerce.cielo.com.br/1/sales/

ℹ️


Saiba mais sobre essa funcionalidade na documentação.

O carnê é uma transação de débito utilizada para efetuar o pagamento de uma conta.

O carnê é um meio de pagamento válido para as bandeiras Mastercard, Visa e Elo.

Essa modalidade pode ser utilizada por lojistas que emitem carnês próprios e faturas de cartões Private Label. O produto carnê permite a separação das vendas relacionadas à compra de produtos e pagamento de serviços, facilitando reporte de valores junto ao Fisco.

Como qualquer transação de débito no e-commerce, as transações de carnê precisam ser autenticadas via protocolo 3DS 2.2. Obtenha mais informações sobre o protocolo de autenticação no manual do 3DS 2.2.

Resposta da transação de carnê

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

PropriedadeDescriçãoTipoTamanho
TidId da transação na adquirente.string20
PaymentIdNúmero de identificação do pagamento. O PaymentId será usado em futuras operações como consulta e cancelamento.GUID36
StatusStatus da Transação. Veja a tabela completa de Status transacionalbyte***
ReturnCodeCódigo de retorno da adquirência.string32

Body Params
string
required

Número de identificação do pedido. 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. Tamanho: 50.

Customer
object
Payment
object
Headers
string
required
Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Identificador da loja na Cielo. Tamanho: 36. Formato: GUID.
Esta documentação traz um MerchantId padrão para permitir os testes em sandbox, mas você também pode informar o MerchantId habilitado durante o processo de implantação.

string
required
Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Chave pública para autenticação dupla na Cielo. Tamanho: 40. Formato: GUID.
Esta documentação traz um MerchantKey padrão para permitir os testes em sandbox, mas você também pode informar o MerchantKey habilitado durante o processo de implantação.

string

Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT. Tamanho: 36.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json