PayZu PaymentsRecorrência no cartãoCriação e consulta

Consultar uma recorrência

GET/charges/recurrences/{recurrentPaymentId}

Confira o passo a passo → https://docs.payzu.com.br/docs/payments/get-a-recurrence


Path Params

recurrentPaymentIdstringobrigatório
ID da recorrência.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.

Responses

200Recorrência encontrada
recurrentPaymentIdstringIdentificador da recorrência.
intervalstringIntervalo entre as cobranças.
MONTHLYANNUALDAILY
statusstringStatus da recorrência.
ACTIVEINACTIVEENDED
amountintegerValor de cada ciclo em centavos.
nextRecurrencystring | nullData da próxima cobrança automática.
endDatestring | nullData final informada na criação.
401Token ou certificado inválido
statusCodeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
403Acesso negado
statusCodeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
404Recorrência não encontrada
statusCodeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, PZ mais três dígitos; ausente nos erros de autenticação, de cotação e do servidor HTTP.
500Erro interno
statusCodeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, PZ mais três dígitos; ausente nos erros de autenticação, de cotação e do servidor HTTP.
requestIdstringID da chamada, para o suporte; só em 5xx.

Linguagem

Credenciais Bearer · mTLS

Token de API

curl --request GET \     --url https://api.sandbox.payzu.dev/v1/charges/recurrences/{recurrentPaymentId} \     --cert cert.pem \     --key key.pem \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json'
Resposta

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

application/json