Gerar cobrança PIX

POST/api/v1/gateway/request-qrcode

Gera um PIX copia e cola (QR Code dinâmico) para o seu cliente pagar. A cobrança nasce WAITING_FOR_APPROVAL e passa a PAID_OUT quando é paga — nesse momento o valor entra no seu saldo (menos a tarifa) e a WeetPay faz um POST no callbackUrl. O QR expira no prazo definido pela plataforma (padrão 1 hora).

requestNumber é o identificador do pedido no seu sistema e não pode se repetir na mesma conta (repetir devolve 400 requestNumber já utilizado). Parâmetros UTM na query string (utm_source, utm_campaign, utm_medium, utm_content, utm_term) ficam salvos na cobrança.

Autenticação

vspi<token>

Client ID (ex.: weetpay-100123). Também aceito como x-client-id.

Em: header

vsps<token>

Client secret. Também aceito como x-client-secret. Nunca exponha no front-end.

Em: header

Parâmetros de consulta

utm_source?string

Rastreamento de campanha (opcional), salvo na cobrança

Tamanholength <= 300
utm_campaign?string

Rastreamento de campanha (opcional), salvo na cobrança

Tamanholength <= 300
utm_medium?string

Rastreamento de campanha (opcional), salvo na cobrança

Tamanholength <= 300
utm_content?string

Rastreamento de campanha (opcional), salvo na cobrança

Tamanholength <= 300
utm_term?string

Rastreamento de campanha (opcional), salvo na cobrança

Tamanholength <= 300

Corpo da requisição

application/json

Definições TypeScript

Use o tipo request body no TypeScript.

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/gateway/request-qrcode" \  -H "Content-Type: application/json" \  -d '{    "requestNumber": "pedido-12345",    "amount": 49.9,    "callbackUrl": "https://sualoja.com.br/webhooks/weetpay",    "client": {      "name": "Maria da Silva",      "document": "12345678909",      "email": "[email protected]",      "phoneNumber": "11999998888"    },    "products": [      {        "description": "Camiseta básica",        "quantity": 1,        "value": 49.9      }    ]  }'
{  "idTransaction": "cmh1x2y3z0001ab12cd34ef56",  "paymentCode": "00020101021226850014br.gov.bcb.pix2563qrcode.exemplo.com.br/pix/v2/cobv/9d36b84f...5204000053039865406149.905802BR5913WEETPAY6009SAO PAULO62070503***6304ABCD",  "paymentCodeBase64": "iVBORw0KGgoAAAANSUhEUgAA...",  "response": "OK",  "status": "WAITING_FOR_APPROVAL"}