PayZu PaymentsVisão geral

Primeiros passos


Nesta páginaTenha o certificado e a credencial em mãosPeça o tokenCrie a primeira cobrançaO que vem depois

Faça a primeira cobrança no cartão no sandbox e, para ir ao ar, troque só o servidor, a credencial e o certificado.

Tenha o certificado e a credencial em mãos

A PayZu entrega na habilitação da conta o certificado de cliente com a chave privada, o client_id e o client_secret. Os exemplos leem esses valores de quatro variáveis de ambiente:

bash
export PAYZU_CLIENT_ID='seu-client-id'
export PAYZU_CLIENT_SECRET='seu-client-secret'
export PAYZU_CLIENT_CERT='/caminho/para/certificado.pem'
export PAYZU_CLIENT_KEY='/caminho/para/chave-privada.pem'

O certificado vai em toda chamada à API, inclusive na troca do token.

Se a PayZu desligou essa exigência na sua credencial, tire o --cert e o --key dos exemplos.

Os exemplos usam o sandbox.

O servidor do sandbox é https://api.sandbox.payzu.dev/v1. Em produção o servidor é https://api.payzu.io/v1, com os mesmos caminhos.

Peça o token

Envie client_id:client_secret em Authorization: Basic, em base64, e grant_type igual a client_credentials no corpo.

bash
curl --request POST \
  --url 'https://api.sandbox.payzu.dev/v1/token' \
  --user "$PAYZU_CLIENT_ID:$PAYZU_CLIENT_SECRET" \
  --cert "$PAYZU_CLIENT_CERT" --key "$PAYZU_CLIENT_KEY" \
  --header 'Content-Type: application/json' \
  --data '{ "grant_type": "client_credentials" }'

Referência: Gerar um token de acesso

Guarde access_token em PAYZU_TOKEN, que o próximo passo usa:

bash
export PAYZU_TOKEN='valor-de-access_token'

Nas outras rotas, mande o token em Authorization: Bearer e mantenha o mesmo certificado na conexão. A validade vem em expires_in, em segundos: reutilize o token até perto de vencer e só então peça outro.

Crie a primeira cobrança

CampoO que enviar
amountValor em centavos.
externalIdO seu identificador.
paymentTypecreditcard.
customerNome do comprador.
cartPelo menos um item.
creditCardPaymentNúmero de parcelas e dados do cartão.
bash
curl --request POST \
  --url 'https://api.sandbox.payzu.dev/v1/charges' \
  --header "Authorization: Bearer $PAYZU_TOKEN" \
  --cert "$PAYZU_CLIENT_CERT" --key "$PAYZU_CLIENT_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 10000,
    "paymentType": "creditcard",
    "externalId": "pedido-1234",
    "postbackUrl": "https://seusite.com.br/webhooks/payzu",
    "customer": {
      "name": "Maria Souza",
      "identity": "11144477735",
      "identityType": "CPF",
      "email": "maria.souza@example.com",
      "phone": "5511999998888"
    },
    "cart": [
      { "name": "Plano Pro", "quantity": 1, "sku": "PRO", "unitPrice": 10000 }
    ],
    "creditCardPayment": {
      "installments": 1,
      "authenticate": false,
      "card": {
        "number": "4111111111111111",
        "holder": "MARIA SOUZA",
        "expiration": "12/2030",
        "cvv": "123"
      }
    }
  }'

Referência: Criar uma cobrança

O exemplo mostra um trecho da resposta; a cobrança completa está em Criar uma cobrança. creditCardPayment.status igual a 2 é a cobrança confirmada e capturada. Guarde o id junto do pedido: é com ele que você consulta e estorna.

Para testar sem escrever código, abra a rota na referência, cole o token e use o Try It!.