Primeiros passos
Nesta página
Tenha o certificado e a credencial em mãosPeça o tokenCrie a primeira cobrançaO que vem depoisFaç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:
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.
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" }'{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "bearer",
"expires_in": 3600
}Referência: Gerar um token de acesso
Guarde access_token em PAYZU_TOKEN, que o próximo passo usa:
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
| Campo | O que enviar |
|---|---|
amount | Valor em centavos. |
externalId | O seu identificador. |
paymentType | creditcard. |
customer | Nome do comprador. |
cart | Pelo menos um item. |
creditCardPayment | Número de parcelas e dados do cartão. |
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"
}
}
}'{
"id": "e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90",
"externalId": "pedido-1234",
"amount": 10000,
"paymentType": "creditcard",
"creditCardPayment": {
"status": 2,
"returnCode": "6",
"returnMessage": "Operação realizada com sucesso"
}
}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!.