Criar pagamento com voucher

Cria uma transação com voucher

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.braspag.com.br/v2/sales/
Produçãohttps://api.braspag.com.br/v2/sales/
ℹ️

Saiba mais sobre essa funcionalidade na documentaçã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.

Atualmente, os providers suportados são Alelo e Ticket. Para testes em ambiente Sandbox, utilize o provider Simulado.

ProviderBandeiraCaracterísticas
AleloElo
  • Permite captura automática quando PaymentCapture = true ou não informado;
  • Não permite captura posterior;
  • Permite cancelamento total;
TicketTicket
  • Permite captura automática quando PaymentCapture = true ou captura posterior (pré-autorização) quando PaymentCapture = false.
  • Permite cancelamento/estorno total e parcial.
⚠️

Atenção

  • Em caso de pré-autorização para o voucher Ticket, a API retornará o PaymentStatus = 1 e não retornará os parâmetros Payment.CapturedAmount e Payment.PaidDate;
  • Use a integração desta página para o voucher Alelo multibenefícios.

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.

Body Params
string
required

Número de identificação do pedido.

Customer
object

Nó Customer

Payment
object

Nó Payment

Headers
string
required
Defaults to e3c24810-18bb-4bd7-88a0-a36d6b4a0731

Identificador da loja no Gateway de Pagamento. 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 GQUAIWVDKUINZRHDQPLHUVHAIIFEIXFEXWPOYGHY

Chave pública para autenticação dupla no Gateway de Pagamento. 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 definido pela loja, utilizado quando o lojista 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