PayZu GatewayCheckoutPlano e adesão

Consultar um plano pela página

GET/v1/checkout/plans/{plan_id}

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/subscribe-to-a-plan


Path Params

plan_idstringobrigatório
ID ou slug do plano.

Query Params

typestring enumPadrão: id
Indica se plan_id é o id ou o slug.idslug

Headers

x-checkout-keystringobrigatório
Chave de checkout.
acceptstring
Formato da resposta.

Responses

200Sucesso
idstringID do plano.
namestringNome do plano.
descriptionstringDescrição do plano.
amountintegerValor de cada ciclo, em centavos.
recurrencestringPeriodicidade da cobrança.
monthlybimonthlyquarterlysemiannualannual
payment_settingsobjectComo as assinaturas do plano podem ser pagas.
Campos do objeto 1
accepted_methodsarray of stringsMeios de pagamento aceitos.
credit_cardpix
checkoutobjectPágina de adesão do plano.
Campos do objeto 3
slugstring | nullSlug do plano na url da página.
logo_urlstring | nullLogotipo exibido na página.
redirect_urlstring | nullPara onde o cliente vai depois de pagar a adesão.
merchantobjectQuem recebe o pagamento.
Campos do objeto 1
display_namestring | nullNome de exibição da conta, definido no painel do PayZu Gateway; nulo enquanto não há nome.
discountobject | nullDesconto dos primeiros ciclos de cada assinatura, contando a adesão; nulo sem desconto.
Campos do objeto 4
typestringTipo do desconto.
fixed_amountpercentage
valueintegerDesconto: centavos ou porcentagem, conforme o tipo.
cyclesintegerCiclos com desconto, contando a adesão.
public_descriptionstring | nullTexto do desconto para o cliente.
400Requisição inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
401Chave ausente ou inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.
404Não encontrado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
429Limite por IP
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.
500Erro interno
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.

Linguagem

Credenciais API Key

Chave de checkout

curl --request GET \     --url https://api.sandbox.payzu.dev/v1/checkout/plans/{plan_id} \     --header 'x-checkout-key: SUA_CHAVE_DE_CHECKOUT' \     --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