PayZu GatewayCheckoutLink de pagamento

Consultar um link de pagamento pela página

GET/v1/checkout/payment-links/{payment_link_id}

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/pay-a-link


Path Params

payment_link_idstringobrigatório
ID do link de pagamento.

Headers

acceptstring
Formato da resposta.

Responses

200Sucesso
idstringID do link de pagamento.
statusstringStatus do link.
activepaidexpiredcanceled
namestringNome do link.
descriptionstringDescrição do link.
amountintegerValor do link, em centavos.
expires_atstring | nullData e hora em que o link vence; nula se não vence.
availablebooleanIndica se o link aceita compra agora: ativo, dentro do prazo e com vaga.
payment_settingsobjectComo a fatura pode ser paga.
Campos do objeto 2
accepted_methodsarray of stringsMeios aceitos.
credit_cardpix
credit_cardobjectRegras do cartão; nulo sem cartão.
Campos do objeto 1
max_installmentsintegerMáximo de parcelas no cartão.
checkoutobjectAparência da página do link.
Campos do objeto 2
logo_urlstring | nullLogotipo exibido na página.
redirect_urlstring | nullPara onde o cliente vai depois de pagar.
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 do link; nulo sem desconto.
Campos do objeto 4
payment_methodstringMeio de pagamento com desconto.
credit_cardpix
typestringTipo do desconto.
fixed_amountpercentage
valueintegerDesconto: centavos ou porcentagem, conforme o tipo.
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.
403Acesso negado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
404Não encontrado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
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

curl --request GET \     --url https://api.sandbox.payzu.dev/v1/checkout/payment-links/{payment_link_id} \     --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