PayZu CellCobranças

Gerar o pagamento de uma cobrança

POST/v1/charges/{id}/reissue

Confira o passo a passo → https://docs.payzu.com.br/docs/cell/pay-with-balance


Path Params

idstringobrigatório
ID da cobrança.

Body Params

channelstring enumPadrão: PIX
PIX gera o Pix da cobrança ou retorna o Pix ainda aberto dela. BALANCE paga a cobrança com o saldo da carteira da empresa no ambiente da chave; com o débito ainda em confirmação, payment vem nulo e a cobrança é paga quando ele confirmar. A rota aceita o pedido sem corpo.

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

200Pagamento gerado
paymentobject | nullPix aberto da cobrança, ou o pagamento com saldo quando channel é BALANCE. Nulo quando o provedor não confirmou a emissão do Pix ou com o débito do saldo ainda em confirmação, e então a cobrança é paga sozinha quando ele confirmar.
Campos do objeto 11
idstringID do pagamento.
orderIdstringPedido de pagamento a que o pagamento pertence; é a referência dele no provedor.
chargeIdsarray of stringsFaturas cobertas pelo pedido do pagamento.
methodstringMeio usado; WALLET é saldo ou crédito na carteira do provedor; BALANCE é o saldo da carteira da empresa.
PIXCARDBOLETOWALLETBALANCE
statusstringSituação do pagamento.
PENDINGPAIDFAILEDEXPIREDCANCELLEDREFUNDED
amountnumberValor 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.
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.
404Cobrança não encontrada
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.

Linguagem

Credenciais Bearer

Token de API

curl --request POST \     --url https://api.payzucell.com.br/v1/charges/{id}/reissue \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json