PayZu Conta Hub

Primeiros passos


Nesta páginaObtenha a credencialPeça o tokenCrie a primeira cobrançaO que vem depois

Crie a sua primeira cobrança Pix no sandbox com um token da sua credencial.

Obtenha a credencial

A chamada do token usa o client_id e o client_secret de uma credencial da sua conta no PayZu Conta Hub. Guarde o client_secret fora do código, numa variável de ambiente ou num cofre de segredos. Quando a credencial tem lista de IPs, chame de um IP dela, inclusive na troca do token.

Sandbox e produção têm os mesmos caminhos.

Teste em https://api.sandbox.payzu.dev/api/v1. Em produção, o servidor é https://api.hub.payzu.com.br/api/v1.

Peça o token

Envie client_id:client_secret em Authorization: Basic, em base64, e grant_type=client_credentials no corpo. O token vem em access_token e vale 15 minutos.

bash
curl --request POST \
  --url 'https://api.sandbox.payzu.dev/api/v1/oauth/token' \
  --user 'SEU_CLIENT_ID:SEU_CLIENT_SECRET' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'grant_type=client_credentials'

Referência: Gerar um token de acesso

Nas rotas de /transactions, mande o token no cabeçalho Authorization: Bearer SEU_TOKEN. Reutilize o mesmo token até perto de vencer e só então peça outro: a rota limita as trocas por client_id e por IP.

Crie a primeira cobrança

CampoRegra
amountValor em centavos.
methodPIX.
customerNome e CPF ou CNPJ. E-mail e telefone são opcionais.
externalRefO seu identificador. Repetir a mesma chamada retorna a cobrança já criada.
bash
curl --request POST \
  --url 'https://api.sandbox.payzu.dev/api/v1/transactions/payment' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 1500,
    "method": "PIX",
    "description": "Pedido 4821",
    "externalRef": "pedido-4821",
    "customer": {
      "name": "Maria Souza",
      "document": "52998224725",
      "email": "maria.souza@exemplo.com",
      "phone": "+5511999998888"
    }
  }'

Referência: Criar uma cobrança Pix com copia e cola

  • pix.qrCodeText: o copia e cola, de onde você desenha o QR Code.
  • status: a cobrança nasce PENDING.
  • serviceFee: a tarifa que será descontada quando a cobrança for paga.
  • netAmount: o que vai entrar no saldo.
  • id: guarde para consultar a cobrança e baixar o comprovante.

Para testar sem escrever código, abra a rota na referência, cole o token e use o Try It!: a resposta aparece ao lado da requisição.