Endpoints da API

O caminho completo de uma integração de cartão, do token à cobrança, passando pelos avisos de status e chegando ao estorno.

Ver como Markdown

Primeiros passos Autenticação Cartões de teste Webhooks

Fluxo típico de integração

Você obtém um token, cria a cobrança, recebe o webhook com o resultado, consulta o estado quando precisar e estorna se for o caso.

Token

Autenticação da API: troque client_id e client_secret por um token JWT.

POSTObter token de API/token

Cobranças

Criação, consulta e estorno de cobranças com cartão de crédito.

POSTCriar Cobrança/charges GETListar Cobranças/charges GETConsultar Cobrança/charges/{chargeId}PUTEstornar Cobrança/charges/{chargeId}/reverse

Recorrências

Gestão de assinaturas criadas com o nó recurrence no POST /charges.

GETConsultar Recorrência/charges/recurrences/{recurrentPaymentId}PUTAlterar valor da Recorrência/charges/recurrences/{recurrentPaymentId}/amount PUTDesativar Recorrência/charges/recurrences/{recurrentPaymentId}/deactivate PUTReativar Recorrência/charges/recurrences/{recurrentPaymentId}/reactivate

Câmbio

Cotações de referência e conversão para cobrança internacional.

GETCotação de moeda/currencies/{code}/rate GETConverter valor/currencies/{code}/convert GETListar cotações/currencies/rates

Convenções

Item	Valor
Base URL (produção)	`https://api.payzu.io/v1`
Base URL (sandbox)	`https://api.sandbox.payzu.io/v1`
Autenticação	mTLS (certificado de cliente) + `Authorization: Bearer SEU_TOKEN`, obtido no `POST /token`. Veja Autenticação
Content-Type	`application/json`
Valores	Em centavos (`10000` = R$ 100,00)

Token

Como trocar as credenciais da sua conta pelo token de acesso que autoriza todas as chamadas de cobrança e recorrência.