PayZu CellCarteira
Recarregar a carteira por Pix
POST/v1/wallet/top-ups
Confira o passo a passo → https://docs.payzu.com.br/docs/cell/wallet-top-up
Requisições recentes
Depois de um 502 com PZC301, a resposta não traz o id da recarga, e não há consulta da recarga. Guarde o requestId do erro antes de tentar de novo.
Body Params
amountnumberobrigatório
Valor da recarga em reais, entre o mínimo e o máximo de topUpLimits da carteira.
emailstringobrigatório
E-mail de quem paga, registrado com o Pix no provedor de pagamento.
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
Idempotency-Keystringobrigatório
Obrigatório nas rotas que geram cobrança ou recarga. Seu identificador do pedido, válido por 24 h em cada ambiente. Depois de um sucesso, repetir a mesma rota com o mesmo corpo retorna a mesma resposta, com Idempotent-Replayed: true; outro corpo ou outra rota responde 409 PZC004, e o pedido ainda em andamento responde 409 PZC201.
acceptstring
Formato da resposta.
Responses
201Recarga criada
idstringIdentificador da recarga.
amountnumberValor em reais, número com até duas casas, como 29.9.
statusstringPENDING aguardando o pagamento; PAID paga, com o crédito lançado no saldo logo depois; REFUNDED estornada pelo provedor de pagamento, com o valor retirado do saldo.
PENDINGPAIDREFUNDEDpaidAtstring | nullData e hora do pagamento; nulo enquanto a recarga não foi paga.
environmentstringAmbiente do dado: produção ou testes.
LIVETESTpaymentobjectPix da recarga.
Campos do objeto 11
idstringID do pagamento.
orderIdstringPedido de pagamento a que o pagamento pertence; é a referência dele no provedor.
chargeIdsarray of stringsCobranças cobertas pelo pagamento; vazio na recarga.
methodstringMeio usado; WALLET é saldo ou crédito na carteira do provedor; BALANCE é o saldo da carteira da empresa.
PIXCARDBOLETOWALLETBALANCEstatusstringSituação do pagamento.
PENDINGPAIDFAILEDEXPIREDCANCELLEDREFUNDEDamountnumberValor em reais, número com até duas casas, como 29.9.
pixCopyPastestring | nullPix copia e cola.
pixQrCodestring | nullQR do Pix em PNG base64.
expiresAtstring | nullData e hora em que o pagamento expira.
paidAtstring | nullInstante ISO 8601 com fuso.
createdAtstringInstante ISO 8601 com fuso.
createdAtstringData e hora do registro.
400Requisição inválida
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
401Chave ausente ou inválida
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
403Acesso negado
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
404Não encontrado
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
409Conflito
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
422Operação recusada
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
429Limite de requisições atingido
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
502Pagamento sem resposta
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
requestIdstringID da requisição, só nos erros 5xx.
503Serviço indisponível
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
requestIdstringID da requisição, só nos erros 5xx.
Esta página ajudou?