Pagamento via boleto

POST

/v1/payments/boleto

Cria um boleto bancário vinculado a um pedido existente. Retorna o link do PDF e a linha digitável.

O boleto é uma opção de pagamento offline: o cliente paga em um banco, lotérica ou pelo internet banking, fora do seu checkout.

Exiba o boleto na página de sucesso

Mostre a opção de baixar o PDF (pdf_url) e de copiar a linha digitável (digitable_line) na página de sucesso, para que o cliente possa efetuar o pagamento pelo canal de sua preferência.

Não abra o PDF em iframe

O download do boleto (pdf_url) deve redirecionar o cliente para outra página, e não ser aberto embutido em um iframe na sua página de checkout/sucesso.

Autorizações

bearerAuth

Token Bearer do merchant obtido via POST /oauth2/token usando as credenciais do merchant (não do app). Veja Autenticação.

Tipo

HTTP (bearer)

Corpo da Requisição

application/json

{

  

"order_id": 113,

  

"payment_data": {

  

  

"boleto": {

  

  

  

"document_number": "19100000000"

  

  

}

  

}

}

Respostas

Boleto gerado com sucesso.

Content-Type

application/json

POST

/v1/payments/boleto

Exemplos

Sandboxhttps://api.sandboxappmax.com.br

Authorization (Bearer)

Cole uma vez e use em todos os playgrounds — o token fica salvo somente nesta aba do navegador e é apagado quando ela for fechada.

Corpo

{
  "order_id": 113,
  "payment_data": {
    "boleto": {
      "document_number": "19100000000"
    }
  }
}

Duplo clique no JSON para editar