Skip to main content
Use method: "voucher" quando o cliente vai pagar fora do fluxo de cartão ou Pix por meio de uma instrução local, referência bancária, redirecionamento ou documento pagável. voucher é o método público da Pagou. O meio de pagamento local disponível depende da configuração da conta, moeda e país. Não envie nomes de opções locais como boleto, spei, mercadopago, webpay ou codi para a API de transações.

Significado por país

A disponibilidade depende dos países, moedas e métodos de pagamento habilitados na conta. Se o país e a moeda selecionados não estiverem habilitados, a criação do pagamento será recusada.

Criar a transação

Crie um pagamento por voucher com POST /v2/transactions.
amount e price dos produtos usam a menor unidade da moeda escolhida. Para BRL e MXN, envie centavos. Em pagamentos LATAM por voucher, envie buyer.document e buyer.address.country sempre que possível. Algumas configurações SPEI conseguem criar o pagamento sem documento, mas a maioria dos meios por voucher/transferência valida o tipo de documento para o país selecionado. Não inclua token. Tokens de cartão só são válidos para method: "credit_card".

Tipos de documento aceitos

Use estes valores em buyer.document.type quando o comprador pagar com method: "voucher". O país é lido de buyer.address.country quando esse campo é enviado; caso contrário, a Pagou pode inferir um país principal a partir de currency. Esta tabela lista os tipos de documento aceitos pela validação da API. A disponibilidade de pagamento em cada país ainda depende da configuração de pagamento habilitada para a empresa.

Exibir as instruções

A resposta da transação expõe o objeto normalizado voucher.
Em MXN (SPEI), a API nunca devolve URL hospedada de pagamento: voucher.url é sempre null e a CLABE em voucher.barcode é a instrução de pagamento. Nas demais moedas a URL continua vindo quando o meio de pagamento local fornece uma. Os campos são nullable porque os meios de pagamento locais usam formatos diferentes de instrução. Monte o checkout para exibir todos os campos presentes, e não para depender de um formato fixo de Boleto.

Atualizações assíncronas

Alguns meios de pagamento locais retornam todos os dados de voucher na resposta de criação. Outros retornam primeiro status: "pending" e entregam os campos de voucher por webhook logo depois. Use esta sequência:
  1. Crie a transação com method: "voucher".
  2. Se voucher.url, voucher.digitable_line ou voucher.barcode vier preenchido, exiba imediatamente.
  3. Assine webhooks de pagamento e atualize a página do cliente quando a mesma transação receber as instruções de voucher.
  4. Reconcilie com GET /v2/transactions/{id} se o worker perder um webhook ou se o cliente atualizar o checkout.
Meios de voucher com redirecionamento, como Webpay ou CODI, continuam sendo pagamentos voucher. Trate a URL como a ação de pagamento do voucher, não como um desafio 3DS de cartão.

Endpoints relevantes

Leia a seguir