Pagamento via Pix

POST

/v1/payments/pix

Gera as instruções de pagamento via Pix para um pedido existente: QR Code (imagem base64) e código EMV (copia-e-cola).

Exiba um cronômetro de expiração

Na página de sucesso, mostre o QR Code, o copia-e-cola e um cronômetro com o tempo restante até pix_expiration_date. Calcule a contagem regressiva dinamicamente a partir desse campo — não fixe um tempo de expiração no seu código, pois esse valor pode variar.

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": {

  

  

"pix": {

  

  

  

"document_number": "19100000000"

  

  

}

  

}

}

Respostas

Instruções Pix retornadas. Os campos pix_qrcode (PNG em base64, sem prefixo data:), pix_emv (BR Code copia-e-cola) e pix_expiration_date (data/hora de expiração do Pix, formato Y-m-d H:i:s) vivem em data.payment. Exiba o QR Code e o copia-e-cola ao cliente.

Content-Type

application/json

POST

/v1/payments/pix

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": {
    "pix": {
      "document_number": "19100000000"
    }
  }
}

Duplo clique no JSON para editar