PayZu GatewayCheckoutLink de pagamento
Comprar pelo link
POST/v1/checkout/payment-links/{payment_link_id}/invoices
Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/pay-a-link
Requisições recentes
Headers
acceptstring
Formato da resposta.
Responses
201Fatura criada
idstringID da fatura.
statusstringStatus da fatura.
pendingpaidcanceledexpiredrefundedchargedbackurlstringPágina da fatura, para o cliente pagar; paga, ela é o comprovante.
descriptionstringDescrição da fatura.
created_atstringData e hora da criação.
updated_atstringData e hora da última alteração.
amountsobjectValores da fatura, em centavos.
Campos do objeto 5
subtotalintegerValor antes do desconto.
discountintegerDesconto aplicado.
totalintegerValor a pagar: o subtotal menos o desconto.
paidintegerTudo o que entrou, inclusive o pagamento em duplicidade.
refundedintegerTudo o que foi devolvido.
billingobjectPrazos e datas da fatura.
Campos do objeto 7
cycle_numberinteger | nullCiclo da assinatura, com a adesão no ciclo 0; nulo fora de assinatura.
due_atstringVencimento.
expires_atstringLimite para pagar.
paid_atstring | nullData e hora do pagamento.
canceled_atstring | nullData e hora do cancelamento.
refunded_atstring | nullData e hora do estorno.
chargedback_atstring | nullData e hora da contestação.
itemsarray of objectsItens da fatura.
Campos de cada item 4
namestringNome do item.
skustring | nullSeu código do item.
quantityintegerQuantidade.
unit_priceintegerPreço unitário, em centavos.
payment_settingsobjectComo a fatura pode ser paga.
Campos do objeto 2
accepted_methodsarray of stringsMeios aceitos.
credit_cardpixcredit_cardobject | nullRegras do cartão; nulo sem cartão.
Campos do objeto 1
max_installmentsintegerMáximo de parcelas no cartão.
checkoutobjectPara onde a página da fatura leva o cliente.
Campos do objeto 2
redirect_urlstring | nullPara onde o cliente vai depois de pagar.
cancel_urlstring | nullPara onde vai quem desiste.
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.
customerobject | nullCliente, com e-mail, documento e celular mascarados; nulo na fatura sem cliente.
Campos do objeto 6
namestringNome do cliente.
emailstringE-mail do cliente, mascarado.
documentstringCPF ou CNPJ do cliente, mascarado.
document_typestringTipo do documento.
cpfcnpjphonestring | nullCelular do cliente, mascarado.
address_on_filebooleanIndica se o cliente já tem endereço no cadastro; sem ele, o cartão leva address.
subscriptionobject | nullAssinatura da fatura; nula fora de assinatura.
Campos do objeto 2
codestringCódigo curto da assinatura.
namestringNome da assinatura.
payment_linkobject | nullLink de pagamento da compra; nulo fora de link.
Campos do objeto 3
idstringID do link.
namestringNome do link.
discountobject | nullDesconto do link; nulo sem desconto.
Campos do objeto 4
payment_methodstringMeio de pagamento com desconto.
credit_cardpixtypestringTipo do desconto.
fixed_amountpercentagevalueintegerDesconto: centavos ou porcentagem, conforme o tipo.
public_descriptionstring | nullTexto do desconto para o cliente.
paymentsarray of objectsTentativas de pagamento, da mais nova para a mais antiga.
Campos de cada item 10
idstringID da tentativa.
statusstringStatus da tentativa.
pendingprocessingpaidfailedexpiredrefund_requestedrefundedchargedbackmethodstringMeio de pagamento.
credit_cardpixamountintegerValor da tentativa, em centavos.
created_atstringData e hora da tentativa.
paid_atstring | nullData e hora do pagamento.
failed_atstring | nullData e hora da recusa.
failureobject | nullMotivo da recusa; nulo fora de failed.
Campos do objeto 3
stagestringEtapa que recusou.
issuerantifraudcard_checksplitprocessingcodestringCódigo da recusa.
messagestringMotivo da recusa, para mostrar ao cliente.
credit_cardobjectDados do cartão; nulo no Pix.
Campos do objeto 3
installmentsinteger | nullParcelas.
authorization_codestring | nullCódigo de autorização; nulo sem aprovação.
cardobject | nullCartão.
Campos do objeto 2
brandstring | nullBandeira.
last_digitsstringÚltimos 4 dígitos.
pixobjectDados do Pix; nulo no cartão.
Campos do objeto 4
qr_code_textstring | nullPix copia e cola.
qr_code_urlstring | nullSempre nulo: monte o QR Code com qr_code_text.
expires_atstring | nullQuando o QR Code vence.
end_to_end_idstring | nullID do Pix no Banco Central; nulo até o pagamento.
refundsarray of objectsEstornos, do mais novo para o mais antigo.
Campos de cada item 4
statusstringStatus do estorno.
requestedconfirmedfailedamountintegerValor estornado, em centavos.
requested_atstring | nullData e hora do pedido.
confirmed_atstring | nullData e hora da confirmação.
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.
422Operação recusada
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.
Esta página ajudou?