Criar pagamento com voucher

Cria transação com o meio de pagamento voucher Alelo

ℹ️

Saiba mais sobre essa funcionalidade na documentação.

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

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.

⚠️

Atenção

  • A Cielo aceita somente o Voucher Alelo;
  • Use a integração desta página para o voucher Alelo multibenefícios.

Para processar um pagamento com cartão Alelo via API E-commerce Cielo, utilize o mesmo formato de requisição usado para uma transação com cartão de débito.

Além disso, é necessário configurar os seguintes parâmetros:

  • Payment.Authenticate precisa estar como false ou não ser enviado;
  • DebitCard.Brand precisa ser enviada como "Elo".

Orientações para cancelamento em voucher Alelo

Para o voucher Alelo:

  • Não é possível realizar cancelamento parcial;
  • O cancelamento total pode ser feito apenas no dia da transação (D0);
  • Para cancelar após o dia da transação (D+1 em diante), é necessário contatar a Alelo.

Para cancelar a transação de voucher, siga a requisição Cancelar transação de débito via PaymentId.


Body Params
string
required

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.
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 do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. Tamanho: 36.

Responses

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